docs: re-render rpk docs for overrides change (main) - #1875
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 documentation update expands RPK command descriptions, examples, flag details, exit-code behavior, and version annotations. It adds Estimated code review effort: 3 (Moderate) | ~25 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: 2
Note
Due to the large number of review comments, Critical, Major severity comments were prioritized as inline comments.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc (1)
26-35: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winKeep one valid Admin API troubleshooting instruction.
The paragraph at Lines 26-27 is shown in every build, uses unclear
admin.hosts=comma,delimited,host:portssyntax, and repeats the non-cloud guidance at Lines 33-35. Keep one conditional copy and use the documented-X admin.hosts=<host:ports>form.🤖 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-generate/rpk-generate-app.adoc` around lines 26 - 35, Remove the unconditional Admin API troubleshooting paragraph before the conditional blocks, preserving the single conditional copy in the `ifndef::env-cloud[]` section. Keep its documented `xref` and `-X admin.hosts=<host:ports>` syntax, while retaining the cloud-specific note unchanged.
🟡 Minor comments (40)
modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc-2-12 (1)
2-12: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winKeep SASL user management separate from ACL management.
Both descriptions assign SASL user creation to
rpk security acl, but that command exposes ACL operations only.
modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc#L2-L12: remove SASL user creation from the page description and introduction.modules/reference/pages/rpk/rpk-security/rpk-security.adoc#L32-L32: remove SASL user creation from therpk security aclsubcommand description.🤖 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-security/rpk-security-acl.adoc` around lines 2 - 12, Remove SASL user creation references from the description and introduction in modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc (lines 2-12), keeping the page focused on ACL operations. Also remove the SASL user creation wording from the rpk security acl subcommand description in modules/reference/pages/rpk/rpk-security/rpk-security.adoc (line 32); retain SASL user management only under rpk security user.modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc-20-20 (1)
20-20: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winFix the PS1 example before publishing.
Use
PS1='$(rpk profile prompt)'and wrap the complete shell example in AsciiDoc backticks. The current form invokesrpkwithout arguments and then attempts to execute its output. Update the generator input instead of the generated page.🤖 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-profile/rpk-profile-prompt.adoc` at line 20, Update the generator input that produces the rpk profile prompt documentation so the PS1 example uses $(rpk profile prompt) with the correct arguments, and wrap the complete shell command in AsciiDoc backticks. Do not edit only the generated page; change the source template or generator responsible for this content.modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc-14-24 (1)
14-24: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winUse valid
rpk profile setsyntax in the examples.
rpk profile setaccepts[KEY=VALUE]+arguments and has no--setflag. Userpk profile set tls.enabled=trueandrpk profile set kafka_api.tls.enabled=true. Keepset key valueas the documented single-key syntax, not as a standalone command. Update the source description and regenerate this autogenerated file.🤖 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-profile/rpk-profile-set.adoc` around lines 14 - 24, Update the source documentation for the rpk profile set examples to use `rpk profile set tls.enabled=true` and `rpk profile set kafka_api.tls.enabled=true`, removing the unsupported `--set` syntax. Clarify that `set key value` is an argument format for setting one key, then regenerate the autogenerated `rpk-profile-set.adoc` file.modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc-20-26 (1)
20-26: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winRemove the period from the file example.
topic_b 0.makes the period part of the partition value when users copy the block. Usetopic_b 0and place sentence punctuation outside the code block.🤖 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-group/rpk-group-offset-delete.adoc` around lines 20 - 26, Update the example in the offset-delete documentation so the final tuple is exactly “topic_b 0” without a trailing period, and place any sentence punctuation outside the example block.modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc-15-18 (1)
15-18: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winShow mutually exclusive options as alternatives.
The new prose correctly identifies mutually exclusive options, but the generated usage forms present them together. This can lead users to copy invalid commands.
modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc#L15-L18: update the usage block at Line 32 to show either--from-fileor--topic.modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc#L43-L45: update the usage block at Line 51 to show one of--to,--to-group, or--to-file.🤖 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-group/rpk-group-offset-delete.adoc` around lines 15 - 18, Update the usage block in modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc at lines 15-18 to present --from-file and --topic as alternative mutually exclusive forms. Update the usage block in modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc at lines 43-45 to present --to, --to-group, and --to-file as alternatives rather than combined options.modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc-11-17 (1)
11-17: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winUse the valid
--verboseflag spelling.Line 14 contains
–verbosewith an en dash. Users who copy it will not pass the--verboseflag. Replace it with two ASCII hyphens.Proposed fix
-run with –verbose for more info if it is missing. +run with --verbose for more info if it is missing.🤖 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-group/rpk-group-describe.adoc` around lines 11 - 17, In the command description paragraph, replace the en-dash-prefixed “verbose” option with the valid ASCII `--verbose` spelling, preserving the surrounding guidance unchanged.modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc-28-39 (1)
28-39: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix the malformed generated descriptions.
The Grafana description joins two sentences without punctuation. The license description contains
com/contactas a broken fragment. Correct the override text before regenerating the page.Suggested wording fix
-|Generate Grafana Dashboards for Redpanda Metrics Use this command to generate sample Grafana dashboards for Redpanda metrics. +|Generate Grafana dashboards for Redpanda metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics. ... -|Generate a trial license This command generates a license for a 30-day trial of Redpanda Enterprise Edition. com/contact The license is saved +|Generate a trial license. This command generates a license for a 30-day trial of Redpanda Enterprise Edition. The license is saved🤖 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-generate/rpk-generate.adoc` around lines 28 - 39, Correct the generated description overrides for the Grafana dashboard and license entries in the rpk-generate reference: add punctuation between the Grafana sentences and remove the stray “com/contact” fragment from the license description. Update the source override text used to generate these entries, preserving the existing command links and surrounding content.modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc-15-19 (1)
15-19: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winPrefix timestamp examples with
@.The bare numeric values are offset arguments, not timestamps. Update all three timestamp examples to use
--to @....🤖 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-group/rpk-group-seek.adoc` around lines 15 - 19, Update all three timestamp examples in the rpk-group-seek documentation to prefix each value with @ when used with --to, while leaving offset examples and the surrounding option descriptions unchanged.modules/reference/pages/rpk/rpk-connect/rpk-connect-list.adoc-11-14 (1)
11-14: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winList
jsonschemain the format description.The command supports
text,json,jsonschema, andcue. Update theformatoverride indocs-data/rpk-overrides.jsonbecause this page is autogenerated.🤖 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-connect/rpk-connect-list.adoc` around lines 11 - 14, Update the format description for the rpk connect list documentation and the corresponding format override in docs-data/rpk-overrides.json to explicitly include jsonschema alongside text, json, and cue. Preserve the autogenerated page structure and existing component-selection behavior.modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc-2-8 (1)
2-8: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winSeparate the page title from the description.
The
:description:value readsGenerate Grafana Dashboards for Redpanda Metrics Use...without punctuation between the sentences. Add a period afterMetricsin both description attributes.🤖 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-generate/rpk-generate-grafana-dashboard.adoc` around lines 2 - 8, Add a period after “Metrics” in both :description: attributes in the autogenerated Grafana dashboard reference content, keeping the remainder of each description unchanged.modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc-19-19 (1)
19-19: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winList all supported languages.
Line 19 says that only
gois available, but the flag table at Line 78 listsgo,python,java,js, andrust. Update the sentence to match the supported--languagevalues.🤖 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-generate/rpk-generate-app.adoc` at line 19, Update the --language description in the rpk-generate documentation to list all supported values: go, python, java, js, and rust, while retaining go as the default.modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc-3-9 (1)
3-9: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix the generated page description.
Both
:description:attributes containcom/contactinstead of a usable contact link, and the sentences run together. This produces incorrect page metadata. Remove the URL from the attribute or encode it correctly, and keep the full contact link in the body at Line 15.🤖 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-generate/rpk-generate-license.adoc` around lines 3 - 9, Update both :description: attributes in the generated RPK license page to remove the malformed “com/contact” fragment and separate the sentences with appropriate spacing. Preserve the full contact link in the page body at the existing contact section, and keep both description values consistent.modules/reference/pages/rpk/rpk-connect/rpk-connect-template.adoc-11-13 (1)
11-13: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winRemove duplicate generated guidance.
The refresh adds a second copy of existing guidance instead of replacing the original. Keep one authoritative copy in each page.
modules/reference/pages/rpk/rpk-connect/rpk-connect-template.adoc#L11-L13: remove either theWARNINGorIMPORTANTblock; retain one experimental-template admonition.modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc#L22-L33: remove the new dashboard download and legacy-dashboard paragraphs or remove their existing copies at Lines 83-85.🤖 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-connect/rpk-connect-template.adoc` around lines 11 - 13, Remove one duplicate experimental-template admonition from rpk-connect-template.adoc, retaining a single authoritative block. In rpk-generate-grafana-dashboard.adoc, remove either the newly added dashboard-download and legacy-dashboard paragraphs or their existing copies at lines 83-85, so each piece of guidance appears only once.modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc-2-9 (1)
2-9: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winUse one complete transform-log description across both pages.
The generated child-page description and parent subcommand description expose the literal
transform_logstext instead of a useful explanation.
modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc#L2-L9: replace both descriptions with a complete user-facing sentence.modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc#L49-L49: use the same corrected description in the subcommand table.🤖 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 - 9, Replace both description entries in modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc (lines 2-9) with one complete user-facing transform-log sentence, then update the subcommand table description in modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc (line 49) to use the identical wording.modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc-11-14 (1)
11-14: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix the sentence grammar.
Change
and printing them to STDOUTtoand prints them to STDOUT.🤖 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 11 - 14, In the transform log command description, update the phrase “and printing them to STDOUT” to “and prints them to STDOUT” to correct the sentence grammar.modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc-60-60 (1)
60-60: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winSeparate the two sentences.
Change
Trim records from topics This commandtoTrim records from topics. This command.🤖 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-topic/rpk-topic.adoc` at line 60, Update the introductory text near “Trim records from topics” to end the heading sentence with a period, so it reads “Trim records from topics. This command” while preserving the remaining documentation unchanged.modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc-50-50 (1)
50-50: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDocument all four storage sections.
The description says the output has four sections but explains only
SUMMARY. Add the other three sections, or remove the count. Also changeThis commands printstoThis command prints.🤖 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-topic/rpk-topic.adoc` at line 50, Update the description of the topic storage status command to use “This command prints” and either document all four output sections, including the three currently missing sections, or remove the claim that the information is divided into four sections.modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc-23-23 (1)
23-23: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix the punctuation typo.
Change
For example,.toFor example,before the table.🤖 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-topic/rpk-topic-delete.adoc` at line 23, In the introductory text before the table, remove the extra period after the comma so the sentence reads “For example,”.modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc-60-64 (1)
60-64: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winCorrect the timestamp example wording.
Use
before a specific timestamp, notprevious to an specific timestamp.🤖 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-topic/rpk-topic-trim-prefix.adoc` around lines 60 - 64, Update the wording in the trim-prefix example description to say “before a specific timestamp” instead of “previous to an specific timestamp,” leaving the command and surrounding documentation unchanged.modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc-9-26 (1)
9-26: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winRemove the duplicated introduction.
The new paragraphs at Line 11 through Line 26 repeat the existing content at Line 28 through Line 34. Keep one copy in the override or generator source, then regenerate the page.
🤖 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-topic/rpk-topic-list.adoc` around lines 9 - 26, Remove the duplicated topic-list introduction, retaining a single copy in the appropriate override or generator source. Regenerate the rpk topic list page and verify the resulting documentation contains the introduction only once.modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc-82-103 (1)
82-103: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winAlign the unpack example with the new modifier table.
The table defines
ias signedint32, but the example at Line 199 describesis$as a little-endianuint32. If the example intends little-endianuint32, use an explicit little-endian marker and uppercaseI, such asunpack[<Is$]. Otherwise, correct the example text.🤖 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-topic/rpk-topic-consume.adoc` around lines 82 - 103, Update the unpack example describing “is$” so it matches the modifier table: if it represents little-endian uint32, change the format to explicitly use little endian and uppercase I, such as unpack[<Is$]; otherwise revise the description to signed int32 and preserve the existing format.modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc-12-13 (1)
12-13: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winAlign the introduction with the page description.
The page description says “topic storage status”, but the introduction says “cloud storage status” even though the following sections cover local disk and cloud data. It also says “This commands”. Use consistent scope and change it to “This command”.
🤖 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-topic/rpk-topic-describe-storage.adoc` around lines 12 - 13, Update the introductory text for the rpk topic describe storage page to consistently describe the topic’s storage status, covering both local disk and cloud data rather than only cloud storage. Correct the grammar by changing “This commands” to “This command,” while preserving the existing section overview.modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc-2-2 (1)
2-2: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winRewrite the command description as a valid sentence.
The description is missing punctuation after
topicsand containsto trim the topics Redpanda sets..., which is not grammatical. State the operation once and explain that Redpanda setsLogStartOffsetto the requested offset.Also applies to: 8-16
🤖 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-topic/rpk-topic-trim-prefix.adoc` at line 2, Rewrite the `:description:` value for the rpk topic trim command as a grammatically complete sentence: state that the command trims records from topics, then explain that Redpanda sets each partition’s `LogStartOffset` to the requested offset while preserving the existing segment-deletion and unreadable-record behavior.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc-2-21 (1)
2-21: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix the shared generated description.
The same malformed description is emitted in both locations. Add the period after
cluster, changeThis commandstoThis command, and changereplicas assignmentstoreplica assignments. The published reference uses the corrected wording. (docs.redpanda.com)
- modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc#L2-L21: update the page description and body text at the source override, then regenerate.
- modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc#L39-L39: regenerate the subcommand summary from the corrected description.
🤖 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 - 21, Correct the shared generated description in modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc: add the period after “cluster,” change “This commands” to “This command,” and change “replicas assignments” to “replica assignments” in both the page description and body, then regenerate. The regenerated summary in modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc at lines 39-39 requires no direct change.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adoc-36-38 (1)
36-38: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix the core-assignment sentence.
The sentence says
assignafter a singular subject. It also usesnodewhile the surrounding text usesbroker. Useassignsandbrokerfor consistent guidance. The reference wording uses this terminology. (docs.redpanda.com)Proposed fix
-The command does not change a `core` assignment unless it is explicitly -specified. When a core is not specified for a new node, the command randomly -picks a core and assign a replica on the core. +The command does not change a `core` assignment unless it is explicitly +specified. When a core is not specified for a new broker, the command randomly +picks a core and assigns a replica to the core.🤖 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-move.adoc` around lines 36 - 38, Update the core-assignment sentence in the partition move documentation to use “assigns” with the singular command subject and replace “new node” with “new broker” for terminology consistency.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc-34-45 (1)
34-45: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winRemove the duplicate
Enabled/disabledsubsection.Lines 23-25 already document this behavior. Lines 34-45 repeat the same content and create duplicate documentation. The published reference renders one section. (docs.redpanda.com)
Proposed fix
-=== Enabled/disabled - -Disabling a partition in Redpanda involves prohibiting any data consumption or -production to and from it. All internal processes associated with the partition -are stopped, and it remains unloaded during system startup. This measure aims to -maintain cluster health by preventing issues caused by specific corrupted -partitions that may lead to Redpanda crashes. Although the data remains stored -on disk, Redpanda ceases interaction with the disabled partitions to ensure -system stability. - -You may disable/enable partition using `rpk cluster partitions enable/disable`.🤖 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 34 - 45, Remove the duplicate “Enabled/disabled” subsection from the partition list documentation, including its heading, explanatory text, and command sentence; retain the existing earlier subsection that documents the same behavior.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc-1-1 (1)
1-1: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winGuard all broker and partition child pages in Cloud builds.
modules/ROOT/nav.adoclists these child pages independently, and they have noenv-cloudguards. Add matching guards to each child page or filter these navigation entries.🤖 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-brokers.adoc` at line 1, Guard both child pages, modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc lines 1-1 and modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc lines 1-1, with matching env-cloud conditionals so broker and partition pages are excluded from Cloud builds; update the corresponding entries in modules/ROOT/nav.adoc instead only if filtering navigation is the chosen approach.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc-2-2 (1)
2-2: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winComplete the page description.
Both description attributes end with
operation that: 1.. This creates incomplete page metadata and an incomplete command summary. Replace the description with a complete sentence.Also applies to: 8-8
🤖 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-storage-unmount.adoc` at line 2, Replace the incomplete :description: metadata in the rpk-cluster-storage-unmount page with a complete, self-contained sentence; remove the trailing “operation that: 1.” fragment while preserving the command’s unmount and Tiered Storage purpose.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc-20-20 (1)
20-20: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix the throughput-test sentence.
Line 20 says
Uses a larger request message sizes. UseUses larger request message sizes and a deeper I/O queue depth.🤖 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-self-test-start.adoc` at line 20, Update the throughput-test sentence in the self-test documentation to use “Uses larger request message sizes and a deeper I/O queue depth,” preserving the remainder of the sentence unchanged.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc-29-31 (1)
29-31: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winRemove the duplicate schema and confirmation text.
The added block repeats the schema statement from Line 11. The
--no-confirminstruction is also repeated on Line 72. Keep one schema explanation and one confirmation instruction. This removes the duplicate-content validation warning.🤖 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-quotas-import.adoc` around lines 29 - 31, In the documentation for the quotas import command, remove the duplicated schema statement and repeated --no-confirm confirmation instruction, preserving the existing single instance of each elsewhere in the page.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc-2-8 (1)
2-8: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winAdd the cloud guard to all self-test subcommand pages.
Cloud navigation links directly to the
start,status, andstoppages. Addifndef::env-cloud[]andendif::[]to each page.🤖 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-self-test-start.adoc` around lines 2 - 8, Add the `ifndef::env-cloud[]` guard before the self-test page content and the matching `endif::[]` after it in the `rpk-cluster-self-test-start` source, preserving the autogenerated markers and applying the same guard structure to the related `start`, `status`, and `stop` subcommand pages.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc-15-49 (1)
15-49: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winRender benchmark details as AsciiDoc lists.
The disk, network, and cloud-operation entries are inside
[,text]listing blocks. AsciiDoc treats**and***as literal text inside these blocks. Move the entries outside the listing blocks so the rendered page shows the intended hierarchy.🤖 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-self-test-start.adoc` around lines 15 - 49, Convert the Disk tests, Network tests, and Cloud storage tests entries in the rpk-cluster-self-test documentation from `[,text]` blocks into native AsciiDoc nested lists. Remove the listing fences around the `**` and `***` entries while preserving their existing hierarchy and wording, including the cloud storage operation sublist.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc-48-50 (1)
48-50: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winComplete the
rpk cluster storage unmountdescription.Line [49] ends with
1.and the table closes without the remaining operation details. The published page will show a dangling list marker and omit the unmount behavior. Restore the complete generated description or replace it with a complete sentence.🤖 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-storage.adoc` around lines 48 - 50, Complete the description in the rpk cluster storage unmount table entry by removing the dangling “1.” and restoring the full generated operation details, or replace it with a complete sentence that accurately describes the unmount behavior.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc-16-18 (1)
16-18: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winKeep all health conditions at one list level.
Lines [17-18] add leading spaces before the list markers. This can render the last two conditions as nested or literal content instead of three sibling conditions. Remove the leading spaces.
Proposed fix
* All cluster nodes are responding - * All partitions have leaders - * The cluster controller is present +* All partitions have leaders +* The cluster controller is present🤖 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-health.adoc` around lines 16 - 18, Update the health-conditions list in the rpk cluster health documentation so “All partitions have leaders” and “The cluster controller is present” use the same list indentation as “All cluster nodes are responding.” Remove their leading spaces while preserving the existing text and list structure.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc-15-46 (1)
15-46: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winRemove the duplicated maintenance-status content.
The new block duplicates the existing output example, field descriptions, and notes at lines 48-73. The first output block is also an AsciiDoc table, so it can render as a second misleading table.
Remove one block from the generation source. Keep one output example, one field table, and one notes section.
🤖 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-maintenance-status.adoc` around lines 15 - 46, Remove the duplicated maintenance-status output example, field descriptions, and notes block from the documentation source, retaining the existing equivalent block later in the file. Ensure the rendered document contains one AsciiDoc output table, one set of field descriptions, and one notes section.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc-3-3 (1)
3-3: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winUse
shut downas the verb.The descriptions use
shutdownas a verb. Replace it withshut down.Proposed fix
-:description: ... may be shutdown or restarted ... +:description: ... may be shut down or restarted ... ... -:description: ... may be shutdown or restarted ... +:description: ... may be shut down or restarted ... ... -may be shutdown or restarted with minimal disruption +may be shut down or restarted with minimal disruptionAlso applies to: 9-13
🤖 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-maintenance.adoc` at line 3, Update the maintenance-mode description to use “shut down” as the verb wherever the text currently says “shutdown,” including the referenced lines, while preserving “shutdown” only where it functions as a noun or adjective.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc-29-29 (1)
29-29: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix the generated license description at its source.
The same description is emitted as
Upload license to the cluster You can either.... This is a malformed sentence and exposes usage details in the short description.
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc#L29-L29: use a concise subcommand summary such asUpload license to the cluster.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc#L2-L8: update both:description:values and keep the detailed alternatives in the body.🤖 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.adoc` at line 29, Update the generated license descriptions at both affected sites: in modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc:29-29, use the concise summary “Upload license to the cluster.”; in modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc:2-8, update both :description: values to the same concise summary while preserving the detailed usage alternatives in the body.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc-18-20 (1)
18-20: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix the partition-path sentence.
The text contains
the theand ends within.. Rewrite it as a complete sentence.Proposed fix
-The directory returned is the root directory for partitions. Within Redpanda, -the partition data lives underneath the the returned root directory in. +The returned directory is the root directory for partitions. Within Redpanda, +partition data is stored under the returned root directory:🤖 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-logdirs-describe.adoc` around lines 18 - 20, Update the partition-path sentence in the RPK cluster log directory description to remove the duplicated “the” and rewrite the ending so it forms a complete, grammatically correct sentence.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc-22-22 (1)
22-22: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winMake the inline-license example shell-safe.
In a
bashblock,<license string>is parsed as shell syntax, not as one argument. Use a placeholder without spaces, or quote the placeholder.Proposed fix
-rpk cluster license set <license string> +rpk cluster license set "<license-string>"🤖 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` at line 22, Update the inline-license example for the rpk cluster license set command to make the license placeholder a single shell argument by either removing its spaces or quoting the placeholder.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-list.adoc-20-20 (1)
20-20: 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick winSet
selfHostedOnlyindocs-data/rpk-overrides.jsonfor all five commands.This generates the required
env-cloudguards for each child page and parent table row:
rpk cluster license setrpk cluster loggers listrpk cluster loggers setrpk cluster maintenance enablerpk cluster maintenance status🤖 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-loggers-list.adoc` at line 20, Set selfHostedOnly in docs-data/rpk-overrides.json for all five commands: modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-list.adoc (20-20), rpk-cluster-license-set.adoc (2-2), rpk-cluster-loggers-set.adoc (29-29), rpk-cluster-maintenance-enable.adoc (2-2), and rpk-cluster-maintenance-status.adoc (2-2), so the generated child pages and parent table rows receive the required env-cloud guards.
🧹 Nitpick comments (2)
modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc (1)
12-12: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep xref labels synchronized with target titles.
Both changed links hard-code display text. Use empty xref brackets when the target title is the intended label.
modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc#L12-L12: usexref:reference:rpk/rpk-security/rpk-security-user.adoc[].modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc#L21-L21: usexref:manage:security/authorization/acl.adoc[].Based on learnings, use empty xref brackets when no alternate display text is required.
🤖 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-security/rpk-security-acl.adoc` at line 12, Replace the explicit label in the xref on modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc lines 12-12 with empty xref brackets so the target title supplies the link text. Apply the same change to the xref on modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc lines 21-21, using the target title for its label.Source: Learnings
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc (1)
53-53: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep the status command as an xref.
The status page exists, but this paragraph now uses plain command text. Use an empty-bracket xref so readers can open the status documentation directly.
Based on learnings, use
xreflinks with empty brackets so the target title supplies the link text.🤖 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-self-test-start.adoc` at line 53, Update the paragraph in the rpk cluster self-test documentation to replace both plain `rpk cluster self-test status` references with empty-bracket xrefs targeting the existing status page, allowing that page’s title to supply the link text.Source: Learnings
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 91e7c14f-5c82-4a28-89f0-20056b574d91
📒 Files selected for processing (137)
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission-status.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-recommission.adocmodules/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-list.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-info.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-logdirs-describe.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-list.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-set.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-enable.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balance.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-status.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-finalize.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-status.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade.adocmodules/reference/pages/rpk/rpk-cluster/rpk-cluster.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-echo.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-install.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-lint.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-list.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-run.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-template.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-test.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect.adocmodules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adocmodules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle.adocmodules/reference/pages/rpk/rpk-generate/rpk-generate-app.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-group/rpk-group-delete.adocmodules/reference/pages/rpk/rpk-group/rpk-group-describe.adocmodules/reference/pages/rpk/rpk-group/rpk-group-list.adocmodules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adocmodules/reference/pages/rpk/rpk-group/rpk-group-seek.adocmodules/reference/pages/rpk/rpk-group/rpk-group.adocmodules/reference/pages/rpk/rpk-k8s/rpk-k8s-install.adocmodules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bootstrap.adocmodules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bundle.adocmodules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-status.adocmodules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster.adocmodules/reference/pages/rpk/rpk-k8s/rpk-k8s-uninstall.adocmodules/reference/pages/rpk/rpk-k8s/rpk-k8s-upgrade.adocmodules/reference/pages/rpk/rpk-k8s/rpk-k8s-version.adocmodules/reference/pages/rpk/rpk-k8s/rpk-k8s.adocmodules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adocmodules/reference/pages/rpk/rpk-profile/rpk-profile-list.adocmodules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adocmodules/reference/pages/rpk/rpk-profile/rpk-profile-set.adocmodules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adocmodules/reference/pages/rpk/rpk-profile/rpk-profile.adocmodules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adocmodules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adocmodules/reference/pages/rpk/rpk-security/rpk-security-acl.adocmodules/reference/pages/rpk/rpk-security/rpk-security.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-config.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-create.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adocmodules/reference/pages/rpk/rpk-topic/rpk-topic-list.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-init.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-auth-login.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-apply.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-check.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-delete.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-diff.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-get.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-list.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adocmodules/reference/partials/rpk-ai/rpk-ai-llm-provider.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-apply.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-delete.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-diff.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-get.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-list.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-call.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-list.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-types.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adocmodules/reference/partials/rpk-ai/rpk-ai-mcp-server.adocmodules/reference/partials/rpk-ai/rpk-ai-oauth-client-dcr.adocmodules/reference/partials/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adocmodules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adocmodules/reference/partials/rpk-ai/rpk-ai-policy-apply.adocmodules/reference/partials/rpk-ai/rpk-ai-policy-create.adocmodules/reference/partials/rpk-ai/rpk-ai-policy-delete.adocmodules/reference/partials/rpk-ai/rpk-ai-policy-diff.adocmodules/reference/partials/rpk-ai/rpk-ai-policy-get.adocmodules/reference/partials/rpk-ai/rpk-ai-policy-list.adocmodules/reference/partials/rpk-ai/rpk-ai-policy-update.adocmodules/reference/partials/rpk-ai/rpk-ai-policy.adocmodules/reference/partials/rpk-cloud/rpk-cloud-auth-list.adocmodules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adocmodules/reference/partials/rpk-security/rpk-security-secret-list.adoc
The summary generator cannot split sentences around mid-token periods (_redpanda.transform_logs, redpanda.com/contact) and glued unterminated paragraphs into run-on sentences, publishing descriptions like 'View logs for a transform. transform_logs.' Also wraps the internal topic name _redpanda.transform_logs in inline code: the leading underscore doubles as an AsciiDoc italics delimiter. Content produced by the fixed generator (docs-extensions-and-macros#241) run against this branch's snapshot, so the next regeneration reproduces it byte for byte.
Regenerated with docs-extensions-and-macros#241:
- selfHostedOnly no longer wraps whole pages (doctitle included) in
ifndef::env-cloud. The wrapper sat outside the single-source tag
region, so includes never consumed it, and no build sets env-cloud
for this component. Row, flag, and content gating inside the tag
region, which does the real cloud exclusion, is unchanged.
- Summaries no longer glue unterminated paragraphs into run-on
sentences ('Disable partitions of a topic You may disable...') or
drop sentences around mid-token periods.
Output produced by running the #241 generator against this branch's
snapshot, so the next regeneration reproduces it byte for byte.
|
Pushed two follow-up commits on top of the workflow's rerender:
Both produced by running the docs-extensions-and-macros#241 generator against this branch's snapshot, so the next regeneration after #241 releases reproduces this output byte for byte. Sequencing: docs#1860 should stay held until that release, per the note there. |
CodeRabbit review findings, both defects in rpk's own help text that the ground-truth restoration faithfully reproduced: - rpk group delete claimed Redpanda cannot expire offsets for empty groups automatically (pre group_offset_retention_sec, redpanda#2904), contradicting the curated section on the same page that documents current expiration semantics. - rpk topic delete claimed ^/$ anchoring 'prevents accidental delete-everything mistakes', which its own '.*' example disproves. Both overrides carry _note fields naming the upstream defect so they are removed when rpk's help is corrected.
Every 'introduced in ai version 0.2.32' note was wrong. The plugin splice stamps commands that are new relative to the previous snapshot, but the previous snapshot's ai subtree predated 0.2.26, so three releases' worth of commands were attributed to 0.2.32. Verified against real plugin binaries (rpai 0.2.20 through 0.2.32 from the plugins manifest, --help-autocomplete tree per version): - rpk ai policy family (8 commands): introduced in 0.2.26 - rpk ai llm-provider family, mcp-server family, oauth-client update (22 commands): introduced in 0.2.28 The k8s notes (26.2.1 is the plugin's first GA in its manifest) and the 14 core v26.2.1 command stamps plus 23 flag stamps (all absent from the rpk 26.1.12 tree) verified correct.
|
One more verified correction pushed (8698431): all 30 "This command was introduced in ai version 0.2.32" notes were wrong. The splice stamps commands that are new relative to the previous snapshot, and the snapshot's ai subtree predated 0.2.26 — so three releases' worth of commands were attributed to 0.2.32. Verified against released rpai binaries (0.2.20–0.2.32 from the plugins manifest): the policy family is 0.2.26, and llm-provider/mcp-server/oauth-client are 0.2.28. The k8s notes (26.2.1, first GA in its manifest) and all core v26.2.1 command and flag stamps verified correct against the rpk 26.1.12 tree. docs-extensions-and-macros#241 now guards the stamper so unattributable baselines are skipped with a warning instead of fabricated. |
2 participants
Automated re-render of the generated rpk reference pages after an overrides change on
main(fb733e7).Review focus: the changed pages should reflect exactly the merged overrides edit, nothing else. The generator version is pinned to the same range the release regeneration uses, so unrelated churn here means the branch missed a regeneration and this PR is catching it up.
rpk Documentation Generation Summary
Version: v26.2.1
Generation Statistics
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 cluster configrpk topic describeValidation Report
Issues by Rule
Generated by rpk-docs automation