DOC-2204: Update rpk-debug-bundle example syntax

[Feediver1]

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-2204
Review deadline:

Page previews

• rpk debug bundle (updated)

Checks

• New feature
• Content gap
• Support Follow-up
• Small fix (typos, links, copyedits, etc)

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7996fa40-8406-4c92-bfd5-b7b8db130c58

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

📝 Walkthrough

Walkthrough

This PR updates the documentation for the rpk debug bundle command in a single Asciidoc file. The partition flag documentation is rewritten to clarify the accepted format as <namespace>/[topic]/[partition...] with an optional namespace defaulting to kafka, and the flag name is changed from --partitions to --partition. Example invocations are updated to reflect the new syntax, including examples like foo/1,2,3 and _redpanda-internal/bar/2. Additionally, the single-source directive termination is adjusted with an explicit comment.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• redpanda-data/docs#1125: Both PRs update Asciidoc documentation for rpk command flags involving --partition syntax and descriptions.
• redpanda-data/docs#1453: Both PRs update the rpk-debug-bundle.adoc file with flag behavior changes for the same command.

Suggested reviewers

• micheleRP

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The PR description includes the required JIRA ticket link and a page preview, but is missing the review deadline and lacks detailed explanation of the changes.	Add the review deadline date, provide a more detailed summary of what was changed and why, and ensure all template sections are properly completed before merging.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title directly references the Jira ticket (DOC-2204) and clearly summarizes the main change: updating example syntax in rpk-debug-bundle documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch Feediver1-patch-7

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[netlify]

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	c024654
🔍 Latest deploy log	https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a18aa4f71b2170008ea3963
😎 Deploy Preview	https://deploy-preview-1720--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

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

📥 Commits

Reviewing files that changed from the base of the PR and between f2d3af3 and 12b59e5.

📒 Files selected for processing (1)

• modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc

[micheleRP]

one little style fix, then looks good!