Skip to content

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented May 22, 2025

Description

This pull request includes updates to documentation for Redpanda's configuration properties, tagging iceberg_disable_snapshot_tagging for single sourcing in Cloud.

Iceberg Snapshot Tagging Documentation:

  • Improved the description of the iceberg_disable_snapshot_tagging property to clarify its purpose and usage, ensuring better readability.
  • Added conditional visibility for the default value of the iceberg_disable_snapshot_tagging property to exclude it from cloud environments.

Object Storage Properties Documentation:

  • Corrected the placement of the // end::cloud_storage_azure_container[] tag for better alignment with the documentation structure.
  • Adjusted the // end::cloud_storage_azure_storage_account[] tag to improve consistency in the object storage properties section.

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

Page previews

https://deploy-preview-1133--redpanda-docs-preview.netlify.app/redpanda-cloud/reference/properties/cluster-properties/

Checks

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

@micheleRP micheleRP requested a review from a team as a code owner May 22, 2025 20:10
@netlify
Copy link

netlify bot commented May 22, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit bc8f649
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/683087125026df0008e00e73
😎 Deploy Preview https://deploy-preview-1133--redpanda-docs-preview.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 May 22, 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 change updates documentation for the iceberg_disable_snapshot_tagging cluster property. The description was reworded for clarity and a comma was added. The default value declaration is now conditionally excluded from Redpanda Cloud environments using ifndef::env-cloud[] and endif::[]. Tag markers were added around the property block for snippet referencing. In a separate file, the placement of closing tag comments for Azure storage properties was adjusted for consistency. No changes were made to code, configuration semantics, or public API declarations.

Sequence Diagram(s)

Not applicable: The changes are limited to documentation formatting and text adjustments.

Assessment against linked issues

Objective Addressed Explanation
Add iceberg_disable_snapshot_tagging as customizable property supported in BYOC (DOC-1394)

Possibly related PRs

Suggested reviewers

  • mattschumpert
  • alenkacz

🪧 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.

@micheleRP micheleRP requested a review from simon0191 May 22, 2025 20:24
@micheleRP micheleRP merged commit dde5048 into main May 23, 2025
7 checks passed
@micheleRP micheleRP deleted the DOC-1394-Document-feature-Iceberg-on-Cloud-add-iceberg_disable_snapshot_tagging-to-properties-supported-in-BYOC branch May 23, 2025 14:37
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.

4 participants