feat(DOC-1970): add missing rpk connect reference pages#1608
feat(DOC-1970): add missing rpk connect reference pages#1608
Conversation
Adds documentation for three rpk connect commands missing from the reference: - rpk connect agent (+ agent init, agent run subcommands) — EXPERIMENTAL - rpk connect dry-run - rpk connect plugin (+ plugin init subcommand) — EXPERIMENTAL Updates nav.adoc to include the new pages in alphabetical order. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis pull request adds documentation for new rpk connect subcommands, introducing six new AsciiDoc documentation pages for agent, agent-init, agent-run, dry-run, plugin, and plugin-init commands. The navigation structure in nav.adoc is updated to include these new command entries under a reorganized hierarchy. Previous mcp-server entries are removed from the navigation. Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc (1)
17-17: Use empty brackets in xref to auto-pull the target page title.The xref link includes hard-coded link text
[init]. Per repository conventions, use empty brackets[]to automatically pull the title from the referenced document.📝 Suggested change
-* xref:rpk/rpk-connect/rpk-connect-plugin-init.adoc[init]: Create the boilerplate for a custom component plugin. +* xref:rpk/rpk-connect/rpk-connect-plugin-init.adoc[]: Create the boilerplate for a custom component plugin.Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc` at line 17, Replace the hard-coded xref text `[init]` with empty brackets `[]` so the link auto-pulls the target page title; update the xref in the rpk-connect-plugin.adoc line referencing rpk-connect-plugin-init.adoc (xref:rpk/rpk-connect/rpk-connect-plugin-init.adoc[]).modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc (2)
17-18: Use empty brackets in xrefs to auto-pull target page titles.The xref links include hard-coded link text. Per repository conventions, use empty brackets
[]to automatically pull titles from the referenced documents.📝 Suggested change
-* xref:rpk/rpk-connect/rpk-connect-agent-init.adoc[init]: Initialize a Redpanda Connect agent. -* xref:rpk/rpk-connect/rpk-connect-agent-run.adoc[run]: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access. +* xref:rpk/rpk-connect/rpk-connect-agent-init.adoc[]: Initialize a Redpanda Connect agent. +* xref:rpk/rpk-connect/rpk-connect-agent-run.adoc[]: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access.Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc` around lines 17 - 18, Replace the hard-coded xref link text in rpk-connect-agent.adoc so titles are auto-pulled: change xref:rpk/rpk-connect/rpk-connect-agent-init.adoc[init] to xref:rpk/rpk-connect/rpk-connect-agent-init.adoc[] and xref:rpk/rpk-connect/rpk-connect-agent-run.adoc[run] to xref:rpk/rpk-connect/rpk-connect-agent-run.adoc[] (update the two xref usages shown in the diff).
1-29: Consider updating the parent page to list subcommands.The parent page
rpk-connect.adoc(referenced in context) lacks a "Subcommands" or "Commands" section that would enumerate available subcommands likeagent,dry-run, andplugin. While navigation provides access, including a subcommands section on the parent page would improve discoverability for users.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc` around lines 1 - 29, Parent page rpk-connect.adoc is missing a "Subcommands" section to list available subcommands (agent, dry-run, plugin); add a Subcommands or Commands section to rpk-connect.adoc that enumerates each subcommand with short descriptions and xref links (e.g., xref:rpk/rpk-connect/rpk-connect-agent.adoc[rpk connect agent], xref:rpk/rpk-connect/rpk-connect-dry-run.adoc[rpk connect dry-run], xref:rpk/rpk-connect/rpk-connect-plugin.adoc[rpk connect plugin]) so users can discover and navigate to the specific pages directly from the parent page.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc`:
- Around line 17-18: Replace the hard-coded xref link text in
rpk-connect-agent.adoc so titles are auto-pulled: change
xref:rpk/rpk-connect/rpk-connect-agent-init.adoc[init] to
xref:rpk/rpk-connect/rpk-connect-agent-init.adoc[] and
xref:rpk/rpk-connect/rpk-connect-agent-run.adoc[run] to
xref:rpk/rpk-connect/rpk-connect-agent-run.adoc[] (update the two xref usages
shown in the diff).
- Around line 1-29: Parent page rpk-connect.adoc is missing a "Subcommands"
section to list available subcommands (agent, dry-run, plugin); add a
Subcommands or Commands section to rpk-connect.adoc that enumerates each
subcommand with short descriptions and xref links (e.g.,
xref:rpk/rpk-connect/rpk-connect-agent.adoc[rpk connect agent],
xref:rpk/rpk-connect/rpk-connect-dry-run.adoc[rpk connect dry-run],
xref:rpk/rpk-connect/rpk-connect-plugin.adoc[rpk connect plugin]) so users can
discover and navigate to the specific pages directly from the parent page.
In `@modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc`:
- Line 17: Replace the hard-coded xref text `[init]` with empty brackets `[]` so
the link auto-pulls the target page title; update the xref in the
rpk-connect-plugin.adoc line referencing rpk-connect-plugin-init.adoc
(xref:rpk/rpk-connect/rpk-connect-plugin-init.adoc[]).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 12e93d25-7268-40ea-a8ff-661e4098ed7e
📒 Files selected for processing (7)
modules/ROOT/nav.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc
|
lgtm |
…le-plugin Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
3 participants
Summary
Adds documentation for three
rpk connectcommands missing from the reference:rpk connect agent(+agent init,agent runsubcommands) — marked EXPERIMENTALrpk connect dry-runrpk connect plugin(+plugin initsubcommand) — marked EXPERIMENTALUpdates
nav.adocto include the new pages in alphabetical order alongside existingrpk connectentries.Test plan
rpk connect🤖 Generated with Claude Code