Skip to content

docs(vks): AWS-CLI-style reference format for all commands#30

Merged
vks-team merged 1 commit into
mainfrom
docs/eks-style-vks-reference
Jul 3, 2026
Merged

docs(vks): AWS-CLI-style reference format for all commands#30
vks-team merged 1 commit into
mainfrom
docs/eks-style-vks-reference

Conversation

@vks-team

@vks-team vks-team commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrite all 22 docs/commands/vks/*.md into a consistent AWS-CLI-style reference (like the EKS CLI docs). Each option now documents the full set of components:

  • Typestring, integer, boolean, list<string>, structure, map
  • Description
  • Required — Yes / No / Conditional
  • Default (when applicable)
  • Possible values (enums / enabled-disabled toggles)
  • Constraints (length, pattern, ranges)
  • For structure flags (e.g. --auto-scale, --upgrade-config, --placement-group, --auto-healing-config): a Members list + Shorthand and JSON syntax blocks.

create-cluster.md is the gold-standard exemplar; the other 21 commands follow it.

How it was built

  • Flags/defaults/required sourced from the Go command files (authoritative), cross-checked against the request DTOs in the API spec for types, enums, and constraints.
  • Fixes found along the way: several commands were missing flags in their docs (e.g. --dry-run on delete-auto-upgrade-config, config-auto-healing, config-auto-upgrade, generate-kubeconfig, update-nodegroup-metadata, upgrade-nodegroup-version); a few types were corrected (booleans/integers); wait is now documented per subcommand with the correct --max-attempts defaults (80 for nodegroup-active, 40 otherwise).

Scope

  • VKS commands only (per request). vServer docs unchanged — can follow in a later PR if wanted.
  • Docs only; no Go code changes.

🤖 Generated with Claude Code

Rewrite every docs/commands/vks/*.md into a consistent AWS-CLI-style reference:
each option shows its type, description, Required, Default, Possible values, and
Constraints; structure flags list their members plus Shorthand and JSON syntax.
Adds a Global options note per command. Also fills in flags that were missing
from the old docs (e.g. --dry-run on several commands) and corrects a few types
(booleans/integers) sourced from the Go flag definitions and the API spec.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vks-team vks-team merged commit 1fe168d into main Jul 3, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant