DOC-2204: Update rpk-debug-bundle example syntax#1720
Conversation
|
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 PR updates the documentation for the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![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
🤖 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 `@modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc`:
- Line 62: Update the example flag syntax in rpk-debug-bundle.adoc to remove the
misleading colon after the flag name: replace instances of "--partition:
foo/1,2,3" and "--partition: _redpanda-internal/bar/2" with standard CLI forms
such as "--partition foo/1,2,3" or "--partition=foo/1,2,3", or alternatively
show the full command (e.g. "rpk debug bundle --partition foo/1,2,3") or add a
short label like "Value: `foo/1,2,3`" to clarify the intended value; ensure all
occurrences (including the other noted instance) are updated consistently.
- Line 56: The format string currently shows
`<namespace>/[topic]/[partition...]` which incorrectly implies the topic is
optional; update the notation so the optional part is the namespace prefix
instead (e.g., `[<namespace>/]topic/[partition...]`): remove square brackets
around `topic`, wrap the `namespace/` segment in brackets, and update the
explanatory sentence and examples in rpk-debug-bundle.adoc to match this
corrected format.
🪄 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: ca89bebc-aec5-449e-b4dd-83a0928e0809
📒 Files selected for processing (1)
modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc
| You can provide a list of partitions to save additional admin API requests specifically for those partitions. | ||
|
|
||
| The partition flag accepts the format `<namespace>/[topic]/[partitions...]` where the namespace is optional, if the namespace is not provided, `rpk` will assume 'kafka'. For example: | ||
| The partition flag accepts the format `<namespace>/[topic]/[partition...]` where the namespace is optional, if the namespace is not provided, `rpk` will assume 'kafka'. For example: |
There was a problem hiding this comment.
Clarify the format notation for partition flag.
The format <namespace>/[topic]/[partition...] uses square brackets around topic, which conventionally indicates optional components. However, the examples on lines 62 and 68 demonstrate that the topic is required. The square brackets should wrap the optional namespace prefix instead.
📝 Proposed fix for format notation
-The partition flag accepts the format `<namespace>/[topic]/[partition...]` where the namespace is optional, if the namespace is not provided, `rpk` will assume 'kafka'. For example:
+The partition flag accepts the format `[namespace/]topic/partition[,partition...]` where the namespace is optional. If the namespace is not provided, `rpk` will assume 'kafka'. For example:📝 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.
| The partition flag accepts the format `<namespace>/[topic]/[partition...]` where the namespace is optional, if the namespace is not provided, `rpk` will assume 'kafka'. For example: | |
| The partition flag accepts the format `[namespace/]topic/partition[,partition...]` where the namespace is optional. If the namespace is not provided, `rpk` will assume 'kafka'. For example: |
🤖 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-debug/rpk-debug-bundle.adoc` at line 56, The
format string currently shows `<namespace>/[topic]/[partition...]` which
incorrectly implies the topic is optional; update the notation so the optional
part is the namespace prefix instead (e.g.,
`[<namespace>/]topic/[partition...]`): remove square brackets around `topic`,
wrap the `namespace/` segment in brackets, and update the explanatory sentence
and examples in rpk-debug-bundle.adoc to match this corrected format.
There was a problem hiding this comment.
@JFlath Is this correct? Not part of your request, but CodeRabbit caught.
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
1 participant
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-2204
Review deadline:
Page previews
Checks