diff --git a/docs-data/rpk-overrides.json b/docs-data/rpk-overrides.json index bc7b0dd9ee..f72cd64a3c 100644 --- a/docs-data/rpk-overrides.json +++ b/docs-data/rpk-overrides.json @@ -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 }, { "description": "Wrap Redpanda secret scope values in inline code", @@ -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----" } ] }, diff --git a/docs-data/rpk-overrides.schema.json b/docs-data/rpk-overrides.schema.json index 8bfe96f2b6..3d97879fb0 100644 --- a/docs-data/rpk-overrides.schema.json +++ b/docs-data/rpk-overrides.schema.json @@ -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"], diff --git a/modules/reference/pages/rpk/rpk-container/rpk-container-status.adoc b/modules/reference/pages/rpk/rpk-container/rpk-container-status.adoc index 9e5ba4ab2f..3781028a00 100644 --- a/modules/reference/pages/rpk/rpk-container/rpk-container-status.adoc +++ b/modules/reference/pages/rpk/rpk-container/rpk-container-status.adoc @@ -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