docs: update rpk ai plugin docs (0.2.33) - #1877
Conversation
vbotbuildovich
added
automated
documentation
✅ 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 change refreshes generated RPK metadata and reference documentation. It updates AI plugin metadata to version Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 18
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs-data/rpk-overrides.json`:
- Line 341: Remove the remaining invisible character between the opening
backtick and “-f” in the description for the “Wrap bare flag with adjacent”
replacement rule, preserving the intended inline-code example and ensuring the
description contains only ASCII characters.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc`:
- Around line 2-8: Update the generation source for the configuration-status
description to use environment-specific text: retain the per-broker restart,
invalid-setting, and configuration-version summary for self-hosted deployments,
and use the long-running-operation status and timestamp summary for Redpanda
Cloud. Apply the source change so both rpk-cluster-config-status.adoc and the
matching row in rpk-cluster-config.adoc render the appropriate description.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc`:
- Around line 2-8: Update the description in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc at lines
2-8 to add sentence punctuation after “cluster” in both generated summary
entries. Regenerate the parent row in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc at line 29 from
the corrected source description.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc`:
- Around line 2-8: Update the shared partition-description template to add a
period after “topic” and escape the inner closing bracket as “[partitions...\]”;
regenerate both affected descriptions in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc:2-8
and
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc:2-8.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc`:
- Around line 2-9: Update the partition-list description in the source override
to use “This command lists...” with a sentence boundary after “cluster,” then
regenerate the page so both visible :description declarations match exactly.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc`:
- Around line 33-39: Update the generator input for the partition command
descriptions: add periods after “topic” in the disable and enable descriptions,
and in the list description add a period after “cluster” and change “This
commands” to “This command”. Regenerate the output file so these corrections
appear in the generated documentation.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc`:
- Around line 2-8: Fix the shared quota description punctuation by adding a
period after “quota” in both :description: attributes in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc (lines
2-8), and in the alter subcommand description in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc (lines 31-32).
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc`:
- Around line 2-8: The shared transaction description has a missing sentence
boundary and repeats “and the.” Update both :description: attributes and the
matching page text in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc (lines 2-8),
then apply the same corrected description to the parent command’s list entry in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc (lines 87-88).
In
`@modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc`:
- Around line 2-8: Malformed generated RPK command descriptions must be
corrected at the source in docs-data/rpk-overrides.json, then all affected pages
rerendered. Update
modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc
lines 2-8 with a separator after “Metrics”; preserve complete contact text at
modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc lines 3 and
9; separate Grafana and license summaries and remove duplicated “BASH” in
modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc lines 29-33 and 42;
add the missing separator in
modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc lines 2-8; and
correct “This commands prints” plus the missing separator in
modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc lines 50 and 60.
In `@modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc`:
- Line 20: Update the PS1 example in the rpk profile prompt documentation to use
a single command substitution, `$(rpk profile prompt)`, so the command is
invoked with the intended profile prompt arguments rather than nested backticks
executing rpk without arguments.
In `@modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc`:
- Around line 2-8: Restore sentence boundaries in the generated descriptions by
adding the missing period after “on” in both :description: attributes in
modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc (lines
2-8), after “on” in
modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc (line 36), and
after “mode” in both :description: attributes in
modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc (lines 2-8).
In `@modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc`:
- Around line 2-8: Regenerate the command descriptions so they are complete
summaries without inline list markup or incomplete examples, making them safe
for parent tables. Apply the corrected generated descriptions in
modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc (lines
2-8), modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc (line 71),
and modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc (line 31);
likewise update
modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc (lines 2-8),
modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc (line 31),
modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc (lines
2-8), and modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc
(line 34).
In `@modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc`:
- Around line 2-8: Verify the CLI contract, then update the source metadata
generating Usage for rpk registry mode set in
modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc:2-8 to mark
subject as optional when global mode can be set without it. Also update
modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc:2-8 to
show subject as optional, or represent separate usage forms, when --id lookup
works without a subject; regenerate the affected documentation rather than
editing autogenerated output directly.
In `@modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc`:
- Around line 2-12: Update the transform log description metadata and body
content to use the full topic identifier `_redpanda.transform_logs`, preserving
inline-code formatting around the topic name in the rendered text.
In `@modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc`:
- Line 49: Update the `rpk transform logs` documentation entry to replace the
fragment “transform_logs.” with a complete explanation that runtime STDOUT and
STDERR are stored in the internal `_redpanda.transform_logs` topic.
In `@modules/reference/partials/rpk-ai/rpk-ai-install.adoc`:
- Line 13: Update the version-reference sentence to identify the complete
command as “rpk ai” rather than separately formatting only “rpk”; preserve the
existing --ai-version flag guidance.
In `@modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc`:
- Around line 2-8: Update the source override or generator input for the
affected RPK Cloud command descriptions, adding sentence-ending periods after
the specified summary terms in
modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc:2-8,
rpk-cloud-byoc-uninstall.adoc:2-8, rpk-cloud-byoc.adoc:2-8 and 34-37,
rpk-cloud-login.adoc:2-8, rpk-cloud-logout.adoc:2-8, and rpk-cloud.adoc:28-37;
then regenerate the generated pages.
In `@modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc`:
- Line 2: Update the description text in the source override so the phrase “this
command will login” uses the verb form “this command will log in,” preserving
the rest of the description unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d5af929d-8adf-4259-a063-f8eabac2c5b4
📒 Files selected for processing (67)
docs-data/rpk-overrides.jsondocs-data/rpk-v26.2.1.jsonmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade.adocmodules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adocmodules/reference/pages/rpk/rpk-generate/rpk-generate-license.adocmodules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adocmodules/reference/pages/rpk/rpk-generate/rpk-generate.adocmodules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adocmodules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adocmodules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adocmodules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adocmodules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adocmodules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adocmodules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adocmodules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adocmodules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adocmodules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adocmodules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adocmodules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-config.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic.adocmodules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adocmodules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adocmodules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adocmodules/reference/pages/rpk/rpk-transform/rpk-transform.adocmodules/reference/partials/rpk-ai/rpk-ai-install.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adocmodules/reference/partials/rpk-ai/rpk-ai-oauth-client-create.adocmodules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adocmodules/reference/partials/rpk-ai/rpk-ai-oauth-provider-create.adocmodules/reference/partials/rpk-ai/rpk-ai-oauth-provider-update.adocmodules/reference/partials/rpk-ai/rpk-ai-version.adocmodules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adocmodules/reference/partials/rpk-cloud/rpk-cloud-byoc-uninstall.adocmodules/reference/partials/rpk-cloud/rpk-cloud-byoc.adocmodules/reference/partials/rpk-cloud/rpk-cloud-login.adocmodules/reference/partials/rpk-cloud/rpk-cloud-logout.adocmodules/reference/partials/rpk-cloud/rpk-cloud.adoc
| }, | ||
| { | ||
| "description": "Wrap bare flag with adjacent format/value word as inline code before auto-backtick step splits them (e.g. -f json -> `\u200c-f json`, --format yaml -> `--format yaml`)", | ||
| "description": "Wrap bare flag with adjacent format/value word as inline code before auto-backtick step splits them (e.g. -f json -> `-f json`, --format yaml -> `--format yaml`)", |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Remove the remaining invisible character from the example.
The description still contains a hidden character between the opening backtick and -f. Remove it so users can copy the example without corrupting the flag.
python - <<'PY'
import json
from pathlib import Path
data = json.loads(Path("docs-data/rpk-overrides.json").read_text())
rule = next(
rule for rule in data["textTransformations"]["replacements"]
if rule["description"].startswith("Wrap bare flag with adjacent")
)
assert all(ord(char) < 128 for char in rule["description"])
PY🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs-data/rpk-overrides.json` at line 341, Remove the remaining invisible
character between the opening backtick and “-f” in the description for the “Wrap
bare flag with adjacent” replacement rule, preserving the intended inline-code
example and ensuring the description contains only ASCII characters.
| :description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied. | ||
| :page-platforms: linux,darwin | ||
|
|
||
| // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc | ||
|
|
||
| // tag::single-source[] | ||
| :description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings. | ||
| :description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -e
printf '%s\n' '--- candidate files ---'
git ls-files | rg 'rpk-cluster-(config-status|config|license-set|license|partitions-(disable|enable))\.adoc$'
printf '%s\n' '--- config-status page ---'
cat -n modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc
printf '%s\n' '--- parent config page ---'
sed -n '65,95p' modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc
printf '%s\n' '--- related license and partition pages ---'
for f in \
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc \
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc \
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc \
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc; do
if [ -f "$f" ]; then
echo "--- $f ---"
cat -n "$f"
fi
done
printf '%s\n' '--- all matching descriptions and environment branches ---'
rg -n -C 3 'configuration status of Redpanda brokers|operation progress|config-status|Cloud|cloud' modules docs docs-data 2>/dev/null | head -n 300Repository: redpanda-data/docs
Length of output: 1922
🌐 Web query:
site:github.com/redpanda-data/docs "rpk-cluster-config-status.adoc" "operation progress"
💡 Result:
There is no public command or documentation reference for rpk-cluster-config-status.adoc as an rpk operation progress command. The provided search results indicate that rpk documentation is managed via an automated generation system [1], and filenames like rpk-cluster-config-status.adoc appear to be internal documentation source files rather than public CLI commands [1]. Administrative tasks in Redpanda, such as managing and monitoring configurations, are performed using the rpk admin API [2][3]. If you are looking to monitor the status of configuration changes or operations, you should typically use the relevant rpk cluster or admin commands. Based on the documentation repository structure, rpk operations generally follow standard command patterns provided in the official Redpanda CLI documentation [1].
Citations:
- 1: feat: add rpk documentation automation #1733
- 2: https://github.com/redpanda-data/docs/blob/main/tests/docker-compose/rpk-profile.yaml
- 3: https://github.com/redpanda-data/docs/blob/v/24.3/tests/docker-compose/rpk-profile.yaml
🌐 Web query:
site:github.com/redpanda-data/docs "Get the configuration status of Redpanda brokers"
💡 Result:
To check the configuration status of Redpanda brokers, you can use the rpk command-line tool, which interacts with the Redpanda Admin API [1][2]. The Admin API serves as the primary interface for administrative tasks, including managing and monitoring cluster configurations [1][3]. While specific commands can evolve, you generally use rpk to communicate with the Admin API endpoints configured for each broker [1][2]. You can identify the configured Admin API addresses for your cluster by inspecting your rpk profile, typically located at ~/.config/rpk/rpk.yaml or specified in a custom profile file [1][2]. Example structure of an rpk profile's Admin API configuration: admin_api: addresses: - 127.0.0.1:19644 # Admin API for Broker 1 - 127.0.0.1:29644 # Admin API for Broker 2 - 127.0.0.1:39644 # Admin API for Broker 3 For property-specific information, Redpanda provides cluster property documentation [4][5]. Because configuration properties can sometimes be sensitive to naming (e.g., ensuring singular or plural forms are used correctly, such as default_topic_replications instead of default_topic_replication), it is recommended to consult the official documentation for the version of Redpanda you are running [4][5]. If you are operating in a Kubernetes environment, be aware that certain operator upgrades may trigger a rolling restart of all broker pods if the configurator or sidecar image tags are updated [6]. You can verify your cluster's status and perform administrative operations by targeting these Admin API endpoints [1][3].
Citations:
- 1: https://github.com/redpanda-data/docs/blob/main/tests/docker-compose/rpk-profile.yaml
- 2: https://github.com/redpanda-data/docs/blob/v/25.3/tests/docker-compose/rpk-profile.yaml
- 3: https://github.com/redpanda-data/docs/blob/v/24.3/tests/docker-compose/rpk-profile.yaml
- 4: fix: Missing an "s" in default_topic_replication #1657
- 5: fix(properties): correct topic property name in kafka_batch_max_bytes reference #1775
- 6: upgrade: document broker restarts during operator upgrades #1758
🌐 Web query:
site:docs.redpanda.com "configuration status" "operation" "rpk cluster config"
💡 Result:
The rpk cluster config status command is used to verify the current configuration state of all brokers within a Redpanda cluster [1][2][3]. This command provides critical operational information to ensure cluster consistency, including [3][4]: - Configuration Version: It returns the cluster configuration version currently applied by each broker. All brokers should ideally be on the same version; if a broker shows a lower version number, it indicates it may be out of sync, potentially because it is offline or has not yet processed the latest updates [3][4]. - Restart Requirements: It explicitly indicates whether any broker requires a restart to apply new configuration settings [3][4][5]. - Error Reporting: It identifies any configuration properties that have been flagged by a broker as invalid or unknown [3][4]. Operationally, this command is typically executed after using other rpk cluster config commands—such as edit, set, or import—to confirm that changes have been successfully propagated and to determine if further administrative actions (like restarting nodes) are necessary to complete the update process [1][5][6].
Citations:
- 1: https://docs.redpanda.com/streaming/current/reference/rpk/rpk-cluster/rpk-cluster-config/
- 2: https://docs.redpanda.com/current/reference/rpk/rpk-cluster/rpk-cluster-config/
- 3: https://docs.redpanda.com/streaming/current/reference/rpk/rpk-cluster/rpk-cluster-config-status/
- 4: https://docs.redpanda.com/current/reference/rpk/rpk-cluster/rpk-cluster-config-status/
- 5: https://docs.redpanda.com/25.3/manage/cluster-maintenance/cluster-property-configuration/
- 6: https://docs.redpanda.com/24.2/manage/cluster-maintenance/cluster-property-configuration/
🌐 Web query:
site:docs.redpanda.com "rpk cluster config status"
💡 Result:
The rpk cluster config status command is used to inspect the configuration status of Redpanda brokers [1][2]. It allows administrators to verify that all brokers in a cluster have successfully applied the latest configuration changes [3][2]. When executed, the command provides a summary for each broker, including: - Configuration Version: Shows the version of the cluster configuration currently applied by each broker. Brokers should ideally share the same version number; a lower number on a specific broker may indicate that it is offline or has not yet synchronized with the latest updates [1][2]. - Restart Requirement: Indicates whether a broker requires a restart to apply specific configuration changes (NEEDS-RESTART) [1][4][5]. - Errors: Displays any configuration settings that a broker has flagged as invalid or unknown (e.g., if a broker is running an older Redpanda version that does not recognize a newly applied property) [1][3][2]. This command is typically used after modifying cluster properties with rpk cluster config edit to confirm that the changes have propagated correctly and to identify if any manual intervention, such as a cluster restart, is necessary [3][4][5].
Citations:
- 1: https://docs.redpanda.com/streaming/current/reference/rpk/rpk-cluster/rpk-cluster-config-status/
- 2: https://docs.redpanda.com/current/reference/rpk/rpk-cluster/rpk-cluster-config/
- 3: https://docs.redpanda.com/streaming/current/reference/rpk/rpk-cluster/rpk-cluster-config/
- 4: https://docs.redpanda.com/25.3/manage/cluster-maintenance/cluster-property-configuration/
- 5: https://docs.redpanda.com/streaming/25.3/manage/cluster-maintenance/cluster-property-configuration/
🌐 Web query:
site:github.com/redpanda-data/docs "operation progress" Redpanda Cloud configuration
💡 Result:
Redpanda Cloud configuration and operation progress are managed through several interfaces depending on the specific task. For Redpanda Cloud clusters, configuration and management are typically handled via the Redpanda Cloud UI, the Redpanda Console, and the Redpanda command-line interface (rpk) [1][2]. Key mechanisms for monitoring and managing operation progress include: 1. Console UI: The Redpanda Console is a central interface for cluster management, including managing Access Control Lists (ACLs) for topics, subjects, and Schema Registry resources [1]. 2. Administrative Operations: Significant operations, such as operator upgrades in Kubernetes-based Redpanda deployments, involve rolling restarts of broker Pods. These are monitored as part of standard cluster lifecycle management, where maintenance mode and health checks are used to ensure safety [3]. 3. Shadowing and Synchronization: For advanced operations like migrating schemas from a Confluent Schema Registry using Shadowing (introduced in v26.2), progress and status can be monitored through dedicated synchronization status checks and specific monitoring metrics [4]. 4. CLI Management: The rpk utility is used for a wide range of configuration tasks, including setting up authentication (such as OAUTHBEARER/OIDC) for Kafka, Admin, and Schema Registry APIs [5]. For the most up-to-date and authoritative information on specific configuration steps, you should consult the official Redpanda Documentation site, which aggregates content across different versions and deployment types [6][7]. Documentation for Cloud-specific features is maintained alongside self-managed documentation, often using shared source files to ensure consistency [1][4].
Citations:
- 1: DOC-1732: Document managing Schema Registry ACLs in Console #1769
- 2: #2213 serverless launch LA #308
- 3: upgrade: document broker restarts during operator upgrades #1758
- 4: DOC-2254: Add Confluent Schema Registry schema migration via Shadowing #1776
- 5: 760db59
- 6: https://github.com/redpanda-data/docs
- 7: https://github.com/redpanda-data/docs/blob/main/local-antora-playbook.yml
🌐 Web query:
site:docs.redpanda.com "operation progress" "rpk"
💡 Result:
In the context of the Redpanda command-line tool rpk, there is no single generic command called operation progress. Instead, rpk provides specific status commands to monitor the progress of different long-running cluster operations. Depending on the task you are performing, you should use the corresponding status command: Broker Decommissioning: Use rpk redpanda admin brokers decommission-status [BROKER ID] to monitor the progress of a node being decommissioned [1][2]. You can use the --detailed (-d) flag to see granular progress metrics like bytes moved and remaining [1][3]. Cluster Configuration Changes: Use rpk cluster config status to list long-running configuration operations and check their status (e.g., Running, Completed, Failed) [4]. Mountable Topics: Use rpk cluster storage status-mount [MIGRATION-ID] to check the progress of a specific mount or unmount operation [5][6]. Partition Balancing: Use rpk cluster partitions balancer-status to see the status of the partition balancer, including the number of reassignments currently in progress [7]. Shadow Indexing/Shadow Links: Use rpk shadow status [LINK_NAME] to monitor the replication health and progress of shadow topics [8]. For many configuration-changing commands in rpk, an operation ID is returned upon initiation, which you can then use with the relevant status command to track progress [9][5][6].
Citations:
- 1: https://docs.redpanda.com/beta/reference/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status/
- 2: https://docs.redpanda.com/docs/reference/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status/
- 3: https://docs.redpanda.com/streaming/current/reference/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status/
- 4: https://docs.redpanda.com/redpanda-cloud/reference/rpk/rpk-cluster/rpk-cluster-config-status/
- 5: https://docs.redpanda.com/streaming/current/manage/mountable-topics/
- 6: https://docs.redpanda.com/docs/manage/mountable-topics/
- 7: https://docs.redpanda.com/docs/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status/
- 8: https://docs.redpanda.com/current/reference/rpk/rpk-shadow/rpk-shadow-status/
- 9: https://docs.redpanda.com/cloud-data-platform/reference/rpk/rpk-cluster/rpk-cluster-config-set/
🌐 Web query:
site:docs.redpanda.com "Cloud" "rpk cluster config status"
💡 Result:
To check the status of Redpanda cluster configuration changes, you use the rpk cluster config status command [1][2][3]. This command provides visibility into the configuration state of your cluster [1][3]. Its primary functions include: 1. Broker Configuration Sync: It displays the configuration version applied to each broker [1]. If a broker has a lower version number than others, it may be offline or out of sync with the latest configuration [1]. 2. Restart Requirements: It indicates whether a broker requires a restart to apply updated settings [1][3]. 3. Invalid/Unknown Settings: It flags any settings that a specific broker considers invalid or unrecognized [1][3]. 4. Operation Tracking: For long-running configuration changes (such as those requiring a rolling restart), it allows you to track the progress of these operations by listing their status (e.g., Running, Completed, or Failed) [2]. Usage: The basic command syntax is: rpk cluster config status [flags] Commonly used flags include: --config: Specifies the path to your Redpanda or rpk configuration file (e.g., rpk.yaml) [1][2]. --profile: Specifies the rpk profile to use, which is helpful for managing connection settings across different environments [1][2]. -v, --verbose: Enables verbose logging for more detailed output [1][2]. When you modify cluster properties using rpk cluster config set or rpk cluster config edit, changes are typically propagated immediately [4][5]. Using rpk cluster config status is the recommended way to verify that these changes have been successfully applied across all brokers and to identify any potential issues [5][3].
Citations:
- 1: https://docs.redpanda.com/streaming/current/reference/rpk/rpk-cluster/rpk-cluster-config-status/
- 2: https://docs.redpanda.com/redpanda-cloud/reference/rpk/rpk-cluster/rpk-cluster-config-status/
- 3: https://docs.redpanda.com/streaming/current/manage/cluster-maintenance/cluster-property-configuration/
- 4: https://docs.redpanda.com/redpanda-cloud/reference/rpk/rpk-cluster/rpk-cluster-config/
- 5: https://docs.redpanda.com/streaming/current/reference/rpk/rpk-cluster/rpk-cluster-config/
🌐 Web query:
site:github.com/redpanda-data/docs/pull "rpk-cluster-config-status" "Cloud"
💡 Result:
There is no rpk command named rpk cluster config status. Redpanda does not provide a command with that specific name or structure for retrieving the status of cluster configurations. To interact with cluster configurations or view cluster status, users typically employ other rpk commands depending on the specific goal: 1. Cluster Status and Health: To check the general health and status of your Redpanda cluster, you can use the rpk cluster commands, such as rpk cluster info or rpk cluster health. 2. Configuration Management: To manage or view cluster configuration properties, you typically use rpk cluster config commands, such as rpk cluster config get or rpk cluster config list. For Redpanda Cloud clusters, management and status monitoring are often handled via the Redpanda Console UI or cloud-specific management interfaces, rather than through rpk configuration status commands. Documentation notes that Redpanda Cloud features, such as Schema Registry authorization or migration tasks, are often managed through the Console or specific rpk subcommands tailored to those features.
Citations:
- 1: feat: add rpk documentation automation #1733
- 2: DOC-2254: Add Confluent Schema Registry schema migration via Shadowing #1776
- 3: upgrade: document broker restarts during operator upgrades #1758
- 4: Doc-1996: Schema Registry Contexts #1658
- 5: auto-docs: Update property docs for tag v26.1.11 #1771
🌐 Web query:
site:docs.redpanda.com/redpanda-cloud/reference/rpk/rpk-cluster/rpk-cluster-config-status "For each broker"
💡 Result:
For each broker, rpk cluster config status shows:
- Whether a restart is required to apply new settings.
- Any invalid or unknown settings.
- The applied cluster-configuration version, which should match across brokers. [1]
[1] (docs.redpanda.com)
Citations:
🌐 Web query:
site:docs.redpanda.com/redpanda-cloud/reference/rpk/rpk-cluster/rpk-cluster-config-status "operation"
💡 Result:
The page states that rpk cluster config status tracks long-running cluster configuration operations, with statuses:
- RUNNING — in progress
- COMPLETED
- FAILED
Use it to monitor rolling-restart configuration changes and view each operation’s ID, status, start time, and completion time. (docs.redpanda.com)
Citations:
🌐 Web query:
site:docs.redpanda.com/streaming/current/reference/rpk/rpk-cluster/rpk-cluster-config-status "For each broker"
💡 Result:
The phrase for each broker is commonly used in distributed systems and cluster management to describe operational tasks or reporting that must be performed individually for every node within a cluster [1]. In a technical context, such as managing streaming platforms or message brokers, performing an action for each broker typically involves: 1. Verification of configuration status: Checking whether individual brokers have applied the latest cluster settings or if they require a restart [1]. 2. Synchronization checks: Ensuring each broker is running the same configuration version as the rest of the cluster [1]. 3. Error reporting: Identifying settings flagged as invalid or unknown by a specific broker [1]. When a task is applied for each broker, it is often done to identify discrepancies, such as a broker being offline or out of sync, which may result in it holding an earlier configuration version than the cluster leader [1].
Citations:
🏁 Script executed:
#!/bin/bash
set -e
git ls-files modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adocRepository: redpanda-data/docs
Length of output: 1922
Use an environment-specific configuration-status description.
Self-hosted output lists per-broker restart, invalid-setting, and configuration-version details. Redpanda Cloud output lists long-running operation status and timestamps. Update the generation source so rpk-cluster-config-status.adoc and the matching row in rpk-cluster-config.adoc render the correct summary for each environment.
📍 Affects 2 files
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc#L2-L8(this comment)modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc#L82-L82
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc`
around lines 2 - 8, Update the generation source for the configuration-status
description to use environment-specific text: retain the per-broker restart,
invalid-setting, and configuration-version summary for self-hosted deployments,
and use the long-running-operation status and timestamp summary for Redpanda
Cloud. Apply the source change so both rpk-cluster-config-status.adoc and the
matching row in rpk-cluster-config.adoc render the appropriate description.
| :description: Upload license to the cluster You can either provide a path to a file containing the license: | ||
| :page-platforms: linux,darwin | ||
|
|
||
| // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc | ||
|
|
||
| // tag::single-source[] | ||
| :description: Upload license to the cluster. | ||
| :description: Upload license to the cluster You can either provide a path to a file containing the license: |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add sentence punctuation to both license summaries.
Both generated descriptions read Upload license to the cluster You can....
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc#L2-L8: add punctuation afterclusterin the source description.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc#L29-L29: regenerate the parent row from the corrected source description.
📍 Affects 2 files
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc#L2-L8(this comment)modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc#L29-L29
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc` around
lines 2 - 8, Update the description in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc at lines
2-8 to add sentence punctuation after “cluster” in both generated summary
entries. Regenerate the parent row in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc at line 29 from
the corrected source description.
| :description: pass:q[Disable partitions of a topic You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] | ||
| :page-platforms: linux,darwin | ||
|
|
||
| // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc | ||
|
|
||
| // tag::single-source[] | ||
| :description: pass:q[Disable partitions of a topic. You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag.] | ||
| :description: pass:q[Disable partitions of a topic You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -eu
printf '%s\n' '--- target files ---'
cat -n modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc | sed -n '1,18p'
cat -n modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc | sed -n '1,18p'
printf '%s\n' '--- shared template references ---'
rg -n -F '[partitions...]' . --glob '!modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc' --glob '!modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc' | head -80
printf '%s\n' '--- relevant source files ---'
rg -n -i 'disable partitions|enable partitions|partition flag accepts|namespace.*topic.*partitions' . --glob '!modules/reference/pages/**' | head -120Repository: redpanda-data/docs
Length of output: 1922
🏁 Script executed:
#!/bin/bash
set -eu
sed -n '1,18p' modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc
sed -n '1,18p' modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc
rg -n -i 'disable partitions|enable partitions|partition flag accepts|namespace.*topic.*partitions' . --glob '!modules/reference/pages/**' | head -120Repository: redpanda-data/docs
Length of output: 1922
🌐 Web query:
site:github.com/redpanda-data/docs "Partition flag accepts the format" "partitions..."
💡 Result:
The available technical documentation and provided search results do not contain a specific statement defining a universal format that a "partition" flag accepts across Redpanda rpk commands. While rpk commands often manage partitions, configuration and partition-related arguments are typically documented on a per-command basis within the Redpanda documentation. For example, cluster properties related to partitions (such as default replication factors) are managed via configuration parameters [1]. If you are encountering a specific rpk command with a partition flag, it is recommended to check the command-specific help documentation by running rpk [command] --help, or by consulting the official Redpanda documentation for the specific rpk command being used [2].
Citations:
- 1: fix: Missing an "s" in default_topic_replication #1657
- 2: feat: add rpk documentation automation #1733
🌐 Web query:
github redpanda-data docs rpk-cluster-partitions-disable.adoc
💡 Result:
The rpk cluster partitions disable command is used in Redpanda to prevent data production and consumption for specific partitions or an entire topic [1][2]. This functionality is typically employed to maintain cluster stability by isolating and disabling corrupted partitions that might otherwise cause the system to crash [1][3]. Key features and usage details include: Usage: The command follows this general syntax: rpk cluster partitions disable [TOPIC] [flags] [4][2] Available Flags: -a, --all: Disables all partitions for the specified topic [1][5]. -p, --partitions: Accepts a comma-separated list of specific partition IDs to disable [1][4]. When using the --partitions flag, the argument can follow the format {namespace}/{topic}/[partitions...]. If the namespace is omitted, it defaults to "kafka," and if the topic is omitted, it uses the topic provided as a positional argument [1][5]. Behavior: When a partition is disabled, all internal processes associated with it are stopped, and the partition remains unloaded during system startup [1][2]. While the data persists on disk, Redpanda ceases all interaction with the disabled partition to ensure system stability [1][2]. Recovery Context: This command can be used during normal operation if the issue is localized to a specific partition [3]. If a problematic partition prevents the cluster from starting, it may be necessary to use this command while the cluster is in recovery mode [3]. If disabled in recovery mode, the partition remains deactivated until explicitly re-enabled, even after restarting in non-recovery mode [3]. The source documentation for this command is maintained in the Redpanda documentation repository as rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc [1][6].
Citations:
- 1: https://docs.redpanda.com/current/reference/rpk/rpk-cluster/rpk-cluster-partitions-disable/
- 2: https://docs.redpanda.com/streaming/current/reference/rpk/rpk-cluster/rpk-cluster-partitions-disable/
- 3: https://docs.redpanda.com/25.3/manage/recovery-mode/
- 4: https://docs.redpanda.com/docs/reference/rpk/rpk-cluster/rpk-cluster-partitions-disable/
- 5: https://docs.redpanda.com/docs/platform/reference/rpk/rpk-cluster/rpk-cluster-partitions-disable/
- 6: https://docs.redpanda.com/docs/rpk/rpk-cluster/rpk-cluster-partitions-disable/
🏁 Script executed:
#!/bin/bash
set -eu
for url in \
'https://raw.githubusercontent.com/redpanda-data/docs/main/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc' \
'https://raw.githubusercontent.com/redpanda-data/docs/main/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc'; do
echo "--- $url ---"
curl -L --fail --silent --show-error "$url" | sed -n '1,18p' || true
doneRepository: redpanda-data/docs
Length of output: 1922
🌐 Web query:
Asciidoctor pass:q square brackets escape closing bracket nested inline macro
💡 Result:
To include a closing square bracket (]) inside the content of an Asciidoctor pass macro (such as pass:q[...]), you must escape the bracket using a backslash (]) [1][2]. When nesting content that contains square brackets within a pass macro, Asciidoctor's parser interprets the first unescaped closing square bracket it encounters as the end of the macro [2]. By using ] to escape the bracket, you inform the processor that the character should be treated as literal text rather than the macro's closing delimiter [1][2]. For example, to display nested brackets correctly within a pass macro, write: pass:q[Example containing a nested bracket: [inner text]] Alternative approaches for handling square brackets include: - Using attribute references: You can use the built-in attributes {startsb} for [ and {endsb} for ] to avoid using the characters themselves [2]. - Using different delimiters: If possible, you may also use alternative inline passthrough delimiters (like +++...+++ or ++...++), though these do not support substitution control (like the q in pass:q) in the same way the macro does [3][4]. If you are using the pass macro inside code blocks or monospace formatting (e.g., pass:q[...]), remember that backticks often override how inner characters are rendered depending on the backend [2]. In such cases, escaping the bracket within the pass macro remains the most reliable method for passing the content through correctly [1][2].
Citations:
- 1: Escape (generated) text inside pass asciidoctor/asciidoctor#3485
- 2: https://stackoverflow.com/questions/79943520/monospaced-literal-text-with-square-brackets-in-asciidoc
- 3: https://docs.asciidoctor.org/asciidoc/latest/pass/pass-macro/
- 4: https://docs.asciidoctor.org/asciidoc/latest/pass/
🌐 Web query:
Asciidoctor attribute entry pass:q literal square brackets escaping
💡 Result:
To use literal square brackets within an Asciidoctor pass macro (such as pass:q[...]) while defining an attribute entry, you must escape the closing square bracket (]) to prevent the parser from prematurely terminating the macro [1][2]. You can escape a closing square bracket using a backslash (\]) or, in some contexts, a character reference [1][2]. When defining an attribute entry that requires specific substitutions (like quotes q or attributes a), use the inline pass macro to control the substitution behavior at the time of definition [3][4]. Example of escaping a bracket within a pass macro in an attribute entry::my-attr: pass:q[This contains a literal closing bracket: ]] If your content contains multiple characters that might trigger unwanted substitutions or parsing issues, the pass macro is the primary mechanism to pass content through to the output as-is, with specific granular control provided by the comma-separated substitution types (e.g., pass:q,a[...]) [5][6]. Note that backslashes used to escape characters in AsciiDoc can sometimes behave differently depending on the nesting and the specific substitution steps being applied; however, \] is the standard approach for literal closing brackets within these macros [1][2].
Citations:
- 1: https://docs.asciidoctor.org/asciidoc/latest/attributes/positional-and-named-attributes/
- 2: Escape (generated) text inside pass asciidoctor/asciidoctor#3485
- 3: https://docs.asciidoctor.org/asciidoc/latest/attributes/attribute-entry-substitutions/
- 4: https://discuss.asciidoctor.org/Text-formatting-embedded-in-attribute-value-td1322.html
- 5: https://docs.asciidoctor.org/asciidoc/latest/pass/pass-macro/
- 6: https://docs.asciidoctor.org/asciidoc/latest/subs/prevent/
Update the shared partition-description template.
Escape the inner closing bracket as [partitions...\] and add a period after topic in both descriptions. Regenerate both pages.
📍 Affects 2 files
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc#L2-L8(this comment)modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc#L2-L8
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc`
around lines 2 - 8, Update the shared partition-description template to add a
period after “topic” and escape the inner closing bracket as “[partitions...\]”;
regenerate both affected descriptions in
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc:2-8
and
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc:2-8.
| :description: List partitions in the cluster This commands lists the cluster-level metadata of all partitions in the cluster. It shows the current replica assignments on both brokers and CPU cores for given topics. | ||
| :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions-list.adoc | ||
| :page-platforms: linux,darwin | ||
|
|
||
| // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc | ||
|
|
||
| // tag::single-source[] | ||
| :description: List partitions in the cluster. This commands lists the cluster-level metadata of all partitions in the cluster. | ||
| :description: List partitions in the cluster This commands lists the cluster-level metadata of all partitions in the cluster. It shows the current replica assignments on both brokers and CPU cores for given topics. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Correct the generated partition-list description.
The text has no sentence boundary after cluster and uses This commands lists. Use This command lists... and keep both description declarations identical in the source override.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc`
around lines 2 - 9, Update the partition-list description in the source override
to use “This command lists...” with a sentence boundary after “cluster,” then
regenerate the page so both visible :description declarations match exactly.
| :description: View logs for a transform. transform_logs. | ||
| :page-platforms: linux,darwin | ||
|
|
||
| // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc | ||
|
|
||
| // tag::single-source[] | ||
| :description: pass:q[View logs for a transform. Data transform's STDOUT and STDERR are captured during runtime and written to an internally managed topic `_redpanda.transform_logs`.] | ||
| :description: View logs for a transform. transform_logs. | ||
| View logs for a transform. | ||
|
|
||
| Data transform's STDOUT and STDERR are captured during runtime and written to | ||
| an internally managed topic `_redpanda.transform_logs`. | ||
| an internally managed topic _redpanda.transform_logs. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Preserve the full transform log topic identifier.
The metadata says transform_logs instead of _redpanda.transform_logs. The body also removes inline-code formatting. Keep the full topic name and render it as `_redpanda.transform_logs` in the source override and page content.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc` around
lines 2 - 12, Update the transform log description metadata and body content to
use the full topic identifier `_redpanda.transform_logs`, preserving inline-code
formatting around the topic name in the rendered text.
|
|
||
| |xref:reference:rpk/rpk-transform/rpk-transform-logs.adoc[`rpk transform logs`] | ||
| |View logs for a transform. Data transform's STDOUT and STDERR are captured during runtime and written to an internally managed topic `_redpanda.transform_logs`. | ||
| |View logs for a transform. transform_logs. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Restore a complete description for rpk transform logs.
The new text ends with the unexplained fragment transform_logs.. Restore the explanation that runtime STDOUT and STDERR are stored in the internal _redpanda.transform_logs topic.
Proposed fix
-|View logs for a transform. transform_logs.
+|View logs for a transform. Runtime `STDOUT` and `STDERR` are stored in the internal `_redpanda.transform_logs` topic.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| |View logs for a transform. transform_logs. | |
| |View logs for a transform. Runtime `STDOUT` and `STDERR` are stored in the internal `_redpanda.transform_logs` topic. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc` at line 49,
Update the `rpk transform logs` documentation entry to replace the fragment
“transform_logs.” with a complete explanation that runtime STDOUT and STDERR are
stored in the internal `_redpanda.transform_logs` topic.
| This command installs the latest version by default. | ||
|
|
||
| Alternatively, you may specify an `rpk ai version` using the `--ai-version` flag. | ||
| Alternatively, you may specify an `rpk` ai version using the `--ai-version` flag. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use the complete command name in the version reference.
Line 13 mixes code formatting and plain text in an \rpk` ai version. Use an `rpk ai` versionoran AI CLI version` to identify the command clearly.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/partials/rpk-ai/rpk-ai-install.adoc` at line 13, Update the
version-reference sentence to identify the complete command as “rpk ai” rather
than separately formatting only “rpk”; preserve the existing --ai-version flag
guidance.
| :description: Install the BYOC plugin This command downloads the BYOC managed plugin if necessary. The plugin is installed by default if you try to run a non-install command, but this command exists if you want to download the plugin ahead of time. | ||
| :page-platforms: linux,darwin | ||
|
|
||
| // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc | ||
|
|
||
| // tag::single-source[] | ||
| :description: Install the BYOC plugin. This command downloads the BYOC managed plugin if necessary. | ||
| :description: Install the BYOC plugin This command downloads the BYOC managed plugin if necessary. The plugin is installed by default if you try to run a non-install command, but this command exists if you want to download the plugin ahead of time. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix sentence boundaries in the generated command descriptions.
The changed descriptions concatenate a summary with the next sentence without a period. Update the source override or generator input, then regenerate the pages.
modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc#L2-L8: add a period afterplugin.modules/reference/partials/rpk-cloud/rpk-cloud-byoc-uninstall.adoc#L2-L8: add a period afterplugin.modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc#L2-L8: add a period afteragent.modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc#L34-L37: add periods after both subcommand summaries.modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc#L2-L8: add a period afterCloud.modules/reference/partials/rpk-cloud/rpk-cloud-logout.adoc#L2-L8: add a period afterCloud.modules/reference/partials/rpk-cloud/rpk-cloud.adoc#L28-L37: add periods after the BYOC, login, and logout summaries.
📍 Affects 6 files
modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc#L2-L8(this comment)modules/reference/partials/rpk-cloud/rpk-cloud-byoc-uninstall.adoc#L2-L8modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc#L2-L8modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc#L34-L37modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc#L2-L8modules/reference/partials/rpk-cloud/rpk-cloud-logout.adoc#L2-L8modules/reference/partials/rpk-cloud/rpk-cloud.adoc#L28-L37
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc` around
lines 2 - 8, Update the source override or generator input for the affected RPK
Cloud command descriptions, adding sentence-ending periods after the specified
summary terms in
modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc:2-8,
rpk-cloud-byoc-uninstall.adoc:2-8, rpk-cloud-byoc.adoc:2-8 and 34-37,
rpk-cloud-login.adoc:2-8, rpk-cloud-logout.adoc:2-8, and rpk-cloud.adoc:28-37;
then regenerate the generated pages.
| @@ -1,11 +1,11 @@ | |||
| = rpk cloud login | |||
| :description: Log in to the Redpanda Cloud. This command checks for an existing Redpanda Cloud API token and, if present, ensures it is still valid. | |||
| :description: Log in to the Redpanda Cloud This command checks for an existing Redpanda Cloud API token and, if present, ensures it is still valid. If no token is found or the token is no longer valid, this command will login and save your token along with the client ID used to request the token. | |||
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use log in as the verb form.
Change this command will login to this command will log in in the source override before regeneration.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc` at line 2, Update
the description text in the source override so the phrase “this command will
login” uses the verb form “this command will log in,” preserving the rest of the
description unchanged.
8be0cfd to
7bebc57
Compare
1 participant
Summary
Automated update of a single rpk plugin's documentation, triggered by a plugin release.
Plugin:
rpk aiReleased version:
0.2.33Only the
rpk aisubtree was refreshed in the rpk snapshot. All other pages were re-rendered from the committed snapshot and should show no changes. If a later release supersedes this one before merge, this PR updates in place.rpk ai Plugin Documentation Update
Plugin version: 0.2.33
Base rpk snapshot: v26.2.1
The
rpk aisubtree was refreshed in the snapshot, then the full rpk reference was re-rendered from it as a converge. Pages outsiderpk aican carry template-level or consistency updates, and stale generated files are cleaned up, so the change list may be wider than the plugin itself.Generation Statistics
Changes from Previous Version
New Flags
rpk ai llm-provider create:--tags(stringArray)rpk ai llm-provider update:--tags(stringArray)rpk ai mcp-server create:--tags(stringArray)rpk ai mcp-server update:--tags(stringArray)rpk ai oauth-client create:--tags(stringArray)rpk ai oauth-client update:--tags(stringArray)rpk ai oauth-provider create:--tags(stringArray)rpk ai oauth-provider update:--tags(stringArray)Curated descriptions replacing source help
These overrides replace substantially longer help text from the rpk source. Confirm the curated version still carries every operational detail (or intentionally omits it):
rpk topic consumerpk topic producerpk security aclrpk debug bundlerpk group deleterpk cluster configrpk topic describeValidation Report
Issues by Rule
Generated by rpk-docs automation
Automation
Generated by rpk-docs automation.
Review the changes and merge when ready.