From cc4a793ff396d4b4c53ad09f8782d5eca6edb583 Mon Sep 17 00:00:00 2001 From: Ryan VanGundy <85766511+rmvangun@users.noreply.github.com> Date: Wed, 3 Dec 2025 09:18:15 -0500 Subject: [PATCH] chore(docs): Adjust navigation Various fixes for the navigation including: * Correcting names of sections in the navigation tree * Ensure "Next" and "Previous" are correct * Remove dead link in tutorial * Add link to the "Securing Secrets" document Signed-off-by: Ryan VanGundy <85766511+rmvangun@users.noreply.github.com> --- docs/guides/contexts.md | 13 +++++++++++++ docs/guides/kustomize.md | 4 ++-- docs/guides/local-workstation.md | 6 +++--- docs/guides/secrets-management.md | 6 +++--- docs/guides/sharing.md | 13 +++++++++++++ docs/guides/templates.md | 13 +++++++++++++ docs/guides/terraform.md | 6 +++--- docs/nav.yaml | 6 +++--- docs/reference/blueprint.md | 4 ++-- docs/reference/contexts.md | 13 +++++++++++++ docs/reference/features.md | 13 +++++++++++++ docs/reference/metadata.md | 10 ++++++++++ docs/reference/schema.md | 13 +++++++++++++ docs/security/secrets.md | 6 +++--- docs/security/trusted-folders.md | 6 +++--- docs/tutorial/hello-world.md | 6 +++--- 16 files changed, 113 insertions(+), 25 deletions(-) diff --git a/docs/guides/contexts.md b/docs/guides/contexts.md index c50d47d2c..fe0bc2a47 100644 --- a/docs/guides/contexts.md +++ b/docs/guides/contexts.md @@ -46,3 +46,16 @@ Additionally, the `WINDSOR_CONTEXT` environment variable is available to you. Contexts are generated from blueprint templates stored in `contexts/_template/`. These templates define reusable blueprint components, features, and schemas that are shared across all contexts. See the [Blueprint Templates](templates.md) guide for details on how templates work. For detailed reference information about contexts, see the [Contexts Reference](../reference/contexts.md). + +
+ {{ footer('Quick Start', '../../quick-start/index.html', 'Local Workstation', '../local-workstation/index.html') }} +
+ + diff --git a/docs/guides/kustomize.md b/docs/guides/kustomize.md index 88f12da11..5b1162abb 100644 --- a/docs/guides/kustomize.md +++ b/docs/guides/kustomize.md @@ -176,7 +176,7 @@ For more information on patch formats, see: - [RFC 6902 - JSON Patch](https://www.rfc-editor.org/rfc/rfc6902)
- {{ footer('Environment Injection', '../environment-injection/index.html', 'Local Workstation', '../local-workstation/index.html') }} + {{ footer('Environment Injection', '../environment-injection/index.html', 'Terraform', '../terraform/index.html') }}
diff --git a/docs/guides/local-workstation.md b/docs/guides/local-workstation.md index 5b4cd9c91..289473c41 100644 --- a/docs/guides/local-workstation.md +++ b/docs/guides/local-workstation.md @@ -262,14 +262,14 @@ kubectl get storageclass In your local development environment, these are both provided by [OpenEBS's dynamic-localpv-provisioner](https://github.com/openebs/dynamic-localpv-provisioner). To further validate, you should run through the [Hello World](../tutorial/hello-world.md) example and verify that you can see `.volumes/pvc-*` folders mounted in to your project folder.
- {{ footer('Kustomize', '../kustomize/index.html', 'Secrets Management', '../secrets/index.html') }} + {{ footer('Contexts', '../contexts/index.html', 'Environment Injection', '../environment-injection/index.html') }}
diff --git a/docs/guides/secrets-management.md b/docs/guides/secrets-management.md index cf3c4b59d..12c7631db 100644 --- a/docs/guides/secrets-management.md +++ b/docs/guides/secrets-management.md @@ -111,15 +111,15 @@ For more details about Windsor's use of secrets along with our recommendations f
- {{ footer('Local Workstation', '../local-workstation/index.html', 'Terraform', '../terraform/index.html') }} + {{ footer('Terraform', '../terraform/index.html', 'Blueprint Templates', '../templates/index.html') }}
diff --git a/docs/guides/sharing.md b/docs/guides/sharing.md index 805c61ffe..a08ba8cf3 100644 --- a/docs/guides/sharing.md +++ b/docs/guides/sharing.md @@ -276,3 +276,16 @@ If `cliVersion` is not specified in `metadata.yaml`, the CLI will: 7. **Use descriptive names**: Make blueprint names clear and descriptive 8. **Tag appropriately**: Use tags that indicate stability (e.g., `latest`, `v1.0.0`, `dev`) +
+ {{ footer('Blueprint Templates', '../templates/index.html', 'Hello, World!', '../../tutorial/hello-world/index.html') }} +
+ + + diff --git a/docs/guides/templates.md b/docs/guides/templates.md index 71d35b7ca..8909a8473 100644 --- a/docs/guides/templates.md +++ b/docs/guides/templates.md @@ -166,3 +166,16 @@ Files referenced in features (via `jsonnet()` or `file()` functions) are resolve - Use `../configs/config.jsonnet` for files in parent directories - Paths work with both local filesystem and in-memory template data (from OCI artifacts) +
+ {{ footer('Secrets Management', '../secrets-management/index.html', 'Sharing Blueprints', '../sharing/index.html') }} +
+ + + diff --git a/docs/guides/terraform.md b/docs/guides/terraform.md index 6cc19043d..ac261d173 100644 --- a/docs/guides/terraform.md +++ b/docs/guides/terraform.md @@ -134,15 +134,15 @@ terraform apply
- {{ footer('Secrets Management', '../secrets/index.html', 'Blueprints', '../../reference/blueprint/index.html') }} + {{ footer('Kustomize', '../kustomize/index.html', 'Secrets Management', '../secrets-management/index.html') }}
diff --git a/docs/nav.yaml b/docs/nav.yaml index 42d186bff..a1b065e5a 100644 --- a/docs/nav.yaml +++ b/docs/nav.yaml @@ -13,13 +13,13 @@ nav: - 'Sharing Blueprints': guides/sharing.md - 'Tutorial': - 'Hello, World!': tutorial/hello-world.md - - 'Sharing Your Blueprint': tutorial/sharing-blueprint.md - 'Security': - 'Trusted Folders': security/trusted-folders.md + - 'Securing Secrets': security/secrets.md - 'Reference': - 'Blueprint': reference/blueprint.md - 'Configuration': reference/configuration.md - 'Contexts': reference/contexts.md - 'Features': reference/features.md - - 'Input Schema': reference/schema.md - - 'Blueprint Metadata': reference/metadata.md + - 'Schema': reference/schema.md + - 'Metadata': reference/metadata.md diff --git a/docs/reference/blueprint.md b/docs/reference/blueprint.md index af22ead96..136b73360 100644 --- a/docs/reference/blueprint.md +++ b/docs/reference/blueprint.md @@ -297,12 +297,12 @@ kustomize: ```
- {{ footer('Terraform', '../../guides/terraform/index.html', 'Configuration', '../configuration/index.html') }} + {{ footer('Securing Secrets', '../../security/secrets/index.html', 'Configuration', '../configuration/index.html') }}
diff --git a/docs/reference/features.md b/docs/reference/features.md index 12e9242e2..e86105981 100644 --- a/docs/reference/features.md +++ b/docs/reference/features.md @@ -261,3 +261,16 @@ Features are automatically loaded from: Features are processed in alphabetical order by name, then merged into the base blueprint. +
+ {{ footer('Contexts', '../contexts/index.html', 'Schema', '../schema/index.html') }} +
+ + + diff --git a/docs/reference/metadata.md b/docs/reference/metadata.md index c25e15400..3996c69df 100644 --- a/docs/reference/metadata.md +++ b/docs/reference/metadata.md @@ -68,3 +68,13 @@ The metadata file should be placed at: 3. **Set `cliVersion` constraints**: Protect users from incompatible CLI versions 4. **Keep descriptions clear**: Help users understand what the blueprint does +
+ {{ footer('Schema', '../schema/index.html', '', '') }} +
+ + + diff --git a/docs/reference/schema.md b/docs/reference/schema.md index a1eb0c065..29f3ef5a1 100644 --- a/docs/reference/schema.md +++ b/docs/reference/schema.md @@ -124,3 +124,16 @@ properties: additionalProperties: false additionalProperties: false ``` + +
+ {{ footer('Features', '../features/index.html', 'Metadata', '../metadata/index.html') }} +
+ + diff --git a/docs/security/secrets.md b/docs/security/secrets.md index f692d61bc..51af060ef 100644 --- a/docs/security/secrets.md +++ b/docs/security/secrets.md @@ -37,14 +37,14 @@ Regularly rotating your secrets is a critical practice for maintaining security. To minimize the risk of secret exposure, limit your shell sessions to specific tasks related to your project. Once you have completed your tasks, promptly close the shell session to reduce the chance of sensitive data being compromised. Dispose of shell sessions when they are no longer needed to maintain security.
- {{ footer('Contexts', '../../reference/contexts/index.html', 'Secrets', '../trusted-folders/index.html') }} + {{ footer('Trusted Folders', '../trusted-folders/index.html', 'Blueprint', '../../reference/blueprint/index.html') }}
diff --git a/docs/security/trusted-folders.md b/docs/security/trusted-folders.md index f93d530eb..0e08224e2 100644 --- a/docs/security/trusted-folders.md +++ b/docs/security/trusted-folders.md @@ -8,14 +8,14 @@ The Windsor CLI performs certain actions based on the contents of project files. To provide additional protection, Windsor will not inject [Windsor environment](../guides/environment-injection.md) values unless you have executed `windsor init` in the project folder. This acknowledges your intention to actively develop within this project. To track this, the Windsor CLI maintains a list of trusted repository folders in a `$HOME/.config/windsor/.trusted` folder. Any folder or subfolder of one listed here, is susceptible to environment execution by Windsor.
- {{ footer('Secrets', '../secrets/index.html', 'Hello World', '../../tutorial/hello-world/index.html') }} + {{ footer('Hello, World!', '../../tutorial/hello-world/index.html', 'Securing Secrets', '../secrets/index.html') }}
diff --git a/docs/tutorial/hello-world.md b/docs/tutorial/hello-world.md index e52b20cc7..b75349d10 100644 --- a/docs/tutorial/hello-world.md +++ b/docs/tutorial/hello-world.md @@ -313,14 +313,14 @@ Pay attention to the `image` field in the pod template. It should reference `${R The `REGISTRY_URL` and `BUILD_ID` variables are automatically provided by Windsor as post-build substitution variables, making it easy to reference locally built images in your Kubernetes manifests.
- {{ footer('Quick Start', '../../quick-start/index.html', 'Sharing Your Blueprint', 'sharing-blueprint.html') }} + {{ footer('Sharing Blueprints', '../../guides/sharing/index.html', 'Trusted Folders', '../../security/trusted-folders/index.html') }}