Add rpk reference pages for rpk ai and rpk cloud commands#17
Merged
Conversation
Adds a slim rpk reference section under modules/reference/pages/rpk/ so content pages have command-level docs to xref instead of bare backticks. Covers the rpk ai plugin (new in ADP, content lives only in adp-docs) plus the rpk cloud subcommands actually referenced in adp-docs prose (login, logout, cluster, cluster select). rpk profile and rpk -X stubs are included because the rpk-cloud-login partial transitively xrefs them. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-agentic-data-plane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
xrefs primary references in ai-gateway and mcp pages to the new rpk reference section. Skips subsequent mentions, TODO comments, and rpk ai subcommands without reference pages (mcp create, oauth create, etc.). Also tightens code-style formatting in rpk-ai-install. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The autogenerated/ entry was a side effect of running the rpk doc generator to bootstrap rpk-ai partials. Those partials have been inlined into the rpk-ai pages and removed, so the generator isn't expected to run again for adp-docs. Reverting the .gitignore change keeps this PR focused on content. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Adds a single-sourced Install or update rpk page under get-started/, including from `ROOT:get-started:rpk-install.adoc` with `:env-cloud:` so the Cloud-style "always use the latest" branch renders. Replaces two cross-repo `xref:redpanda-cloud:manage:rpk/rpk-install.adoc[]` links in ingest-custom-traces and transaction-dispute-resolution. - Wraps four `:learning-objective-N:` attributes that contained backtick formatting in `pass:q[...]` so the monospace styling survives attribute expansion. Without the wrapper, AsciiDoc strips inline markup from attribute values. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Mirrors docs and cloud-docs positioning where Glossary sits at the very end as a top-level entry. Drops the Pipeline examples nav link for now; the page file is kept on disk in case it's restored later. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
rpkreference section atmodules/reference/pages/rpk/so adp-docs prose has command-level pages to xref instead of bare backticks.rpk aiplugin (new in ADP; content lives only in adp-docs, not in cloud-docs or the docs repo) — install, uninstall, upgrade.rpk cloudsubcommands actually referenced in adp-docs prose (login, logout, cluster, cluster select) via include fromROOT:reference:partial$rpk-cloud/...so they stay auto-synced with rpk releases.rpk profileandrpk -Xbecause the rpk-cloud-login partial xrefs them transitively. Without them the build emits broken-xref errors.modules/ROOT/nav.adocwith the new rpk subtree.rpk ai/rpk cloudcommands inai-gateway/overview.adoc,ai-gateway/connect-agent.adoc,mcp/create-server.adoc,mcp/oauth-providers.adoc, andmcp/test-tools.adoc.Preview pages
Test plan
npm run buildcompletes withouttarget of xref not foundortarget of include not founderrors for any page undermodules/reference/pages/rpk/.npm run serveand click through the new nav entries:/redpanda-adp/reference/rpk/renders the landing page with four sibling entries (rpk ai, rpk cloud, rpk profile, rpk -X) and no stray description text./redpanda-adp/reference/rpk/rpk-ai/rpk-ai-install/shows install command usage, flags, and--ai-version./redpanda-adp/reference/rpk/rpk-cloud/rpk-cloud-login/renders identical content todocs.redpanda.com'srpk cloud loginpage (proves theROOTinclude resolves).rpk Commandsgroup under Reference./redpanda-adp/ai-gateway/connect-agent/, the inlinerpk ai,rpk ai install,rpk cloud login, andrpk profilementions link to the new reference pages.🤖 Generated with Claude Code