Skip to content

Fix documentation inconsistencies in Vega CLI terminology and branding #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ewassef merged 2 commits into from
Jan 26, 2026
Merged

Fix documentation inconsistencies in Vega CLI terminology and branding #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55edfc1
Initial plan
Copilot Jan 26, 2026
3f2477b
Fix documentation inconsistencies per review comments
Copilot Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/contribution/development-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,7 @@ VDK/
│ ├── Constants/ # Configuration constants
│ ├── Certs/ # TLS certificates
│ └── ConfigMounts/ # Container configuration files
├── docs/ # Documentation
└── clusters/ # Flux GitOps configurations
└── docs/ # Documentation
```

## Key Technologies
Expand Down
2 changes: 1 addition & 1 deletion docs/debugging/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Common issues and how to resolve them.
kind export logs --name <cluster-name> ./kind-logs
```

Replace `<cluster-name>` with the name of the cluster that failed (or `vdk` for the default).
Replace `<cluster-name>` with the name of the cluster that failed (or `vdk` if using the default cluster name).
- **Network Issues:** Firewalls or VPNs can sometimes interfere with KinD's networking.
- **KinD Version Mismatch:** If you get version-related errors, update the version info:

Expand Down
6 changes: 3 additions & 3 deletions docs/usage/command-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ vega create proxy

### `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.
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.

**Usage:**
```bash
Expand Down Expand Up @@ -127,7 +127,7 @@ vega remove cloud-provider-kind

### `vega list clusters`

Lists all VDK-managed KinD clusters.
Lists all Vega-managed KinD clusters.

**Usage:**
```bash
Expand Down Expand Up @@ -161,7 +161,7 @@ vega update k8s
### `vega update clusters`

Updates cluster configurations including TLS certificates. This command:
- Checks all VDK clusters for outdated certificates
- Checks all Vega clusters for outdated certificates
- Updates Vega-managed TLS secrets (`dev-tls` or annotated with `vega.dev/managed=true`)
- Restarts gateway deployments to pick up new certificates
- Regenerates nginx reverse proxy configuration
Expand Down
10 changes: 5 additions & 5 deletions docs/usage/managing-clusters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Learn how to manage your Vega-created KinD clusters.
vega list clusters
```

This lists all VDK-managed clusters. Example output:
This lists all Vega-managed clusters. Example output:

```
vdk
Expand Down Expand Up @@ -50,7 +50,7 @@ vega update clusters

This command:

- Scans all VDK clusters for Vega-managed TLS secrets
- Scans all Vega clusters for Vega-managed TLS secrets
- Updates certificates that don't match the local certificates
- Restarts gateway deployments to pick up new certificates
- Regenerates nginx reverse proxy configuration
Expand Down Expand Up @@ -91,9 +91,9 @@ Remove it:
vega remove proxy
```

### Cloud Provider KIND
### Cloud Provider KinD

Create the Cloud Provider KIND for load balancer support:
Create the Cloud Provider KinD for load balancer support:

```bash
vega create cloud-provider-kind
Expand All @@ -119,7 +119,7 @@ Verify connectivity:
kubectl cluster-info --context kind-my-cluster
```

## Updating Kind Version Information
## Updating KinD Version Information

If you've updated KinD and need to enable new Kubernetes versions:

Expand Down