docs: add rpk cluster config list #372
Conversation
|
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 Possibly related PRs
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 (
|
✅ Deploy Preview for rp-cloud 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: 1
🧹 Nitpick comments (1)
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc (1)
1-3: Page compiles, but consider adding page metadata.The minimal stub works, but most reference pages in this tree declare attributes such as
:page-aliases:or a short description for search/SEO.
If you omit them intentionally, feel free to ignore; otherwise add them now to keep parity with sibling pages.
📜 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 (2)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#278
File: modules/manage/pages/cluster-maintenance/config-cluster.adoc:75-75
Timestamp: 2025-04-29T18:43:42.666Z
Learning: In AsciiDoc documentation used by Redpanda, empty cross-references (xrefs) without link text (like `xref:manage:rpk/intro-to-rpk.adoc[]`) automatically use the target page's title as the link text.
📚 Learning: in asciidoc documentation used by redpanda, empty cross-references (xrefs) without link text (like `...
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#278
File: modules/manage/pages/cluster-maintenance/config-cluster.adoc:75-75
Timestamp: 2025-04-29T18:43:42.666Z
Learning: In AsciiDoc documentation used by Redpanda, empty cross-references (xrefs) without link text (like `xref:manage:rpk/intro-to-rpk.adoc[]`) automatically use the target page's title as the link text.
Applied to files:
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc
🔇 Additional comments (1)
modules/ROOT/nav.adoc (1)
486-488: Navigation entry added in the correct hierarchy – double-check build order.The new xref line follows the existing indentation and naming convention (get → list → set → status). Looks good.
Just run a quickantora --clean(or your usual docs build) to confirm the new page resolves without broken-link warnings, as the nav file is very sensitive to typos.
| @@ -0,0 +1,3 @@ | |||
| = rpk cluster config list | |||
|
|
|||
| include::ROOT:reference:rpk/rpk-cluster/rpk-cluster-config-list.adoc[tag=single-source] No newline at end of file | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify included source exists and carries the single-source tag.
Broken include paths fail the whole Antora build. Run:
to be sure the single-source file and tag are present.
🏁 Script executed:
#!/bin/bash
# Confirm the target file and tag exist
rg --line-number '^\s*= rpk cluster config list' ; \
rg -n 'tag=single-source' $(fd rpk-cluster-config-list.adoc)Length of output: 367
Add region markers for single-source in rpk-cluster-config-list.adoc
I confirmed the file modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc exists and the include directive carries [tag=single-source], but I didn’t find any matching region tags in that file. Without them, Antora will fail to extract the snippet.
• Location needing attention:
- modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc
• Suggested patch to wrap the content you want to include:
+ //// tag::single-source[]
= rpk cluster config list
…rest of your content…
+ //// end::single-source[]Ensure the include stays as:
include::ROOT:reference:rpk/rpk-cluster/rpk-cluster-config-list.adoc[tag=single-source]
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc at line
3, the include directive references a tag 'single-source' that does not exist in
the file. To fix this, add region markers in the file by wrapping the intended
content with the lines '// tag::single-source[]' at the start and '//
end::single-source[]' at the end. This will define the 'single-source' tag so
Antora can correctly extract the snippet while keeping the include directive
unchanged.
Description
Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
related docs PR redpanda-data/docs#1259
This is available on cloud today.
Page previews
Checks