DOC-1287 hide defaults in cloud cluster properties #1107

micheleRP · 2025-05-06T00:53:33Z

Description

This pull request updates the modules/reference/pages/properties/cluster-properties.adoc file to conditionally exclude default property values in Cloud docs. Specifically, it wraps default values in ifndef::env-cloud[] blocks to exclude them when the env-cloud environment is active.

Conditional Default Value Updates:

Added ifndef::env-cloud[] blocks around default values for various cluster properties, such as audit logging, WebAssembly-powered data transforms, Iceberg catalog configurations, and more. These blocks exclude default values from the documentation when the env-cloud environment is active. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23] [24]

Resolves https://redpandadata.atlassian.net/browse/DOC-1287
Review deadline:

Page previews

Cluster config properties in Cloud
Cluster config properties in Self-Managed

Checks

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

coderabbitai · 2025-05-06T00:53:39Z

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

The changes update the documentation for several cluster configuration properties in the cluster-properties.adoc file. Default value lines for these properties are now wrapped in conditional directives so that they are hidden when the documentation is built for the Redpanda Cloud environment. No other aspects of the documentation, such as property descriptions or metadata, are altered. There are no changes to the codebase or exported entities; only the visibility of default values in the documentation is affected based on the build environment.

Assessment against linked issues

Objective	Addressed	Explanation
Conditionalize out defaults for cluster config properties available in Cloud (DOC-1287)	✅

Possibly related PRs

DOC-1282 rpk cluster config for cloud wasm #1092: Updates documentation for data_transforms_enabled in the context of enabling it via rpk and Cloud API, which relates to the conditional visibility of this property's default in the current PR.

Suggested reviewers

alenkacz
asimms41

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

netlify · 2025-05-06T00:53:51Z

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	`8402f3c`
🔍 Latest deploy log	https://app.netlify.com/sites/redpanda-docs-preview/deploys/681a2b78cae193000899c998
😎 Deploy Preview	https://deploy-preview-1107--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

asimms41

Just a couple of updates to make, but LGTM

asimms41 · 2025-05-06T13:50:56Z

modules/reference/pages/properties/cluster-properties.adoc


 *Type:* boolean

 *Enterprise license required*: `true`


Wouldn't this line be excluded for Cloud as well?

fixed, thank you!

asimms41 · 2025-05-06T13:56:06Z

modules/reference/pages/properties/cluster-properties.adoc

+endif::[]

 **Related topics**:



Should link on line below be Enable Iceberg Integration to match the page heading?

asimms41 · 2025-05-06T14:04:09Z

modules/reference/pages/properties/cluster-properties.adoc


 *Type:* string

+ifndef::env-cloud[]


Anchor link above <<iceberg_rest_catalog_trust_file, iceberg_rest_catalog_trust_file>> is not working.

DOC-1287 hide defaults in cloud cluster properties

d1cd0bc

micheleRP requested a review from a team as a code owner May 6, 2025 00:53

micheleRP requested review from alenkacz and mattschumpert May 6, 2025 00:59

mattschumpert approved these changes May 6, 2025

View reviewed changes

alenkacz approved these changes May 6, 2025

View reviewed changes

asimms41 approved these changes May 6, 2025

View reviewed changes

incorporate feedback from doc review

8402f3c

micheleRP merged commit f080562 into main May 6, 2025
8 checks passed

micheleRP deleted the DOC-1287-hide-defaults-in-cloud-cluster-properties branch May 6, 2025 15:37

coderabbitai bot mentioned this pull request May 6, 2025

Update Iceberg catalog doc for Cloud (single source) #1113

Merged

4 tasks

This was referenced May 22, 2025

DOC-1394 iceberg_disable_snapshot_tagging in Cloud #1133

Merged

DOC-1407 single source additions for Cloud #1139

Merged

This was referenced Sep 15, 2025

DOC-1643 single source client connections in docs #1357

Merged

DOC-1686 single source auto_create_topics_enabled #1361

Merged

DOC-1287 hide defaults in cloud cluster properties #1107

DOC-1287 hide defaults in cloud cluster properties #1107

Uh oh!

Conversation

micheleRP commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Conditional Default Value Updates:

Page previews

Checks

Uh oh!

coderabbitai bot commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Assessment against linked issues

Possibly related PRs

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

netlify bot commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for redpanda-docs-preview ready!

Uh oh!

asimms41 left a comment

Choose a reason for hiding this comment

Uh oh!

asimms41 May 6, 2025

Choose a reason for hiding this comment

Uh oh!

micheleRP May 6, 2025

Choose a reason for hiding this comment

Uh oh!

asimms41 May 6, 2025

Choose a reason for hiding this comment

Uh oh!

asimms41 May 6, 2025

Choose a reason for hiding this comment

Uh oh!

micheleRP May 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

micheleRP commented May 6, 2025 •

edited

Loading

coderabbitai bot commented May 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

netlify bot commented May 6, 2025 •

edited

Loading