DOC-1404 add enable_consumer_group_metrics #311
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 📝 WalkthroughWalkthroughThis change updates the documentation by adding a new navigation entry for the "rpk cluster config get" command, creates a dedicated AsciiDoc page for this command, and includes a new cluster configuration property tag Sequence Diagram(s)Assessment against linked issues
Possibly related PRs
Suggested reviewers
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: 0
🧹 Nitpick comments (2)
modules/reference/pages/properties/cluster-properties.adoc (1)
11-11: Consider sorting the tag list for readability
To maintain consistency and ease future updates, you might alphabetically order thetagsattribute or group related properties together.modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc (1)
1-3: Add page metadata for consistency
This new page includes only a title and an include. To align with sibling pages, add:page-toclevels:and:description:attributes for better navigation and SEO.Example diff:
= rpk cluster config get +:page-toclevels: 2 +:description: Retrieves the value of a cluster configuration property. include::ROOT:reference:rpk/rpk-cluster/rpk-cluster-config-get.adoc[tag=single-source]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
modules/ROOT/nav.adoc(1 hunks)modules/reference/pages/properties/cluster-properties.adoc(1 hunks)modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc(1 hunks)
🔇 Additional comments (2)
modules/reference/pages/properties/cluster-properties.adoc (1)
11-11: Ensure documentation exists for the new property
You addedenable_consumer_group_metricsto the tags list—please verify that a corresponding entry with its description is present in the generated properties definitions (the single-source include).modules/ROOT/nav.adoc (1)
465-466: Navigation entry correctly added
Therpk cluster config getitem is properly nested underrpk-cluster-config.adoc, follows the existing indentation, and is ordered among its siblings (get,set,status).
Description
This pull request adds
rpk cluster config getandenable_consumer_group_metricsto Cloud docs. It also single sources some of the Monitoring content from SM (which was not single sourced properly before). Single sourcing is done in redpanda-data/docs#1139.Documentation Navigation Updates:
modules/ROOT/nav.adoc: Added a navigation link for therpk cluster config getcommand to improve discoverability.Cluster Properties Enhancements:
modules/reference/pages/properties/cluster-properties.adoc: Updated the cluster properties documentation to include theenable_consumer_group_metricsproperty. This helps users understand new metrics available for consumer groups.New Command Documentation:
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc: Added a new file documenting therpk cluster config getcommand, providing details on its usage and functionality.Resolves https://redpandadata.atlassian.net/browse/DOC-1404
Review deadline:
Page previews
Cluster Configuration Properties
rpk cluster config get
Monitor Redpanda Cloud
Checks