Skip to content

Remove duplicate Example heading on rpk container status #1860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JakeSCahill wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Remove duplicate Example heading on rpk container status #1860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
82a8159
fix: remove duplicate Example heading on rpk container status
JakeSCahill Jul 31, 2026
c89bc52
chore: mark the rpai binary-name rewrite as safe for code blocks
JakeSCahill Jul 31, 2026
4885213
chore: allow applyToCode in the overrides schema
JakeSCahill Jul 31, 2026
67ceb69
Restore the zero-width non-joiner escape flattened by a json round-trip
JakeSCahill Aug 3, 2026
13fdf3b
Merge remote-tracking branch 'origin/main' into cleanup/container-sta…
JakeSCahill Aug 3, 2026
4ac8d64
Match the doc-tools schema wording: applyToCode covers inline code sp…
JakeSCahill Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions docs-data/rpk-overrides.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,8 @@
"description": "Replace rpai shorthand with rpk ai in examples (rpai is the plugin binary name)",
"pattern": "\\brpai\\b",
"replacement": "rpk ai",
"flags": "g"
"flags": "g",
"applyToCode": true
Comment thread
coderabbitai[bot] marked this conversation as resolved.
},
{
"description": "Wrap Redpanda secret scope values in inline code",
Expand Down Expand Up @@ -3152,12 +3153,7 @@
"title": "Example",
"position": "end",
"headingLevel": 2,
"content": "[,bash]\n----\nrpk container status\nNODE-ID STATUS KAFKA-ADDRESS ADMIN-ADDRESS PROXY-ADDRESS SCHEMA-REGISTRY-ADDRESS\n0 running 127.0.0.1:9092 127.0.0.1:9644 127.0.0.1:8082 127.0.0.1:8081\n\nRedpanda Console started in: http://localhost:8080\n\nYou can use rpk to interact with this cluster. E.g:\n\n rpk cluster info\n rpk cluster health\n\nYou may also set an environment variable with the comma-separated list of\nbroker addresses:\n\n export RPK_BROKERS=\"127.0.0.1:34189,127.0.0.1:45523,127.0.0.1:37223\"\n rpk cluster info\n----"
},
{
"type": "self-hosted",
"position": "after_flags",
"content": "== Example\n\nIf you're following xref:get-started:quick-start.adoc#tabs-1-three-brokers[Quick Start - Deploy Redpanda to Docker with Three Nodes], you can run `rpk container status` to see more information about your containers."
"content": "ifndef::env-cloud[]\nIf you're following xref:get-started:quick-start.adoc#tabs-1-three-brokers[Quick Start - Deploy Redpanda to Docker with Three Nodes], you can run `rpk container status` to see more information about your containers.\nendif::[]\n\n[,bash]\n----\nrpk container status\nNODE-ID STATUS KAFKA-ADDRESS ADMIN-ADDRESS PROXY-ADDRESS SCHEMA-REGISTRY-ADDRESS\n0 running 127.0.0.1:9092 127.0.0.1:9644 127.0.0.1:8082 127.0.0.1:8081\n\nRedpanda Console started in: http://localhost:8080\n\nYou can use rpk to interact with this cluster. E.g:\n\n rpk cluster info\n rpk cluster health\n\nYou may also set an environment variable with the comma-separated list of\nbroker addresses:\n\n export RPK_BROKERS=\"127.0.0.1:34189,127.0.0.1:45523,127.0.0.1:37223\"\n rpk cluster info\n----"
}
]
},
Expand Down
4 changes: 4 additions & 0 deletions docs-data/rpk-overrides.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@
"description": "Regular expression flags. Default: 'g' (global). Common: 'gi' (global, case-insensitive)",
"default": "g",
"pattern": "^[gimsuvy]*$"
},
"applyToCode": {
"type": "boolean",
"description": "Also apply this replacement inside code contexts: code blocks captured from help text (verbatim command examples) and inline code spans. Default false: code contexts are protected from prose transformations. Use for binary-name rewrites like rpai to rpk ai."
}
},
"required": ["pattern", "replacement"],
Expand Down
4 changes: 1 addition & 3 deletions modules/reference/pages/rpk/rpk-container/rpk-container-status.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,12 @@ rpk container status [flags]
|-v, --verbose |bool |Enable verbose logging.
|===

ifndef::env-cloud[]
== Example

ifndef::env-cloud[]
If you're following xref:get-started:quick-start.adoc#tabs-1-three-brokers[Quick Start - Deploy Redpanda to Docker with Three Nodes], you can run `rpk container status` to see more information about your containers.
endif::[]

== Example

[,bash]
----
rpk container status
Expand Down
Loading