Fix documentation inconsistencies in Vega CLI terminology and branding#49
Merged
ewassef merged 2 commits intofeature/docsfrom Jan 26, 2026
Merged
Fix documentation inconsistencies in Vega CLI terminology and branding#49ewassef merged 2 commits intofeature/docsfrom
ewassef merged 2 commits intofeature/docsfrom
Conversation
Co-authored-by: ewassef <5826918+ewassef@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation for Vega CLI and workflows
Fix documentation inconsistencies in Vega CLI terminology and branding
Jan 26, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Vega CLI documentation to improve naming/capitalization consistency and correct setup/troubleshooting guidance.
Changes:
- Standardize references from “VDK-managed/VDK clusters” to “Vega-managed/Vega clusters”.
- Normalize “KinD” capitalization in headings/descriptions and related workflow sections.
- Update docs to reflect current repo structure (remove non-existent
clusters/) and clarify default cluster name usage.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/usage/managing-clusters.md | Updates cluster-management wording and KinD capitalization in usage docs. |
| docs/usage/command-reference.md | Adjusts command reference descriptions for Vega-managed clusters and KinD terminology. |
| docs/debugging/troubleshooting.md | Clarifies the default cluster name reference when exporting KinD logs. |
| docs/contribution/development-setup.md | Removes the non-existent clusters/ directory from the documented project structure. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### `vega create cloud-provider-kind` | ||
|
|
||
| Creates a Cloud Provider KIND container that provisions load balancers for services in KinD clusters. | ||
| Creates a Cloud Provider KinD container that provisions load balancers for services in KinD clusters. |
There was a problem hiding this comment.
This PR description indicates all KinD capitalization inconsistencies were fixed, but this file still contains "KIND" in the vega remove cloud-provider-kind description (currently at line 117: "Removes the Cloud Provider KIND container."). Please update that remaining occurrence to "KinD" for consistency.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Addresses 9 review comments regarding inconsistent terminology in the documentation following the VDK → Vega CLI rebranding.
Changes
command-reference.mdandmanaging-clusters.mdclusters/directory from documented structure indevelopment-setup.mdtroubleshooting.mdto say "if using the default cluster name" instead of "for the default"Files Modified
docs/usage/managing-clusters.mddocs/usage/command-reference.mddocs/debugging/troubleshooting.mddocs/contribution/development-setup.md✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.