Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

Description

Updates how we include config properties that are supported by Redpanda Cloud. We now autogenerate all config property reference docs in redpanda-data/docs#1428. Properties that are supported in Redpanda Cloud are fetched from the cloudv2 repo and tagged with redpanda-cloud. This PR updates our includes to include those tags and ignore deprecated properties/those we exclude from docs on purpose.

Page previews

Checks

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

@netlify
Copy link

netlify bot commented Oct 29, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 4caaed9
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6908ee02e4a3fa00081f2287
😎 Deploy Preview https://deploy-preview-445--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 Oct 29, 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

This pull request refactors documentation includes across three AsciiDoc files by switching from explicit tag-based includes to semantic tag filtering. Two property reference files change their include directives to target a partial document path with filters for redpanda-cloud, non-deprecated, and docs-included properties. Additionally, a page alias is added to the cloud authentication documentation page to enable alternative navigation paths.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify that the new semantic tag filters (redpanda-cloud, !deprecated, !exclude-from-docs) capture all properties that were previously included via explicit tag lists
  • Confirm the partial document paths referenced in both include directives exist and resolve correctly
  • Validate that no documented properties are unintentionally excluded by the new filtering approach
  • Check that the page alias in cloud-authentication.adoc does not conflict with existing navigation or create redirect issues

Possibly related PRs

Suggested reviewers

  • mattschumpert
  • Feediver1
  • deniscoady

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Add config property automation' is vague and generic. While it relates to the PR's objective of updating config property includes, it doesn't clearly describe the specific change being made. Terms like 'automation' lack concrete detail about what is actually being automated or changed in the codebase. Consider revising the title to be more specific about the actual change, such as 'Update config property includes to filter by Redpanda Cloud tags' or 'Refactor cluster properties include directives for Cloud support'. This would make the change clearer to someone reviewing the Git history.
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The description adequately covers the key aspects of the PR. It explains the purpose (updating how config properties for Redpanda Cloud are included), references the related upstream PR, describes the tagging mechanism (redpanda-cloud tags from cloudv2 repo), and clarifies the filtering logic (including redpanda-cloud tags while excluding deprecated and excluded properties). The description template sections are mostly addressed, with the description and page preview sections present, though page previews remain as a placeholder.

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.

❤️ Share

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

@JakeSCahill JakeSCahill marked this pull request as ready for review November 3, 2025 17:15
@JakeSCahill JakeSCahill requested a review from a team as a code owner November 3, 2025 17:15
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.

2 participants