-
Notifications
You must be signed in to change notification settings - Fork 4
DOC-1673 single source client connections in cloud-docs #412
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC-1673 single source client connections in cloud-docs #412
Conversation
✅ Deploy Preview for rp-cloud 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 📝 WalkthroughWalkthroughAdds a new AsciiDoc page at modules/manage/pages/cluster-maintenance/configure-availability.adoc that sets the title and description and single-sources its content via an include from ROOT:manage:cluster-maintenance/configure-availability.adoc[tag=single-source]. Updates modules/reference/pages/properties/cluster-properties.adoc to append two include tags—kafka_connections_max_per_ip and kafka_connections_max_overrides—so these properties appear in the cluster properties reference. No changes to public APIs or code; scope is limited to documentation includes and page addition. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Pre-merge checks✅ Passed checks (5 passed)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/manage/pages/cluster-maintenance/configure-availability.adoc (1)
1-2: Tighten description for SEO/clarity.Consider mentioning “client connections” explicitly in the description.
-:description: Guidelines for configuring Redpanda clusters for optimal availability. +:description: Guidelines for configuring client connections in Redpanda clusters for optimal availability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
modules/manage/pages/cluster-maintenance/configure-availability.adoc(1 hunks)modules/reference/pages/properties/cluster-properties.adoc(1 hunks)
⏰ 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 - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (2)
modules/reference/pages/properties/cluster-properties.adoc (1)
11-11: Expose kafka_connections_max_ in reference — looks good; verify tag availability.*The two tags added at the end of the include look consistent. Please confirm the upstream reference file defines
kafka_connections_max_per_ipandkafka_connections_max_overridestags and that they are intended to surface in Cloud. If these properties are version‑ or edition‑gated, ensure the include respects the correct conditions.modules/manage/pages/cluster-maintenance/configure-availability.adoc (1)
4-4: Confirm include target and tag exist to avoid broken build.Double‑check that the resource ID resolves to the canonical single‑source page and that the
single-sourcetag exists there. If the canonical content lives in a different component, ensure the component coordinate is correct in the include.
|
Approved assuming redpanda-data/docs#1357 will be resolved. |
Description
This pull request adds single sourcing for Configure Client Connections and adds new cluster property references related to Kafka client connections. Related to redpanda-data/docs#1357
Resolves https://redpandadata.atlassian.net/browse/DOC-1673
Review deadline:
Page previews
Configure Client Connections
Cluster Properties
Checks