Skip to content

Conversation

@daisukebe
Copy link
Contributor

Description

This PR updates the output of the rpk redpanda admin brokers list command in all pages that exists because they are still old.

Page previews

Checks

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

@daisukebe daisukebe requested a review from a team as a code owner January 23, 2026 02:56
@netlify
Copy link

netlify bot commented Jan 23, 2026

Deploy Preview for redpanda-docs-preview ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit abc4434
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69799bbb7bfa820008a4d15f
😎 Deploy Preview https://deploy-preview-1557--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

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
Copy link
Contributor

coderabbitai bot commented Jan 23, 2026

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.

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

  • 🔍 Trigger a full review
📝 Walkthrough

Walkthrough

This pull request updates documentation across multiple Redpanda operational guides. The changes standardize broker list example outputs in decommissioning and rolling upgrade documentation by replacing compact numeric-ID formatting with detailed hostname-based tables containing additional fields (HOST, PORT, RACK, UUID). Updates also include column header standardization (MEMBERSHIP-STATUS to MEMBERSHIP, BROKER-VERSION to VERSION) and new guidance on handling replication factors during rolling upgrades for topics with replication.factor=1.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • Feediver1
  • david-yu
  • BenPope
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Update brokers list outputs' directly aligns with the primary change across all modified files—updating the rpk redpanda admin brokers list command output examples to include new fields (HOST, PORT, RACK, UUID) and updated formatting.
Description check ✅ Passed The description provides clear context about updating outdated command outputs and correctly identifies the change as a 'Small fix', but lacks the Redpanda JIRA ticket reference and page preview links required by the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@daisukebe
Copy link
Contributor Author

@Feediver1, the new output is horizontally wide. Is it possible to make the [%collapsible] block horizontally scrollable?
image

@JakeSCahill
Copy link
Contributor

Thanks! You can get the code block to scroll by using this syntax instead of triple backticks:

[,bash,role=“no-wrap”]
- - - -
Code here
- - - -

don’t add spaces between the dashes. I’m currently on mobile and needed to do that to get it to render.

@JakeSCahill
Copy link
Contributor

I think the ideal scenario for the long-term is for us to build tests that save the rpk output and run on each release. This way our outputs will never become outdated like this.

@JakeSCahill JakeSCahill merged commit b2a231b into redpanda-data:main Jan 28, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants