Skip to content

Conversation

@paulohtb6
Copy link
Contributor

Add cluster property override file because of this property change

redpanda-data/docs#1425

@netlify
Copy link

netlify bot commented Oct 28, 2025

Deploy Preview for docs-extensions-and-macros ready!

Name Link
🔨 Latest commit 0fb7a38
🔍 Latest deploy log https://app.netlify.com/projects/docs-extensions-and-macros/deploys/6900d527df68e1000880633b
😎 Deploy Preview https://deploy-preview-146--docs-extensions-and-macros.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 28, 2025

📝 Walkthrough

Walkthrough

A new JSON data file docs-data/cluster-property-overrides.json is introduced containing cluster property override configurations. The file defines two cluster properties—max_concurrent_producer_ids and transactional_id_expiration_ms—each with descriptive metadata and cross-references to related documentation topics. No code logic or control-flow changes are present.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single data file addition with static JSON content
  • No functional logic or behavioral implications
  • Straightforward schema verification needed

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "add cluster prop override" directly describes the main change in the changeset: adding a new JSON data file containing cluster property overrides. The title is concise, clear, and specific enough to convey the primary change without being vague or generic. It accurately reflects the core content of the modification shown in the raw summary.
Description Check ✅ Passed The pull request description "Add cluster property override file because of this property change" is clearly related to the changeset, which adds the docs-data/cluster-property-overrides.json file. The description explains both what is being added and provides context by referencing a related pull request, making it appropriate and relevant rather than off-topic or completely vague.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-cluster-prop-overide

📜 Recent 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 8b136fb and 0fb7a38.

📒 Files selected for processing (1)
  • docs-data/cluster-property-overrides.json (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 - docs-extensions-and-macros
  • GitHub Check: Header rules - docs-extensions-and-macros
  • GitHub Check: Pages changed - docs-extensions-and-macros
🔇 Additional comments (1)
docs-data/cluster-property-overrides.json (1)

1-18: Well-structured cluster property documentation data.

The JSON file is syntactically valid and provides comprehensive documentation for both cluster properties. The descriptions include important production guidance (OOM warnings, memory management caveats) and the circular cross-references between related properties support good documentation discovery. The AsciiDoc xref format is consistent throughout.

Please verify that the AsciiDoc xref paths resolve correctly in your documentation build system:

  • xref:develop:transactions.adoc#tune-producer-id-limits
  • xref:reference:properties/cluster-properties.adoc#transactional_id_expiration_ms
  • xref:reference:properties/cluster-properties.adoc#max_concurrent_producer_ids

You may run a documentation build to confirm all cross-references are valid.


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
Copy link
Contributor

Thanks Paulo! The ones here are for testing purposes. The real overrides will live in the docs repo. I've added your ones here: redpanda-data/docs@3d28a8e

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