Skip to content

Commit

Permalink
docs: Add redirects to module section
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Prodan <[email protected]>
  • Loading branch information
stefanprodan committed Jan 8, 2024
1 parent 3fc096e commit 29e23f5
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 217 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ packaged as [Modules](https://timoni.sh/module/), using type-safe
Kubernetes templates and rich customisation options for end-users.

The app configuration packaged in a Module is
[distributed](https://timoni.sh/module-distribution/) as an
[distributed](https://timoni.sh/cue/module/publishing/) as an
Open Container Initiative (OCI) artifact, next to the app images,
in a container registry. Timoni Modules are semantically versioned
and cryptographically [signed](https://timoni.sh/module-sign/).
and cryptographically [signed](https://timoni.sh/cue/module/signing/).

With Timoni, platform engineers can manage the lifecycle of Kubernetes
controllers, including the upgrade of CRDs. Module authors can
[import CRD schemas](https://timoni.sh/module/#kubernetes-crds)
[import CRD schemas](https://timoni.sh/cue/module/custom-resources/)
from YAML files and incorporate Kubernetes custom resources
in their app deployments.

Expand Down
104 changes: 0 additions & 104 deletions docs/module-distribution.md

This file was deleted.

103 changes: 0 additions & 103 deletions docs/module-sign.md

This file was deleted.

11 changes: 4 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,8 @@ plugins:
- search
- redirects:
redirect_maps:
'module-semver.md': 'module-distribution.md'
'bundles.md': 'bundle.md'
'values.md': 'bundle.md'
'module-sign.md': 'cue/module/signing.md'
'module-distribution.md': 'cue/module/publishing.md'

markdown_extensions:
- attr_list
Expand Down Expand Up @@ -96,10 +95,8 @@ nav:
- Bundle distribution: bundle-distribution.md
- Bundle secrets injection: bundle-secrets.md
- Multi-cluster deployments: bundle-multi-cluster.md
- Module Development:
- Module structure: module.md
- Module distribution: module-distribution.md
- Module signing: module-sign.md
- App Packaging:
- Module specification: module.md
- Integrations:
- GitHub Actions: github-actions.md
- Flux AIO Distribution: flux-aio.md
Expand Down

0 comments on commit 29e23f5

Please sign in to comment.