Add datumctl plugin & marketplace documentation#37
Closed
scotwells wants to merge 15 commits into
Closed
Conversation
Add four audience-scoped guides under a new Plugins group in the datumctl (CLI) tab: using plugins, adding catalogs, publishing catalogs, and building plugins. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add quickstart, contexts & scoping, output & scripting, discovering resources, interactive console, AI & MCP, and kubectl interop guides. Restructure the CLI section into groups, un-orphan the resources and console pages, and weave descriptive cross-links across every doc. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…interop Move Authentication into Getting started and Activity into Core concepts, and narrow the last group to just the kubectl interop guide. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the single (and inaccurate) activity page with a Querying activity hub plus Audit logs & events and Change history & feed guides, organized around real investigation use-cases, and give it its own nav section with descriptive cross-links across the CLI docs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… and CI/CD sections Promote authentication and resource management into full sections, split the AI assistant and MCP server into their own pages, and add a CI/CD section covering the setup-datumctl-action and headless automation. Retire the superseded single pages and repoint every cross-link. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the dense ten-bullet section map with a card grid and drop the redundant design-goals list so the landing page is quicker to scan. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a top-level API resources reference tab with per-service groups and per-resource pages (fields, status, and usage) for DNS and Networking, generated from the live resource schemas. Pilot to validate the design before covering every service. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Expand the Networking section of the API resources tab with the Gateway API constructs (GatewayClass, Gateway, HTTPRoute, BackendTLSPolicy) and the Envoy Gateway policy extensions (Backend, BackendTrafficPolicy, HTTPRouteFilter, SecurityPolicy), each with a sub-section overview. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add descriptive links to the authoritative sources for concepts the docs reference — OAuth/OIDC/PKCE, CEL, jq, MCP, provider consoles, GitHub Actions, the Gateway API and Envoy Gateway standards, and more. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add API resource sections for Resource Manager, IAM, Compute, IPAM, Quota, Billing, Services, Notification, and Telemetry, each with a service overview and per-resource field references generated from the live schemas. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a Concepts group to the API resources reference covering the shared model — conventions, object metadata, status and conditions, scopes, versioning and stability, resource references, field formats, and validation — so per-resource pages stay focused and link to one canonical explanation of each cross-cutting idea. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add guides for using Kubernetes tools (Helm, the Terraform Kubernetes provider, k9s) and for GitOps with Flux and Argo CD run from CI, both built on the datumctl exec-credential kubeconfig. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…s section Separate the resources Datum operates and you typically reference — the service catalog, referenced classes, address pools, and email templates — into a dedicated Platform resources section, so each service section leads with the resources you create and manage yourself. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The API reference work (api/ tab, 68 pages) is preserved on the docs/api-reference-wip branch to resume later. The auto-generated CLI Commands tab (cli/) is removed from the nav; command and flag help now points users at 'datumctl --help'.
scotwells
force-pushed
the
docs/datumctl-plugins
branch
from
8169b70 to
c9b0aeb
Compare
Contributor
Author
|
Superseded by #40, which opens as a clean branch off main (correct nav with the API reference split out to the docs/api-reference-wip branch). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for datumctl plugins and the plugin catalog (marketplace) functionality, as a new Plugins group under the datumctl (CLI) tab.
Four audience-scoped guides:
datumctl plugin index), the one-time trust decision, and the enterprise allow-list that scopes permitted publishers (down to GitHub owner/repo) and is enforced continuously.index.yamlschema with an annotated example, validation (datumctl plugin index validate), HTTPS hosting, publisher scoping, and versioning guidance.go.datum.net/datumctl/pluginSDK (manifest, context injection, token acquisition, Cobra forwarding, completion), and a worked example grounded inexamples/plugin-dns.Also updates
docs.jsonnavigation to add the Plugins group.This is a scaffold opened for review as a draft. Command names, flags, the index/manifest format, and the SDK API were verified against the datumctl source.
🤖 Generated with Claude Code