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>
|
@mmatczuk — gentle nudge on this one when you have a chance. Adds the missing |
kbatuigas
left a comment
kbatuigas
left a comment
There was a problem hiding this comment.
Changes required to xrefs
| rpk connect agent init ./repo | ||
| ---- | ||
|
|
||
| == Options |
There was a problem hiding this comment.
No change required for this PR, but I wanted to note that the other rpk connect pages use a "Flags" heading (example). This might have to do with our reference automation tool, could be worth raising a separate ticket to look into.
| This command is experimental and subject to change. | ||
| ==== | ||
|
|
||
| Execute a Redpanda Connect agent as part of a pipeline that has access to tools via the MCP (Model Context Protocol). Each resource in the `mcp` subdirectory creates tools that can be used, then the `redpanda_agents.yaml` file along with Python agent modules are invoked. |
There was a problem hiding this comment.
| Execute a Redpanda Connect agent as part of a pipeline that has access to tools via the MCP (Model Context Protocol). Each resource in the `mcp` subdirectory creates tools that can be used, then the `redpanda_agents.yaml` file along with Python agent modules are invoked. | |
| Execute a Redpanda Connect agent as part of a pipeline that has access to tools via the MCP (Model Context Protocol). The command first reads resource definitions in the `mcp` subdirectory and exposes them as tools. It then runs the agent defined in `redpanda_agents.yaml` along with any Python agent modules. |
The second sentence is a bit unclear to me, so here's a suggestion to rephrase -- @mmatczuk please let us know if the rephrase is correct.
| @@ -0,0 +1,33 @@ | |||
| = rpk connect agent init | |||
| :description: Initialize a Redpanda Connect agent. | |||
|
|
|||
There was a problem hiding this comment.
| :page-topic-type: reference | |
Would also recommend adding this to the new pages -- we don't have this consistently for live pages so there's some tech debt here, but we should try and start adding these topic types to new pages.
| | --help, -h | ||
| | Show help for the command. | ||
|
|
||
| 4+h| Linux only |
There was a problem hiding this comment.
Please double check what this is for, it's currently not being rendered: https://deploy-preview-1608--redpanda-docs-preview.netlify.app/current/reference/rpk/rpk-connect/rpk-connect-agent-run/#options If it's meant to indicate that the following options are for Linux only, we should just indicate that in the individual description cells and remove this row altogether.
| 4+h| Linux only | ||
|
|
||
| | --chroot | ||
| | Chroot into the provided directory after parsing configuration. Common `/etc/` files are copied to the chroot directory, and the directory is made read-only. |
There was a problem hiding this comment.
| | Chroot into the provided directory after parsing configuration. Common `/etc/` files are copied to the chroot directory, and the directory is made read-only. | |
| | (Linux only) Chroot into the provided directory after parsing configuration. Common `/etc/` files are copied to the chroot directory, and the directory is made read-only. |
Based on previous suggestion
|
|
||
| [,bash] | ||
| ---- | ||
| rpk connect dry-run ./foo.yaml |
There was a problem hiding this comment.
Could we give the yaml file a name more descriptive than foo?
| |=== | ||
| | Option | Description | ||
|
|
||
| | --secrets env: |
There was a problem hiding this comment.
Based on the description, if env: is the default, but you could use --secrets none:, maybe we should keep the string in this cell to --secrets only? I'd also suggest adding explicit usage examples in the preceding section, it's not very clear to me how to use this option
| | --verbose | ||
| | Print the lint result for each target file (default: false). | ||
|
|
||
| | --secrets env: |
| | Import environment variables from a dotenv file. | ||
|
|
||
| | --redpanda-license | ||
| | Provide an explicit Redpanda License, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied. |
There was a problem hiding this comment.
| | Provide an explicit Redpanda License, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied. | |
| | Provide an explicit Redpanda license, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied. |
|
|
||
| == Subcommands | ||
|
|
||
| * xref:rpk/rpk-connect/rpk-connect-plugin-init.adoc[init]: Create the boilerplate for a custom component plugin. |
There was a problem hiding this comment.
| * xref:rpk/rpk-connect/rpk-connect-plugin-init.adoc[init]: Create the boilerplate for a custom component plugin. | |
| * xref:reference:rpk/rpk-connect/rpk-connect-plugin-init.adoc[init]: Create the boilerplate for a custom component plugin. |
4 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