auto-docs: Update property docs for tag v26.1.13#1806
Merged
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThe documentation version advances from 26.1.12 to 26.1.13. Property data adds three new configuration properties and records the corresponding release changes. Generated references and cluster property documentation describe two Data Lake coordinator limits and development metrics. Existing metadata is updated for controller recovery and Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@modules/reference/partials/properties/cluster-properties.adoc`:
- Around line 17968-17970: Remove the env-cloud conditional BYOC NOTE from the
property description near the affected cluster property, then update the
corresponding source override or metadata so regeneration does not restore it.
Preserve availability information in the generated metadata/settings table.
- Around line 4293-4374: Add the “Introduced in v26.1.13” availability metadata
for datalake_coordinator_max_files_per_commit,
datalake_coordinator_max_pending_files, and enable_development_metrics in their
source configuration entries, then regenerate the documentation partials so each
entry displays the note.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d8b44997-9527-4652-b0ef-4f0e7933e314
📒 Files selected for processing (6)
antora.ymldocs-data/property-overrides.jsondocs-data/redpanda-property-changes-v26.1.12-to-v26.1.13.jsondocs-data/redpanda-property-changes-v26.1.2-to-v26.1.4.jsonmodules/reference/attachments/redpanda-properties-v26.1.13.jsonmodules/reference/partials/properties/cluster-properties.adoc
💤 Files with no reviewable changes (1)
- docs-data/redpanda-property-changes-v26.1.2-to-v26.1.4.json
Comment on lines
+17968
to
+17970
| ifdef::env-cloud[] | ||
| NOTE: This property is available only in Redpanda Cloud BYOC deployments. | ||
| endif::[] |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Remove the BYOC note from the property description.
The supplied guideline prohibits cloud-specific conditional blocks and BYOC notes in property descriptions. Keep availability in the generated metadata/settings table, and update the source override or metadata before regenerating this file.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/partials/properties/cluster-properties.adoc` around lines
17968 - 17970, Remove the env-cloud conditional BYOC NOTE from the property
description near the affected cluster property, then update the corresponding
source override or metadata so regeneration does not restore it. Preserve
availability information in the generated metadata/settings table.
Source: Coding guidelines
JakeSCahill
added a commit
to redpanda-data/docs-extensions-and-macros
that referenced
this pull request
Jul 20, 2026
…ration Overrides are baked into the extracted properties JSON during Phase 1, but updatePropertyOverridesWithVersion stamps new properties into the overrides file in Phase 2 — after extraction. Phase 3 then renders AsciiDoc from the Phase-1 JSON, so properties new in the release being generated were missing their 'Introduced in' line until the following release's run (observed in redpanda-data/docs#1806 for the three properties new in v26.1.13). Stamp the versions into the extracted JSON as well, right after the overrides file, so the same run's AsciiDoc and JSON attachment carry them. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The generation pipeline stamped these versions into property-overrides.json after the AsciiDoc was already rendered, so the three properties new in v26.1.13 were missing their 'Introduced in' line. Regenerated from the stamped data; pipeline fix in docs-extensions-and-macros#214. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The source-code descriptions were telegraphic (subject-less fragments, commit/committed repetition). Added description overrides and regenerated; the C++ source strings are unchanged upstream. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
JakeSCahill
approved these changes
Jul 20, 2026
JakeSCahill
added a commit
to redpanda-data/docs-extensions-and-macros
that referenced
this pull request
Jul 20, 2026
…ration (#214) Overrides are baked into the extracted properties JSON during Phase 1, but updatePropertyOverridesWithVersion stamps new properties into the overrides file in Phase 2 — after extraction. Phase 3 then renders AsciiDoc from the Phase-1 JSON, so properties new in the release being generated were missing their 'Introduced in' line until the following release's run (observed in redpanda-data/docs#1806 for the three properties new in v26.1.13). Stamp the versions into the extracted JSON as well, right after the overrides file, so the same run's AsciiDoc and JSON attachment carry them. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR auto-generates updated Redpanda property documentation for v26.1.13.