From e152257ea56bbe8cf233b1adcf59f4f9e8bacecc Mon Sep 17 00:00:00 2001 From: micheleRP Date: Fri, 31 Jul 2026 09:33:19 -0600 Subject: [PATCH] docs: clean up stale rpk command overrides Four override entries pointed at command paths that no longer exist, so they silently did nothing and showed up as validation errors on every generator run: - rpk ai llm and rpk ai llm check were renamed to rpk ai llm-provider. Migrate the check description to the new path. Drop the provider-type list, which was already missing openai-compatible and is the kind of enumeration that drifts. - rpk cluster storage restore-start is now rpk cluster storage restore start. Drop the override: the source description is more complete, covering the wait flag, cluster-uuid-override, and a link to the whole-cluster-restore docs, and the page already has an alias from the old name. - rpk connect studio sync-schema is gone entirely, along with the rest of rpk connect studio. Also replace the hand-written Flags table on rpk connect run with per-flag overrides. The table listed 7 flags while the command has 13, so secrets, redpanda-license, disable-telemetry, the two telemetry flags, and rpc-plugins were undocumented. Moving its curated wording into the flags map keeps the descriptions and picks up the missing flags, and restores Usage ahead of Flags on the page. Override validation now reports zero errors, down from four. Co-Authored-By: Claude Opus 5 (1M context) --- docs-data/rpk-overrides.json | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/docs-data/rpk-overrides.json b/docs-data/rpk-overrides.json index 44d4850e0d..9c0e5e4414 100644 --- a/docs-data/rpk-overrides.json +++ b/docs-data/rpk-overrides.json @@ -1086,18 +1086,20 @@ }, "resources": { "description": "Additional resource configuration files containing caches, rate limits, or other shared components." + }, + "chilled": { + "description": "Continue to execute a config containing linter errors." + }, + "watcher": { + "description": "EXPERIMENTAL: Watch config files for changes and automatically apply them." + }, + "env-file": { + "description": "Import environment variables from a dotenv file." + }, + "templates": { + "description": "EXPERIMENTAL: Import Redpanda Connect templates. This supports glob patterns (requires quotes)." } - }, - "content": [ - { - "type": "section", - "id": "connect-flags", - "title": "Flags", - "position": "after_description", - "headingLevel": 2, - "content": "[cols=\"1m,1a,2a\"]\n|===\n|Value |Type |Description\n\n|--log.level |string |Override the configured log level. Acceptable values: `off`, `error`, `warn`, `info`, `debug`, `trace`.\n|--set |stringArray |Set a field (identified by a dot path) in the main configuration file. For example: `metrics.type=prometheus`.\n|--resources, -r |stringArray |Pull in extra resources from a file, which can be referenced the same as resources defined in the main config. This supports glob patterns (requires quotes).\n|--chilled |bool |Continue to execute a config containing linter errors (default: false).\n|--watcher, -w |bool |EXPERIMENTAL: Watch config files for changes and automatically apply them (default: false).\n|--env-file, -e |string |Import environment variables from a dotenv file.\n|--templates, -t |stringArray |EXPERIMENTAL: Import Redpanda Connect templates. This supports glob patterns (requires quotes).\n|===" - } - ] + } }, "rpk connect lint": { "description": "Check a Redpanda Connect configuration file for syntax errors and potential issues without running it.", @@ -3050,9 +3052,6 @@ "exclude": true, "_note": "Command mentions \"coming soon\" and needs proper review before inclusion in docs" }, - "rpk ai llm": { - "appendToDescription": "\n\nSupported provider types: `openai`, `anthropic`, `google`, `bedrock`." - }, "rpk ai model": { "appendToDescription": "\n\nThe catalog is read-only. The catalog is populated from each LLM provider's metadata plus any extras the operator has pinned to a tenant." }, @@ -3076,9 +3075,6 @@ "rpk cluster config lint": { "description": "Identify any Redpanda configuration properties that are not recognized. These may be properties that were valid in earlier versions of Redpanda but are now managed via the central configuration store." }, - "rpk cluster storage restore-start": { - "description": "Start a topic recovery operation from Tiered Storage. If the `--wait` (`-w`) flag is set, the command polls the status of the recovery process until it finishes." - }, "rpk cluster logdirs describe": { "flags": { "aggregate-into": { @@ -3161,9 +3157,6 @@ "rpk connect install": { "description": "Install Redpanda Connect. This command installs the latest version by default. Use the `--connect-version` flag to specify a version." }, - "rpk connect studio sync-schema": { - "description": "Synchronize the schema of a Redpanda Connect instance with a Redpanda Connect Studio session. This command ensures that your pipeline components are configured and linted correctly within Redpanda Connect Studio." - }, "rpk transform logs": { "description": "View logs for a data transform. Streams STDOUT and STDERR output captured during runtime to your terminal." }, @@ -3185,7 +3178,7 @@ "rpk ai agent stop": { "description": "Stop a managed agent, setting its desired state to stopped." }, - "rpk ai llm check": { + "rpk ai llm-provider check": { "description": "Run a lightweight probe against the configured LLM provider to verify credentials and reachability." }, "rpk ai agent credential create": {