docs: add cluster update command to README and docs index #2155
Conversation
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
- Add ksail cluster update to main usage workflow in README.md - Add ksail cluster update to Quick Start section in docs/index.mdx - Ensures consistency with features.mdx and copilot-instructions.md - References feature introduced in v5.30.0 (#2041) The cluster update command was documented in features.mdx and copilot-instructions.md but was missing from the README and docs homepage, causing documentation inconsistency.
Contributor
✅
|
devantler
deleted the
docs/sync-readme-cluster-update-8b3e3d04c525557c
branch
github-project-automation
bot
moved this from 🏃🏻♂️ In Progress
to ✅ Done
in 🌊 Project Board
Contributor
There was a problem hiding this comment.
Pull request overview
Adds ksail cluster update to the primary “happy path” workflows shown to users (GitHub README and docs homepage), aligning the quick-start lifecycle steps with the already-existing reference documentation for the command.
Changes:
- Add a “Update cluster configuration” step to the README usage workflow.
- Add the same step to the docs homepage Quick Start workflow.
- Renumber the subsequent “Connect with K9s” step accordingly.
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds ksail cluster update to the main usage workflow so the GitHub landing page reflects the full cluster lifecycle. |
| docs/src/content/docs/index.mdx | Updates the documentation homepage Quick Start workflow to include ksail cluster update and renumbers steps. |
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.
Summary
Adds the
ksail cluster updatecommand to the main usage workflows in bothREADME.mdanddocs/src/content/docs/index.mdxto ensure documentation consistency across all files.Changes
ksail cluster updateto README.md usage section (step 5)ksail cluster updateto docs/index.mdx Quick Start section (step 5)Context
The
cluster updatecommand was introduced in v5.30.0 (#2041) and was already documented in:docs/src/content/docs/features.mdx(command table).github/copilot-instructions.md(CLI reference)docs/src/content/docs/cli-flags/cluster/cluster-update.mdx(auto-generated)However, it was missing from the main usage workflows shown to users in:
README.md(GitHub landing page)docs/src/content/docs/index.mdx(documentation homepage)This PR closes the documentation gap by adding the cluster update command to both locations, ensuring users see the complete cluster lifecycle workflow.
Related
ksail cluster updatecommand with config diff detection and node scaling #2041