Skip to content

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Sep 15, 2025

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

  • New feature for Cloud
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@micheleRP micheleRP requested a review from a team as a code owner September 15, 2025 19:32
@netlify
Copy link

netlify bot commented Sep 15, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit b787b72
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/68cb06f6b9de140008f5c616
😎 Deploy Preview https://deploy-preview-412--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 15, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Adds 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

  • kbatuigas
  • r-vasquez
  • paulohtb6

Pre-merge checks

✅ Passed checks (5 passed)
Check name Status Explanation
Title Check ✅ Passed The title includes the Jira ID and clearly describes the primary change — introducing single‑source client connections in the cloud-docs repository. It directly reflects the changeset (adding a single‑source Configure Client Availability page and related cluster-properties updates). The phrasing is concise and meaningful for teammates scanning PR history.
Linked Issues Check ✅ Passed This PR implements the primary objectives of DOC-1673 by single‑sourcing the Configure Client Availability content (adding a configure-availability.adoc that includes the centralized topic) and by updating the cluster-properties reference to surface kafka_connections_max_per_ip and kafka_connections_max_overrides. Both edits are documentation code changes within cloud-docs that directly map to the linked issue's stated goal of single‑source client connections. There are no additional coding requirements listed in the linked issue, so the changes meet the linked-issue objectives.
Out of Scope Changes Check ✅ Passed All modified files listed in the provided summary are directly related to the client-connections single‑sourcing objective: a new configure-availability.adoc that includes centralized content and an update to cluster-properties.adoc to expose two Kafka client connection properties; no unrelated files or unrelated functionality changes are present in the summary. Therefore no out‑of‑scope changes were detected within this changeset. The changes align with the linked issue and PR objectives.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The pull request description includes a clear Description section, references to the related docs PR and the Jira issue (DOC-1673), explicit page preview URLs, and a populated Checks section, so the intent and scope are understandable. It deviates from the template by not including the repository-specific documentation-private issue URL and by leaving the Review deadline field blank. These are minor template omissions and do not obscure the required review information.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.

📥 Commits

Reviewing files that changed from the base of the PR and between d44aa27 and 9b0a0f1.

📒 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_ip and kafka_connections_max_overrides tags 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-source tag exists there. If the canonical content lives in a different component, ensure the component coordinate is correct in the include.

@paulohtb6
Copy link
Contributor

Approved assuming redpanda-data/docs#1357 will be resolved.

@micheleRP micheleRP merged commit 0a9cd70 into main Sep 17, 2025
5 checks passed
@micheleRP micheleRP deleted the DOC-1673-single-source-client-connections-in-cloud-docs branch September 17, 2025 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants