Conversation
WalkthroughDocumentation updates to enforce that Kubernetes version upgrades are no longer optional during platform upgrades starting from ACP 4.2. Three upgrade-related documentation files are updated to remove guidance stating upgrades were optional and replace it with mandatory upgrade policy statements. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/en/overview/release_notes.mdx (1)
45-50: Consider moving the policy update to a dedicated section.The "Kubernetes Version Upgrade Policy Update" logically describes a policy change rather than a deprecated or removed feature. Placing it under "Deprecated and Removed Features" may confuse readers about its nature.
Consider adding a new top-level subsection such as "Policy Changes" or "Breaking Changes" at the same level as "Deprecated and Removed Features" to house this policy update. This would improve documentation structure and make the mandatory upgrade requirement more discoverable.
Example refactor:
### Deprecated and Removed Features -#### Kubernetes Version Upgrade Policy Update - -Starting from **ACP 4.2**, upgrading the Kubernetes version is **no longer optional**. When performing a cluster upgrade, the Kubernetes version must be upgraded together with other platform components. -This change ensures version consistency across the cluster and reduces future maintenance windows. +### Policy Changes + +#### Kubernetes Version Upgrade Policy Update + +Starting from **ACP 4.2**, upgrading the Kubernetes version is **no longer optional**. When performing a cluster upgrade, the Kubernetes version must be upgraded together with other platform components. +This change ensures version consistency across the cluster and reduces future maintenance windows. ### Fixed IssuesAlternatively, if this must remain under "Deprecated and Removed Features," consider adding a brief clarification in the subsection title (e.g., "Kubernetes Version Upgrade Policy Update (mandatory starting ACP 4.2)") to signal the policy nature upfront.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/en/overview/release_notes.mdx(1 hunks)docs/en/upgrade/upgrade_global_cluster.mdx(0 hunks)docs/en/upgrade/upgrade_workload_cluster.mdx(0 hunks)
💤 Files with no reviewable changes (2)
- docs/en/upgrade/upgrade_workload_cluster.mdx
- docs/en/upgrade/upgrade_global_cluster.mdx
🔇 Additional comments (1)
docs/en/overview/release_notes.mdx (1)
47-50: Verify upstream upgrade procedure documentation is clear.The release note clearly states the mandatory policy but does not explain how to perform the upgrade. Per the PR context, other files in this PR (e.g.,
upgrade_global_cluster.mdx,upgrade_workload_cluster.mdx) removed optional-upgrade guidance but did not add replacement guidance.Confirm that the upgrade procedure documentation in those files has been updated (or will be updated in a follow-up) with clear step-by-step instructions for performing the mandatory Kubernetes upgrade. This will prevent users from encountering the policy requirement without actionable guidance.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.