From 55edfc1a7fb11c576b28ed8237595dc45313d9ba Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 26 Jan 2026 16:47:32 +0000 Subject: [PATCH 1/2] Initial plan From 3f2477bb94f2b3f6bb584d2ce8bd760677eecb11 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 26 Jan 2026 16:49:11 +0000 Subject: [PATCH 2/2] Fix documentation inconsistencies per review comments Co-authored-by: ewassef <5826918+ewassef@users.noreply.github.com> --- docs/contribution/development-setup.md | 3 +-- docs/debugging/troubleshooting.md | 2 +- docs/usage/command-reference.md | 6 +++--- docs/usage/managing-clusters.md | 10 +++++----- 4 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/contribution/development-setup.md b/docs/contribution/development-setup.md index b22168c..5dbd2d4 100644 --- a/docs/contribution/development-setup.md +++ b/docs/contribution/development-setup.md @@ -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 diff --git a/docs/debugging/troubleshooting.md b/docs/debugging/troubleshooting.md index 7b4da98..6724bd7 100644 --- a/docs/debugging/troubleshooting.md +++ b/docs/debugging/troubleshooting.md @@ -12,7 +12,7 @@ Common issues and how to resolve them. kind export logs --name ./kind-logs ``` - Replace `` with the name of the cluster that failed (or `vdk` for the default). + Replace `` 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: diff --git a/docs/usage/command-reference.md b/docs/usage/command-reference.md index cc76a08..6b28cff 100644 --- a/docs/usage/command-reference.md +++ b/docs/usage/command-reference.md @@ -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. **Usage:** ```bash @@ -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 @@ -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 diff --git a/docs/usage/managing-clusters.md b/docs/usage/managing-clusters.md index 0a0e4b7..03b540f 100644 --- a/docs/usage/managing-clusters.md +++ b/docs/usage/managing-clusters.md @@ -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 @@ -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 @@ -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 @@ -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: