docs: align Kubernetes version requirements across doc versions - #814
Conversation
The platform engineer guide and FAQ stated Kubernetes 1.32 or later in every doc version, while the v1.2.x getting started page stated 1.33 or later. The kubectl version was also inconsistent across pages. Kubernetes 1.32 and 1.33 both reached end of life, so current and v1.2.x now state 1.34 or later. The v1.0.x and v1.1.x pages keep their 1.32 baseline and note that the default build workflows need 1.33 or later, since those quick starts create a 1.32 cluster. Signed-off-by: Miraj Abeysekara <miraj@wso2.com>
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe documentation updates Kubernetes and ChangesKubernetes prerequisite documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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: 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 `@docs/getting-started/try-it-out/on-your-environment.mdx`:
- Line 35: Update the cluster version wording in the getting-started
documentation to explicitly identify Kubernetes 1.34+ as the minimum supported
version, replacing the ambiguous “Recommended cluster baseline” phrasing while
retaining the LoadBalancer and default StorageClass requirements.
🪄 Autofix
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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: e272d6a0-bb7d-4ff4-a689-cbad24bce4f1
⛔ Files ignored due to path filters (12)
versioned_docs/version-v1.0.x/getting-started/try-it-out/on-k3d-locally.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.0.x/getting-started/try-it-out/on-your-environment.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.0.x/platform-engineer-guide/deployment-topology.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.0.x/reference/faq.mdis excluded by!versioned_docs/**versioned_docs/version-v1.1.x/getting-started/try-it-out/on-k3d-locally.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.1.x/getting-started/try-it-out/on-your-environment.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.1.x/platform-engineer-guide/deployment-topology.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.1.x/reference/faq.mdis excluded by!versioned_docs/**versioned_docs/version-v1.2.x/getting-started/try-it-out/on-k3d-locally.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.2.x/getting-started/try-it-out/on-your-environment.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.2.x/platform-engineer-guide/deployment-topology.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.2.x/reference/faq.mdis excluded by!versioned_docs/**
📒 Files selected for processing (4)
docs/getting-started/try-it-out/on-k3d-locally.mdxdocs/getting-started/try-it-out/on-your-environment.mdxdocs/platform-engineer-guide/deployment-topology.mdxdocs/reference/faq.md
The getting started pages described the cluster version as a recommended baseline, which reads as optional next to the deployment topology and FAQ pages that state it as a requirement. Signed-off-by: Miraj Abeysekara <miraj@wso2.com>
Purpose
The platform engineer guide and FAQ stated Kubernetes 1.32 or later in every doc version, while the v1.2.x getting started page stated 1.33 or later. The kubectl version was also inconsistent across these pages, and the getting started pages described the cluster version as a recommended baseline rather than a requirement.
Kubernetes 1.32 and 1.33 have both reached end of life, so current and v1.2.x now state 1.34 or later.
Changes
Related Issues
N/A
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors