auto-docs: Update property docs for tag v26.1.2#1655
Merged
JakeSCahill merged 11 commits intomainfrom Apr 7, 2026
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:
📝 WalkthroughWalkthroughThis PR updates documentation and configuration metadata for Redpanda version 26.1.2. Changes include bumping version attributes in antora.yml from 26.1.1 to 26.1.2, updating JSON property change comparison metadata, and adding a new Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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: 3
🧹 Nitpick comments (2)
modules/reference/attachments/redpanda-properties-v26.1.2.json (1)
7582-7582: Minor wording cleanup needed in description.Line 7582 reads “delivered to learner”; this should be “delivered to the learner.”
✏️ Suggested wording fix
- "description": "Initial local retention size target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to learner when joining the partition replica set.", + "description": "Initial local retention size target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.",🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/reference/attachments/redpanda-properties-v26.1.2.json` at line 7582, In the JSON property whose description begins "Initial local retention size target for partitions of topics with Tiered Storage enabled..." update the wording to change "delivered to learner" to "delivered to the learner" so the sentence reads correctly; locate the description string in modules/reference/attachments/redpanda-properties-v26.1.2.json (the entry at or near the shown snippet) and replace that phrase while preserving the rest of the text and punctuation.modules/reference/partials/properties/cluster-properties.adoc (1)
4987-4993: Prefer auto-title xrefs for these new links.Please switch these xrefs to empty brackets (
xref:...[]) so link text is sourced from page titles consistently.Suggested edit
-* xref:manage:tiered-storage.adoc[Tiered Storage] +* xref:manage:tiered-storage.adoc[] -* xref:develop:manage-topics/cloud-topics.adoc[Manage Cloud Topics] +* xref:develop:manage-topics/cloud-topics.adoc[]Based on learnings: AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/reference/partials/properties/cluster-properties.adoc` around lines 4987 - 4993, Replace the explicit link text xref instances so the page title is used automatically: change xref:manage:tiered-storage.adoc[Tiered Storage] to xref:manage:tiered-storage.adoc[] and change xref:develop:manage-topics/cloud-topics.adoc[Manage Cloud Topics] to xref:develop:manage-topics/cloud-topics.adoc[] (these are the two xref entries in the Related topics block).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs-data/redpanda-property-changes-v26.1.1-to-v26.1.2.json`:
- Around line 4-5: The "newVersion" field currently set to "v26.1.2" documents a
non-existent Redpanda release; update the "newVersion" value to "v26.1.1" or
mark this as pre-release by adding a clear flag/comment, or remove the file if
it’s not needed; locate the JSON entry with the "newVersion" key (and optionally
the "timestamp" field) in this file and change the version string to "v26.1.1"
or add a "preRelease": true/ "note": "pre-release for v26.1.2" entry to make the
intent explicit before merging.
In `@modules/reference/attachments/redpanda-properties-v26.1.2.json`:
- Around line 8703-8708: The description for the property leader_balancer_mode
is out of sync with the enum: it only explains `calibrated` and `random` (and
mentions legacy mappings) but the enum now includes `greedy`; update the
description string for leader_balancer_mode to document what the `greedy` mode
does and how it differs from `calibrated`/`random` (and clarify any legacy
mapping behavior), e.g., add a short sentence describing `greedy`'s
leader-movement heuristic and whether legacy values map to `calibrated` or to
`greedy`, so the description matches the enum entries.
In `@modules/reference/partials/properties/cluster-properties.adoc`:
- Around line 11502-11505: The documentation lists `greedy` as an accepted mode
but the mode description only explains `calibrated` and `random`; update the
mode description section to add a short definition for the `greedy` enum value
(alongside `calibrated` and `random`) that explains its selection behavior
(e.g., selects highest-scoring candidates deterministically/locally optimized
per step) so readers understand how `greedy` differs from `calibrated` and
`random`.
---
Nitpick comments:
In `@modules/reference/attachments/redpanda-properties-v26.1.2.json`:
- Line 7582: In the JSON property whose description begins "Initial local
retention size target for partitions of topics with Tiered Storage enabled..."
update the wording to change "delivered to learner" to "delivered to the
learner" so the sentence reads correctly; locate the description string in
modules/reference/attachments/redpanda-properties-v26.1.2.json (the entry at or
near the shown snippet) and replace that phrase while preserving the rest of the
text and punctuation.
In `@modules/reference/partials/properties/cluster-properties.adoc`:
- Around line 4987-4993: Replace the explicit link text xref instances so the
page title is used automatically: change xref:manage:tiered-storage.adoc[Tiered
Storage] to xref:manage:tiered-storage.adoc[] and change
xref:develop:manage-topics/cloud-topics.adoc[Manage Cloud Topics] to
xref:develop:manage-topics/cloud-topics.adoc[] (these are the two xref entries
in the Related topics block).
🪄 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: 585ebb07-0a98-46f5-84b7-295192bca595
📒 Files selected for processing (5)
antora.ymldocs-data/redpanda-property-changes-v26.1.1-to-v26.1.2.jsonmodules/reference/attachments/redpanda-properties-v26.1.2.jsonmodules/reference/partials/properties/cluster-properties.adocmodules/reference/partials/properties/topic-properties.adoc
- Add override for leader_balancer_mode documenting the new greedy strategy which distributes leadership evenly per topic - Restore xrefs to Tiered Storage and Cloud Topics pages in storage mode property descriptions (default_redpanda_storage_mode, redpanda.storage.mode, initial_retention_local_target_*_default)
… xrefs - Add override for leader_balancer_mode documenting the new greedy strategy - Embed AsciiDoc conditionals in storage mode property descriptions to preserve xrefs for self-managed and plain text for cloud docs
Update description to help users choose between calibrated, random, and greedy modes with clearer guidance on when to use each option.
JakeSCahill
force-pushed
the
update-property-docs-v26.1.2
branch
from
1424d58 to
ebb2141
Compare
JakeSCahill
approved these changes
Apr 7, 2026
- Add release notes section for greedy leader balancer mode - Add (v26.1.2+) version note to greedy option in config reference
Document the leader_balancer_mode options (calibrated, random, greedy) in the cluster balancing guide.
- Add section to benchmark.adoc recommending greedy mode for consistent results - Update random mode description: "fallback" instead of "legacy compatibility" - Regenerate property docs with updated descriptions
JakeSCahill
reviewed
Apr 7, 2026
JakeSCahill
reviewed
Apr 7, 2026
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
- Remove greedy from leader_balancer_mode description (internal use only) - Remove greedy section from release notes - Remove leadership balancing modes table from cluster-balancing.adoc - Remove greedy TIP from benchmark.adoc - Add _comment field explaining exclusion Note: The accepted_values override doesn't affect the metadata table row. The property automation needs updating to support excluding enum values from the generated table.
Regenerated with updated tooling that respects accepted_values override. leader_balancer_mode now shows only calibrated and random options (greedy excluded per internal-only status).
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.2.