Skip to content

Conversation

@botantler
Copy link
Contributor

@botantler botantler bot commented Feb 11, 2026

Summary

Adds the ksail cluster update command to the main usage workflow in README.md.

What Changed

  • Added step 5 documenting ksail cluster update command in the usage section
  • Renumbered step 5 → 6 (Connect to cluster with K9s)
  • Included contextual comment explaining when to use the command

Why

The cluster update command was introduced in v5.30.0 (#2041) and documented in .github/copilot-instructions.md (#2140), but was missing from the README.md usage section. This creates a documentation gap for users who rely on the README as their primary reference.

Documentation Consistency

After this change:

  • .github/copilot-instructions.md - has cluster update
  • README.md - now has cluster update

Testing

  • Verified the change renders correctly in Markdown
  • Confirmed consistency with copilot-instructions.md command reference
  • No code changes - documentation only

Related

AI generated by Update Docs

- Add ksail cluster update command to main usage workflow
- Explain when to use it (after modifying ksail.yaml)
- Ensures consistency with .github/copilot-instructions.md
- References feature introduced in v5.30.0 (#2041)
@github-project-automation github-project-automation bot moved this to 🏃🏻‍♂️ In Progress in 🌊 Project Board Feb 11, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2026

⚠️MegaLinter analysis: Success with warnings

⚠️ MARKDOWN / markdownlint - 38 errors
.github/aw/create-agentic-workflow.md:84 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Read the gh-aw instructions"]
.github/aw/create-shared-agentic-workflow.md:16 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Build on agentic workflows"]
.github/aw/create-shared-agentic-workflow.md:23 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Prefer Docker Solutions"]
.github/aw/create-shared-agentic-workflow.md:30 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Support Read-Only Tools"]
.github/aw/create-shared-agentic-workflow.md:37 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Move Write Operations to Safe ..."]
.github/aw/create-shared-agentic-workflow.md:44 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Process Agent Output in Safe J..."]
.github/aw/create-shared-agentic-workflow.md:57 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Documentation"]
.github/aw/create-shared-agentic-workflow.md:153 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Example: Processing Agent Outp..."]
.github/aw/debug-agentic-workflow.md:19 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Example: Debugging from a work..."]
.github/aw/debug-agentic-workflow.md:25 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/debug-agentic-workflow.md:39 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/debug-agentic-workflow.md:53 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Prerequisites"]
.github/aw/debug-agentic-workflow.md:60 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Key Commands Available"]
.github/aw/debug-agentic-workflow.md:91 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/debug-agentic-workflow.md:124 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/debug-agentic-workflow.md:162 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/debug-agentic-workflow.md:199 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/debug-agentic-workflow.md:208 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/debug-agentic-workflow.md:218 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/debug-agentic-workflow.md:256 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/debug-agentic-workflow.md:468 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/serena-tool.md:118 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/serena-tool.md:126 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/serena-tool.md:135 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/serena-tool.md:174 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/update-agentic-workflow.md:58 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Read the gh-aw instructions"]
.github/aw/update-agentic-workflow.md:523 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/aw/upgrade-agentic-workflows.md:13 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Prerequisites"]
.github/aw/upgrade-agentic-workflows.md:20 error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Key Commands Available"]
.github/aw/upgrade-agentic-workflows.md:265 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/skills/refactor/SKILL.md:37 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/skills/refactor/SKILL.md:563 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/workflows/promote-ksail.md:118 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/workflows/promote-ksail.md:126 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
.github/workflows/update-docs.md:145 error MD028/no-blanks-blockquote Blank line inside blockquote
docs/src/content/docs/faq.md:226 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
pkg/svc/chat/docs/faq.md:226 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
vsce/README.md:98 error MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]

✅ Linters with no issues

actionlint, bash-exec, git_diff, hadolint, jscpd, jsonlint, lychee, markdown-table-formatter, prettier, prettier, shellcheck, shfmt, stylelint, syft, trivy-sbom, trufflehog, v8r, v8r, yamllint

See detailed reports in MegaLinter artifacts

MegaLinter is graciously provided by OX Security

@devantler devantler marked this pull request as ready for review February 11, 2026 20:38
@devantler devantler self-requested a review as a code owner February 11, 2026 20:38
Copilot AI review requested due to automatic review settings February 11, 2026 20:38
@devantler devantler enabled auto-merge February 11, 2026 20:38
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project’s primary quickstart workflow in README.md to include the ksail cluster update lifecycle command, closing a documentation gap for users who rely on the README as their main entry point.

Changes:

  • Added a new usage step documenting ksail cluster update for applying configuration changes after editing ksail.yaml.
  • Renumbered the subsequent “Connect to the cluster with K9s” step accordingly.

@devantler devantler added this pull request to the merge queue Feb 11, 2026
Merged via the queue into main with commit 76834f2 Feb 11, 2026
35 checks passed
@devantler devantler deleted the docs/add-cluster-update-to-readme-547cb8af701e5628 branch February 11, 2026 20:43
@github-project-automation github-project-automation bot moved this from 🏃🏻‍♂️ In Progress to ✅ Done in 🌊 Project Board Feb 11, 2026
botantler bot pushed a commit that referenced this pull request Feb 11, 2026
- Add step 5 for cluster update in Quick Start workflow
- Ensures docs/index.mdx matches README.md usage flow
- Completes documentation synchronization for cluster update command
- Follows PR #2154 and #2140 which added cluster update to README and features
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

1 participant