DOC-1407 single source additions for Cloud #1139
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 📝 WalkthroughWalkthroughThe changes update documentation to support environment-specific content and improve single-sourcing for cloud and non-cloud builds. The Antora playbook is modified to source documentation from a specific feature branch. The Sequence Diagram(s)sequenceDiagram
participant Antora
participant cloud-docs (feature branch)
participant Docs Build
Antora->>cloud-docs (feature branch): Fetch content (branch: DOC-1404-Document-new-configurable-property)
Antora->>Docs Build: Build docs with environment conditionals
Docs Build->>Docs Build: Render cluster property docs (env-specific)
Docs Build->>Docs Build: Include tagged content for rpk cluster config get
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 (
|
![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)
local-antora-playbook.yml (1)
19-20: Branch reference updated to feature branch
Thecloud-docssource now points to theDOC-1404-Document-new-configurable-propertybranch, which aligns this playbook with the new configurable-property documentation changes.Nitpick: for consistency with other multi-branch entries, you could use a YAML list here:
- branches: 'DOC-1404-Document-new-configurable-property' + branches: ['DOC-1404-Document-new-configurable-property']modules/reference/pages/properties/cluster-properties.adoc (1)
1233-1239: Cloud conditional block: Consider adding usage guidance.The
ifdef::env-cloud[]block mirrors the overhead warning but omits any pointer toconsumer_group_lag_collection_interval_sec. For consistency, it would be helpful to include the same usage note in the cloud context so users know how to adjust the lag collection interval there as well.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
local-antora-playbook.yml(1 hunks)modules/reference/pages/properties/cluster-properties.adoc(1 hunks)modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (3)
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc (1)
2-2: Single-source tags correctly wrap the document
The// tag::single-source[]and matching// end::single-source[]markers are placed at the very start and end of the page content, enabling source extraction without altering any of the substantive documentation.Also applies to: 35-35
modules/reference/pages/properties/cluster-properties.adoc (2)
1223-1231: Non-cloud conditional block: Overhead note and usage guidance added.The
ifndef::env-cloud[]section now includes a clear warning about the extra processing overhead when enablingconsumer_lag, along with a link to theconsumer_group_lag_collection_interval_secproperty to control collection frequency. This enhances clarity and helps users tune the setting appropriately.
1247-1253: Default values and related topics scoped correctly to non-cloud.The default list (
["group", "partition"]) and the related-topic link are properly enclosed in the non-cloud block, ensuring cloud builds don’t display irrelevant defaults. This aligns with the single‐sourcing strategy.
Description
This pull request tags
enable_consumer_group_metrics,rpk cluster config get, and part of the monitoring page for single sourcing in Cloud docs. Related PR = redpanda-data/cloud-docs#311.Documentation Updates:
enable_consumer_group_metrics) to describe consumer group metrics and their behavior for both cloud and non-cloud environments.rpk cluster config getDocumentation:single-source) to structure the documentation for retrieving cluster configuration properties, improving readability and organization. [1] [2]Configuration Updates:
local-antora-playbook.yml:redpanda-data/cloud-docsrepository from'main'to'DOC-1404-Document-new-configurable-property'to reflect the new documentation branch.Resolves https://redpandadata.atlassian.net/browse/DOC-1407
Review deadline:
Page previews
enable_consumer_group_metrics in Cloud
enable_consumer_group_metrics in SM
rpk cluster config get in Cloud
Monitor Redpanda Cloud
Checks