auto-docs: Update property docs for tag v26.1.9#1711
Open
vbotbuildovich wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThis pull request documents the Redpanda v26.1.9 release. The changes bump the Antora version metadata from 26.1.8 to 26.1.9, register a new cluster property 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)
✏️ 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: 1
🤖 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`:
- Line 6271: Remove license/entitlement metadata from the property description
that starts "Whether the cluster active logical version is advanced
automatically..." by deleting the sentence "Setting this to false is an
Enterprise feature and requires a valid license." and any similar licensing
phrasing; keep only behavior-focused guidance (including the note about
finalization behavior), and rely on the existing separate license note block
below to document licensing requirements.
🪄 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: 1203292a-ab80-4a75-812b-466b0a1a6c2d
📒 Files selected for processing (6)
antora.ymldocs-data/property-overrides.jsondocs-data/redpanda-property-changes-v26.1.7-to-v26.1.8.jsondocs-data/redpanda-property-changes-v26.1.8-to-v26.1.9.jsonmodules/reference/attachments/redpanda-properties-v26.1.9.jsonmodules/reference/partials/properties/cluster-properties.adoc
💤 Files with no reviewable changes (1)
- docs-data/redpanda-property-changes-v26.1.7-to-v26.1.8.json
👮 Files not reviewed due to content moderation or server errors (1)
- modules/reference/attachments/redpanda-properties-v26.1.9.json
|
|
||
| === features_auto_finalization | ||
|
|
||
| Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Setting this to false is an Enterprise feature and requires a valid license. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades. |
Contributor
There was a problem hiding this comment.
Remove license metadata from the behavior description
Line 6271 mixes behavioral guidance with licensing metadata. Keep the description behavior-focused and rely on the existing license note block below.
Proposed fix
-Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Setting this to false is an Enterprise feature and requires a valid license. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades.
+Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades.As per coding guidelines, "In property descriptions, keep descriptions focused on behavior and avoid metadata information like version availability, cloud availability, license requirements, requires restart status, default values, and type information".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Setting this to false is an Enterprise feature and requires a valid license. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades. | |
| Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades. |
🤖 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` at line 6271,
Remove license/entitlement metadata from the property description that starts
"Whether the cluster active logical version is advanced automatically..." by
deleting the sentence "Setting this to false is an Enterprise feature and
requires a valid license." and any similar licensing phrasing; keep only
behavior-focused guidance (including the note about finalization behavior), and
rely on the existing separate license note block below to document licensing
requirements.
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
1 participant
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.9.