DOC-1444 use different property in cluster config example

[micheleRP]

Description

This pull request updates the documentation in modules/manage/pages/cluster-maintenance/config-cluster.adoc to replace references to the data_transforms_enabled cluster property with the audit_enabled property. The changes ensure consistency across examples and instructions for setting and retrieving cluster configuration properties.

Documentation updates:

• Updated examples to use audit_enabled instead of data_transforms_enabled in instructions for setting cluster properties with rpk (rpk cluster config set) and Cloud API (PATCH /v1/clusters/{cluster.id}). [1] [2] [3]

• Updated examples to use audit_enabled instead of data_transforms_enabled in instructions for retrieving cluster property values with rpk (rpk cluster config get) and Cloud API (GET /clusters/{cluster.id}). [1] [2]

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

Page previews

Config cluster properties

Checks

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

[netlify]

✅ Deploy Preview for rp-cloud ready!

Name	Link
🔨 Latest commit	697f087
🔍 Latest deploy log	https://app.netlify.com/projects/rp-cloud/deploys/6846fae32bf2740008dac346
😎 Deploy Preview	https://deploy-preview-322--rp-cloud.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 project configuration.

[coderabbitai]

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 documentation for cluster configuration has been updated to replace all example references to the data_transforms_enabled property with the audit_enabled property. This affects both command-line (rpk) and Cloud API usage examples, demonstrating how to set and retrieve the audit_enabled property. No changes were made to the actual procedural instructions, command syntax, or API endpoints—only the example property name was changed throughout the documentation.

Assessment against linked issues

Objective	Addressed	Explanation
Use a different property in cluster config example (DOC-1444)	✅

Possibly related PRs

• DOC-1283 add rpk to config-cluster.adoc #278: Updates rpk cluster config usage instructions and examples for property configuration, focusing on data_transforms_enabled, which is directly relevant to the property name change in this PR.

Suggested reviewers

• alenkacz

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

modules/manage/pages/cluster-maintenance/config-cluster.adoc (1)

68-74: Inline comment needs update to reflect audit_enabled
The curl command comment still says "enable data transforms" but the payload now sets audit_enabled. Update the comment for consistency.

Apply this diff:

- # Update your cluster configuration to enable data transforms.
+ # Update your cluster configuration to enable audit logging.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b1c71f0 and f737baf.

📒 Files selected for processing (1)

• modules/manage/pages/cluster-maintenance/config-cluster.adoc (5 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Redirect rules - rp-cloud
• GitHub Check: Header rules - rp-cloud
• GitHub Check: Pages changed - rp-cloud

🔇 Additional comments (4)

modules/manage/pages/cluster-maintenance/config-cluster.adoc (4)

31-36: CLI example correctly updated to use audit_enabled
The description and the rpk cluster config set command now reference audit_enabled instead of data_transforms_enabled, aligning with the PR objective.

---

58-63: Cloud API PATCH example updated to audit_enabled
The explanatory text now references audit_enabled, and the JSON payload in the PATCH example matches the updated property name.

---

114-119: CLI get example correctly updated to use audit_enabled
The rpk cluster config get example now shows the correct audit_enabled property.

---

128-131: Cloud API GET description updated to reflect audit_enabled
The GET request example and its description now reference audit_enabled, matching the set example above.