From 8804181e58194b3ca2ead137742f1c1f8e47f8a9 Mon Sep 17 00:00:00 2001 From: Michael Ernest Date: Mon, 16 Mar 2026 14:34:05 -0700 Subject: [PATCH 1/5] feat(DOC-1970): add missing rpk connect reference pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- modules/ROOT/nav.adoc | 12 ++++-- .../rpk-connect/rpk-connect-agent-init.adoc | 33 +++++++++++++++++ .../rpk-connect/rpk-connect-agent-run.adoc | 36 ++++++++++++++++++ .../rpk/rpk-connect/rpk-connect-agent.adoc | 29 +++++++++++++++ .../rpk/rpk-connect/rpk-connect-dry-run.adoc | 37 +++++++++++++++++++ .../rpk-connect/rpk-connect-plugin-init.adoc | 29 +++++++++++++++ .../rpk/rpk-connect/rpk-connect-plugin.adoc | 28 ++++++++++++++ 7 files changed, 201 insertions(+), 3 deletions(-) create mode 100644 modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc create mode 100644 modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc create mode 100644 modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc create mode 100644 modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc create mode 100644 modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc create mode 100644 modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 3c8abcbce6..903b7f95e6 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -356,12 +356,21 @@ ***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc[] ***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-list.adoc[] *** xref:reference:rpk/rpk-connect/rpk-connect.adoc[] +**** xref:reference:rpk/rpk-connect/rpk-connect-agent.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-agent-run.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-blobl-server.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-create.adoc[] +**** xref:reference:rpk/rpk-connect/rpk-connect-dry-run.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-echo.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-install.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-lint.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-list.adoc[] +**** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-init.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc[] +**** xref:reference:rpk/rpk-connect/rpk-connect-plugin.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-plugin-init.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-run.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-streams.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-studio-pull.adoc[] @@ -370,9 +379,6 @@ **** xref:reference:rpk/rpk-connect/rpk-connect-test.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-uninstall.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-upgrade.adoc[] -**** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server.adoc[] -***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-init.adoc[] -***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc[] *** xref:reference:rpk/rpk-container/rpk-container.adoc[] **** xref:reference:rpk/rpk-container/rpk-container.adoc[] **** xref:reference:rpk/rpk-container/rpk-container-purge.adoc[] diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc new file mode 100644 index 0000000000..94708a4699 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc @@ -0,0 +1,33 @@ += rpk connect agent init +:description: Initialize a Redpanda Connect agent. + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Initialize a template for building a Redpanda Connect agent. + +== Usage + + rpk connect agent init [OPTIONS] + +== Example + +[,bash] +---- +rpk connect agent init ./repo +---- + +== Options + +[cols="1m,2a"] +|=== +| Option | Description + +| --name +| The name of the agent. + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc new file mode 100644 index 0000000000..d50614470d --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc @@ -0,0 +1,36 @@ += rpk connect agent run +:description: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access. + +[IMPORTANT] +==== +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. + +== Usage + + rpk connect agent run [OPTIONS] + +== Example + +[,bash] +---- +rpk connect agent run ./repo +---- + +== Options + +[cols="1m,2a"] +|=== +| Option | Description + +| --secrets env: +| Attempt to load secrets from a provided URN. If more than one entry is specified, they are attempted in order until a value is found. Environment variable lookups are specified with the URN `env:`, which by default is the only entry. To disable all secret lookups, specify a single entry of `none:` (default: `env:`). + +| --redpanda-license +| Provide an explicit Redpanda License, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied. + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc new file mode 100644 index 0000000000..03a2a511be --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc @@ -0,0 +1,29 @@ += rpk connect agent +:description: Redpanda Connect agent commands. + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Run and initialize Redpanda Connect agents. Agents are pipelines that have access to tools via the MCP (Model Context Protocol) and can interact with AI models. + +== Usage + + rpk connect agent [command] + +== Subcommands + +* 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. +* help, h: Show a list of commands or help for one command. + +== Options + +[cols="1m,2a"] +|=== +| Option | Description + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc new file mode 100644 index 0000000000..9e59f716c3 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc @@ -0,0 +1,37 @@ += rpk connect dry-run +:description: Parse Redpanda Connect configs and test the connections of each plugin. + +Parse Redpanda Connect configs and test the connections of each plugin. Exits with a status code of `1` if any connection errors are detected. + +== Usage + + rpk connect dry-run [command options] + +== Example + +[,bash] +---- +rpk connect dry-run ./foo.yaml +---- + +== Options + +[cols="1m,2a"] +|=== +| Option | Description + +| --verbose +| Print the lint result for each target file (default: false). + +| --secrets env: +| Attempt to load secrets from a provided URN. If more than one entry is specified, they are attempted in order until a value is found. Environment variable lookups are specified with the URN `env:`, which by default is the only entry. To disable all secret lookups, specify a single entry of `none:` (default: `env:`). + +| --env-file, -e +| 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. + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc new file mode 100644 index 0000000000..ac92f0787a --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc @@ -0,0 +1,29 @@ += rpk connect plugin init +:description: Create the boilerplate for a custom Redpanda Connect plugin. + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Generate a project on the local filesystem that can be used as a starting point for building a custom component for Redpanda Connect. Existing files in the specified directory are overwritten. + +== Usage + + rpk connect plugin init [OPTIONS] + +== Options + +[cols="1m,2a"] +|=== +| Option | Description + +| --language, --lang +| The programming language for the plugin. Supported languages are `golang` and `python` (default: `python`). + +| --component +| The type of component to generate. Supported components are `input`, `output`, and `processor` (default: `processor`). + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc new file mode 100644 index 0000000000..9b9131da24 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc @@ -0,0 +1,28 @@ += rpk connect plugin +:description: Plugin management commands for Redpanda Connect. + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Manage custom Redpanda Connect plugins. Use these commands to scaffold and build custom components. + +== Usage + + rpk connect plugin [command] + +== Subcommands + +* xref:rpk/rpk-connect/rpk-connect-plugin-init.adoc[init]: Create the boilerplate for a custom component plugin. +* help, h: Show a list of commands or help for one command. + +== Options + +[cols="1m,2a"] +|=== +| Option | Description + +| --help, -h +| Show help for the command. +|=== From ade95c3587b345dfff5c3109029d3e7b23c87ed1 Mon Sep 17 00:00:00 2001 From: Michal Matczuk Date: Wed, 18 Mar 2026 19:01:31 +0100 Subject: [PATCH 2/5] review fixes: chroot flags, dry-run usage, plugin-init example (#1616) --- .../pages/rpk/rpk-connect/rpk-connect-agent-run.adoc | 8 ++++++++ .../pages/rpk/rpk-connect/rpk-connect-dry-run.adoc | 2 +- .../pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc | 7 +++++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc index d50614470d..c6b0b6fc9d 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc @@ -33,4 +33,12 @@ rpk connect agent run ./repo | --help, -h | Show help for the command. + +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. + +| --chroot-passthrough +| Specify additional files to be copied into the chroot directory. Can be specified multiple times. Only valid when `--chroot` is used. |=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc index 9e59f716c3..9c7d0996c7 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc @@ -5,7 +5,7 @@ Parse Redpanda Connect configs and test the connections of each plugin. Exits wi == Usage - rpk connect dry-run [command options] + rpk connect dry-run [OPTIONS] [files...] == Example diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc index ac92f0787a..e54d5cdd56 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc @@ -12,6 +12,13 @@ Generate a project on the local filesystem that can be used as a starting point rpk connect plugin init [OPTIONS] +== Example + +[,bash] +---- +rpk connect plugin init ./my-plugin +---- + == Options [cols="1m,2a"] From c185e88aac96edd7dd82e42183612250921d0766 Mon Sep 17 00:00:00 2001 From: Michael Ernest Date: Wed, 18 Mar 2026 12:47:17 -0700 Subject: [PATCH 3/5] style(DOC-1970): rename plugin-init example from ./my-plugin to example-plugin Co-Authored-By: Claude Sonnet 4.6 --- .../pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc index e54d5cdd56..d2f02ea58b 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc @@ -16,7 +16,7 @@ Generate a project on the local filesystem that can be used as a starting point [,bash] ---- -rpk connect plugin init ./my-plugin +rpk connect plugin init example-plugin ---- == Options From 7624950b594fc43777a1aff0deb6b8d813432d4e Mon Sep 17 00:00:00 2001 From: Michael Ernest Date: Mon, 23 Mar 2026 19:21:31 -0700 Subject: [PATCH 4/5] fix(DOC-1970): address kbatuigas review feedback on rpk connect reference pages - Add reference: module prefix to xrefs in agent and plugin pages - Add :page-topic-type: reference to all new pages - Rephrase rpk connect agent run description per review suggestion - Remove non-rendering 4+h| Linux only header row; add (Linux only) qualifier inline to --chroot and --chroot-passthrough descriptions - Rename --secrets option cell from --secrets env: to --secrets - Add --secrets none: usage example to agent run and dry-run - Rename foo.yaml to pipeline.yaml in dry-run example - Lowercase "license" in --redpanda-license description Co-Authored-By: Claude Sonnet 4.6 --- .../rpk-connect/rpk-connect-agent-init.adoc | 1 + .../rpk-connect/rpk-connect-agent-run.adoc | 20 ++++++++++++------- .../rpk/rpk-connect/rpk-connect-agent.adoc | 5 +++-- .../rpk/rpk-connect/rpk-connect-dry-run.adoc | 14 ++++++++++--- .../rpk-connect/rpk-connect-plugin-init.adoc | 1 + .../rpk/rpk-connect/rpk-connect-plugin.adoc | 3 ++- 6 files changed, 31 insertions(+), 13 deletions(-) diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc index 94708a4699..4cd054af40 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc @@ -1,5 +1,6 @@ = rpk connect agent init :description: Initialize a Redpanda Connect agent. +:page-topic-type: reference [IMPORTANT] ==== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc index c6b0b6fc9d..64be03b297 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc @@ -1,12 +1,13 @@ = rpk connect agent run :description: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access. +:page-topic-type: reference [IMPORTANT] ==== 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. +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. == Usage @@ -19,26 +20,31 @@ Execute a Redpanda Connect agent as part of a pipeline that has access to tools rpk connect agent run ./repo ---- +To disable all secret lookups: + +[,bash] +---- +rpk connect agent run --secrets none: ./repo +---- + == Options [cols="1m,2a"] |=== | Option | Description -| --secrets env: +| --secrets | Attempt to load secrets from a provided URN. If more than one entry is specified, they are attempted in order until a value is found. Environment variable lookups are specified with the URN `env:`, which by default is the only entry. To disable all secret lookups, specify a single entry of `none:` (default: `env:`). | --redpanda-license -| 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. | --help, -h | Show help for the command. -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. +| (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. | --chroot-passthrough -| Specify additional files to be copied into the chroot directory. Can be specified multiple times. Only valid when `--chroot` is used. +| (Linux only) Specify additional files to be copied into the chroot directory. Can be specified multiple times. Only valid when `--chroot` is used. |=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc index 03a2a511be..83260701eb 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc @@ -1,5 +1,6 @@ = rpk connect agent :description: Redpanda Connect agent commands. +:page-topic-type: reference [IMPORTANT] ==== @@ -14,8 +15,8 @@ Run and initialize Redpanda Connect agents. Agents are pipelines that have acces == Subcommands -* 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:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[init]: Initialize a Redpanda Connect agent. +* xref:reference:rpk/rpk-connect/rpk-connect-agent-run.adoc[run]: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access. * help, h: Show a list of commands or help for one command. == Options diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc index 9c7d0996c7..6cc182e2aa 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc @@ -1,5 +1,6 @@ = rpk connect dry-run :description: Parse Redpanda Connect configs and test the connections of each plugin. +:page-topic-type: reference Parse Redpanda Connect configs and test the connections of each plugin. Exits with a status code of `1` if any connection errors are detected. @@ -11,7 +12,14 @@ Parse Redpanda Connect configs and test the connections of each plugin. Exits wi [,bash] ---- -rpk connect dry-run ./foo.yaml +rpk connect dry-run ./pipeline.yaml +---- + +To disable all secret lookups: + +[,bash] +---- +rpk connect dry-run --secrets none: ./pipeline.yaml ---- == Options @@ -23,14 +31,14 @@ rpk connect dry-run ./foo.yaml | --verbose | Print the lint result for each target file (default: false). -| --secrets env: +| --secrets | Attempt to load secrets from a provided URN. If more than one entry is specified, they are attempted in order until a value is found. Environment variable lookups are specified with the URN `env:`, which by default is the only entry. To disable all secret lookups, specify a single entry of `none:` (default: `env:`). | --env-file, -e | 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. +| Provide an explicit Redpanda license, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied. | --help, -h | Show help for the command. diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc index d2f02ea58b..b3503b0157 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc @@ -1,5 +1,6 @@ = rpk connect plugin init :description: Create the boilerplate for a custom Redpanda Connect plugin. +:page-topic-type: reference [IMPORTANT] ==== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc index 9b9131da24..2fb05acaa3 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc @@ -1,5 +1,6 @@ = rpk connect plugin :description: Plugin management commands for Redpanda Connect. +:page-topic-type: reference [IMPORTANT] ==== @@ -14,7 +15,7 @@ Manage custom Redpanda Connect plugins. Use these commands to scaffold and build == Subcommands -* 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. * help, h: Show a list of commands or help for one command. == Options From 161cc8e1df5427d7c930e7b7b78e0da6296e2941 Mon Sep 17 00:00:00 2001 From: Michael Ernest Date: Tue, 24 Mar 2026 10:10:58 -0700 Subject: [PATCH 5/5] fix(DOC-1970): use empty xref brackets for auto-pulled titles Co-Authored-By: Claude Sonnet 4.6 --- .../reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc | 4 ++-- .../reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc index 83260701eb..403750e55a 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc @@ -15,8 +15,8 @@ Run and initialize Redpanda Connect agents. Agents are pipelines that have acces == Subcommands -* xref:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[init]: Initialize a Redpanda Connect agent. -* xref:reference:rpk/rpk-connect/rpk-connect-agent-run.adoc[run]: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access. +* xref:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[]: Initialize a Redpanda Connect agent. +* xref:reference:rpk/rpk-connect/rpk-connect-agent-run.adoc[]: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access. * help, h: Show a list of commands or help for one command. == Options diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc index 2fb05acaa3..80f0eac210 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc @@ -15,7 +15,7 @@ Manage custom Redpanda Connect plugins. Use these commands to scaffold and build == Subcommands -* xref:reference: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[]: Create the boilerplate for a custom component plugin. * help, h: Show a list of commands or help for one command. == Options