Skip to content

Convert rpk ai reference to single-source stubs of docs partials - #161

Open
JakeSCahill wants to merge 1 commit into
mainfrom
convert-rpk-ai-to-stubs
Open

Convert rpk ai reference to single-source stubs of docs partials#161
JakeSCahill wants to merge 1 commit into
mainfrom
convert-rpk-ai-to-stubs

Conversation

@JakeSCahill

Copy link
Copy Markdown
Contributor

Per the canonical-home discussion: the docs repo generates the rpk ai reference (marked asPartial in rpk-overrides.json, written to modules/reference/partials/rpk-ai/), so this component's 94 locally generated copies are replaced with 101 single-source stubs — the same pattern as the other shared rpk pages.

What you get immediately:

  • rpai 0.2.31 content with no regen: the llm-provider/mcp-server renames and the complete new policy group (apply/create/delete/diff/get/list/update) are already current in the docs partials.
  • 21 stubs carry :page-aliases: for the renamed old URLs (rpk-ai-llm-*rpk-ai-llm-provider-*, rpk-ai-mcp-*rpk-ai-mcp-server-*).
  • Nav rebuilt from the current command tree.

Dropped without successors: the three rpk ai connection pages — that command is exclude: true in the upstream overrides (deliberately undocumented). Add redirects if those URLs carry traffic.

⚠️ Merge after redpanda-data/docs#1840 (the 26.2 GA merge): the llm-provider/mcp-server/policy partials these stubs include only reach docs main with that PR. Until then this branch's includes don't resolve. Its preview will also stay red until #1840 lands, for the same duplicate-component-version reason as #159/#160.

Note: one stale pre-rename partial (rpk-ai-mcp-create.adoc) still exists in the docs repo and is intentionally not stubbed; we're deleting it upstream as follow-up cleanup.

The docs repo is the generation home for rpk ai (asPartial in
rpk-overrides.json, generated into reference partials). This replaces
the 94 locally generated pages with 101 stubs that include those
partials, picking up the rpai 0.2.31 llm-provider/mcp-server renames
and the new policy command group.

- 21 renamed pages carry page-aliases for their old URLs
- rpk ai connection pages dropped (command excluded upstream)
- nav rebuilt from the current command tree
@JakeSCahill
JakeSCahill requested a review from a team as a code owner July 28, 2026 17:03
@netlify

netlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-agentic-data-plane failed. Why did it fail? →

Name Link
🔨 Latest commit 0109346
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-agentic-data-plane/deploys/6a69abd9468e7f7873d8bafa

@micheleRP

Copy link
Copy Markdown
Contributor

Before this merges: the new rpk ai policy stubs would be the first published docs for the policy commands, and there's a pending product decision on whether and how those get documented (I've asked separately). Two options so the rest of this PR isn't blocked: hold the merge until that's answered, or split the policy stubs (the 8 rpk-ai-policy* pages plus their nav entries) into a follow-up PR. Everything else here looks ready to go once redpanda-data/docs#1840 lands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants