Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions docs/guides/contexts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<div>
{{ footer('Quick Start', '../../quick-start/index.html', 'Local Workstation', '../local-workstation/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../../quick-start/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../local-workstation/index.html';
});
</script>
4 changes: 2 additions & 2 deletions docs/guides/kustomize.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,14 +176,14 @@ For more information on patch formats, see:
- [RFC 6902 - JSON Patch](https://www.rfc-editor.org/rfc/rfc6902)

<div>
{{ footer('Environment Injection', '../environment-injection/index.html', 'Local Workstation', '../local-workstation/index.html') }}
{{ footer('Environment Injection', '../environment-injection/index.html', 'Terraform', '../terraform/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../environment-injection/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../local-workstation/index.html';
window.location.href = '../terraform/index.html';
});
</script>
6 changes: 3 additions & 3 deletions docs/guides/local-workstation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<div>
{{ footer('Kustomize', '../kustomize/index.html', 'Secrets Management', '../secrets/index.html') }}
{{ footer('Contexts', '../contexts/index.html', 'Environment Injection', '../environment-injection/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../kustomize/index.html';
window.location.href = '../contexts/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../secrets/index.html';
window.location.href = '../environment-injection/index.html';
});
</script>
6 changes: 3 additions & 3 deletions docs/guides/secrets-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,15 +111,15 @@ For more details about Windsor's use of secrets along with our recommendations f
<!-- Footer Start -->

<div>
{{ footer('Local Workstation', '../local-workstation/index.html', 'Terraform', '../terraform/index.html') }}
{{ footer('Terraform', '../terraform/index.html', 'Blueprint Templates', '../templates/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../local-workstation/index.html';
window.location.href = '../terraform/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../terraform/index.html';
window.location.href = '../templates/index.html';
});
</script>

Expand Down
13 changes: 13 additions & 0 deletions docs/guides/sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)

<div>
{{ footer('Blueprint Templates', '../templates/index.html', 'Hello, World!', '../../tutorial/hello-world/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../templates/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../../tutorial/hello-world/index.html';
});
</script>

13 changes: 13 additions & 0 deletions docs/guides/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<div>
{{ footer('Secrets Management', '../secrets-management/index.html', 'Sharing Blueprints', '../sharing/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../secrets-management/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../sharing/index.html';
});
</script>

6 changes: 3 additions & 3 deletions docs/guides/terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,15 @@ terraform apply
<!-- Footer Start -->

<div>
{{ footer('Secrets Management', '../secrets/index.html', 'Blueprints', '../../reference/blueprint/index.html') }}
{{ footer('Kustomize', '../kustomize/index.html', 'Secrets Management', '../secrets-management/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../secrets/index.html';
window.location.href = '../kustomize/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../kustomize/index.html';
window.location.href = '../secrets-management/index.html';
});
</script>

Expand Down
6 changes: 3 additions & 3 deletions docs/nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/reference/blueprint.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,12 +297,12 @@ kustomize:
```

<div>
{{ footer('Terraform', '../../guides/terraform/index.html', 'Configuration', '../configuration/index.html') }}
{{ footer('Securing Secrets', '../../security/secrets/index.html', 'Configuration', '../configuration/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../../security/terraform/index.html';
window.location.href = '../../security/secrets/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../configuration/index.html';
Expand Down
13 changes: 13 additions & 0 deletions docs/reference/contexts.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,16 @@ windsor context get
```

The current context is also available via the `WINDSOR_CONTEXT` environment variable.

<div>
{{ footer('Configuration', '../configuration/index.html', 'Features', '../features/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../configuration/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../features/index.html';
});
</script>
13 changes: 13 additions & 0 deletions docs/reference/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,3 +261,16 @@ Features are automatically loaded from:

Features are processed in alphabetical order by name, then merged into the base blueprint.

<div>
{{ footer('Contexts', '../contexts/index.html', 'Schema', '../schema/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../contexts/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../schema/index.html';
});
</script>

10 changes: 10 additions & 0 deletions docs/reference/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<div>
{{ footer('Schema', '../schema/index.html', '', '') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../schema/index.html';
});
</script>

13 changes: 13 additions & 0 deletions docs/reference/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,16 @@ properties:
additionalProperties: false
additionalProperties: false
```

<div>
{{ footer('Features', '../features/index.html', 'Metadata', '../metadata/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../features/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../metadata/index.html';
});
</script>
6 changes: 3 additions & 3 deletions docs/security/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<div>
{{ footer('Contexts', '../../reference/contexts/index.html', 'Secrets', '../trusted-folders/index.html') }}
{{ footer('Trusted Folders', '../trusted-folders/index.html', 'Blueprint', '../../reference/blueprint/index.html') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../../reference/contexts/index.html';
window.location.href = '../trusted-folders/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../trusted-folders/index.html';
window.location.href = '../../reference/blueprint/index.html';
});
</script>
6 changes: 3 additions & 3 deletions docs/security/trusted-folders.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<div>
{{ 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') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../secrets/index.html';
window.location.href = '../../tutorial/hello-world/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = '../../tutorial/hello-world/index.html';
window.location.href = '../secrets/index.html';
});
</script>
6 changes: 3 additions & 3 deletions docs/tutorial/hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<div>
{{ 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') }}
</div>

<script>
document.getElementById('previousButton').addEventListener('click', function() {
window.location.href = '../../quick-start/index.html';
window.location.href = '../../guides/sharing/index.html';
});
document.getElementById('nextButton').addEventListener('click', function() {
window.location.href = 'sharing-blueprint.html';
window.location.href = '../../security/trusted-folders/index.html';
});
</script>
Loading