From 01fdb21c7293a2c4af64ec0e8711167683d73b50 Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Fri, 13 Nov 2026 14:16:38 +0200 Subject: [PATCH 1/2] First step of documentation restructuring Adding the structure agreed in https://github.com/kptdev/kpt/issues/4451 Signed-off-by: Gergely Csatari --- AGENTS.md | 4 +- cli/main.go | 14 +-- documentation/README.md | 4 +- documentation/assets/scss/_sidebar-left.scss | 3 +- documentation/content/en/_index.md | 2 +- .../en/book/01-getting-started/_index.md | 4 +- .../content/en/book/02-concepts/_index.md | 4 +- .../content/en/book/03-packages/_index.md | 10 +-- .../en/book/04-using-functions/_index.md | 10 +-- .../en/book/05-developing-functions/_index.md | 2 +- .../en/book/06-deploying-packages/_index.md | 14 +-- .../en/book/08-ci-user-guide/_index.md | 2 +- .../en/documentation/1-overview/_index.md | 8 ++ .../en/documentation/2-concepts/_index.md | 8 ++ .../en/documentation/2-concepts/functions.md | 8 ++ .../en/documentation/2-concepts/packages.md | 8 ++ .../en/documentation/2-concepts/workflows.md | 8 ++ .../en/documentation/3-intallation/_index.md | 8 ++ .../en/documentation/3-intallation/docker.md | 8 ++ .../documentation/3-intallation/homebrew.md | 8 ++ .../en/documentation/3-intallation/source.md | 8 ++ .../documentation/4-getting-started/_index.md | 8 ++ .../4-getting-started/quickstart.md | 8 ++ .../4-getting-started/system-requirements.md | 8 ++ .../en/documentation/5-guides/_index.md | 8 ++ .../5-guides/advanced-topics/_index.md | 6 ++ .../advanced-topics/tenant-onboarding.md | 8 ++ .../understanding-3-way-merge.md | 8 ++ .../value-propagation-pattern.md | 8 ++ .../variant-constructor-pattern.md | 8 ++ .../documentation/5-guides/ci-user-guide.md | 8 ++ .../5-guides/krm-function-developer-guide.md | 8 ++ .../5-guides/working-with-functions/_index.md | 6 ++ .../declarative-function-execution.md | 8 ++ .../developing-functions.md | 8 ++ .../function-results.md | 8 ++ .../imperative-function-execution.md | 8 ++ .../working-with-kpt-packages/_index.md | 6 ++ .../composing-a-package.md | 8 ++ .../creating-a-package.md | 8 ++ .../deploying-packages.md | 8 ++ .../editing-a-package.md | 8 ++ .../excluding-files-with-krmignore.md | 8 ++ .../exploring-a-package.md | 8 ++ .../getting-a-package.md | 8 ++ .../publishing-a-package.md | 8 ++ .../rendering-a-package.md | 8 ++ .../updating-a-package/_index.md | 8 ++ .../effective-customizations.md | 8 ++ .../en/documentation/6-references/_index.md | 14 +++ .../6-references}/annotations/_index.md | 13 ++- .../annotations/apply-time-mutation/_index.md | 8 +- .../annotations/depends-on/_index.md | 2 + .../annotations/local-config/_index.md | 2 + .../6-references}/cli/_index.md | 14 ++- .../6-references}/cli/alpha/_index.md | 5 +- .../6-references}/cli/alpha/license/_index.md | 5 +- .../cli/alpha/license/info/_index.md | 2 + .../6-references}/cli/alpha/live/_index.md | 6 +- .../cli/alpha/live/plan/_index.md | 2 + .../6-references}/cli/alpha/sync/_index.md | 5 +- .../cli/alpha/sync/create/_index.md | 2 + .../cli/alpha/sync/delete/_index.md | 2 + .../cli/alpha/sync/get/_index.md | 2 + .../6-references}/cli/alpha/wasm/_index.md | 5 +- .../cli/alpha/wasm/pull/_index.md | 2 + .../cli/alpha/wasm/push/_index.md | 2 + .../6-references}/cli/fn/_index.md | 5 +- .../6-references}/cli/fn/doc/_index.md | 2 + .../6-references}/cli/fn/eval/_index.md | 2 + .../6-references}/cli/fn/render/_index.md | 2 + .../6-references}/cli/fn/sink/_index.md | 2 + .../6-references}/cli/fn/source/_index.md | 2 + .../6-references}/cli/live/_index.md | 6 +- .../6-references}/cli/live/apply/_index.md | 2 + .../6-references}/cli/live/destroy/_index.md | 2 + .../6-references}/cli/live/init/_index.md | 2 + .../cli/live/install-resource-group/_index.md | 2 + .../6-references}/cli/live/migrate/_index.md | 2 + .../6-references}/cli/live/status/_index.md | 4 +- .../6-references}/cli/pkg/_index.md | 5 +- .../6-references}/cli/pkg/cat/_index.md | 2 + .../6-references}/cli/pkg/diff/_index.md | 2 + .../6-references}/cli/pkg/get/_index.md | 2 + .../6-references}/cli/pkg/init/_index.md | 2 + .../6-references}/cli/pkg/tree/_index.md | 2 + .../6-references}/cli/pkg/update/_index.md | 2 + .../6-references}/schema/_index.md | 7 +- .../schema/crd-status-convention/_index.md | 6 +- .../schema/function-result-list/_index.md | 6 +- .../6-references}/schema/kptfile/_index.md | 6 +- .../6-references}/schema/kptfile/kptfile.json | 0 .../6-references}/schema/kptfile/kptfile.yaml | 0 .../6-references}/schema/plan/_index.md | 6 +- .../6-references}/schema/plan/plan.yaml | 0 .../schema/resource-list/_index.md | 6 +- .../content/en/documentation/7-FAQ/_index.md | 8 ++ .../en/documentation/8-contributing/_index.md | 8 ++ .../8-contributing/code-contribution.md | 8 ++ .../documentation-contribution/_index.md | 8 ++ .../error-messages-style-guide.md | 8 ++ .../content/en/documentation/_index.md | 8 ++ documentation/content/en/faq.md | 2 +- .../content/en/guides/3-way-merge.md | 10 +-- documentation/content/en/reference/_index.md | 13 --- .../layouts/partials/sidebar-tree.html | 1 - documentation/layouts/partials/sidebar.html | 85 +++++++++++++++++++ scripts/generate-schema.sh | 12 +-- 108 files changed, 583 insertions(+), 133 deletions(-) create mode 100644 documentation/content/en/documentation/1-overview/_index.md create mode 100644 documentation/content/en/documentation/2-concepts/_index.md create mode 100644 documentation/content/en/documentation/2-concepts/functions.md create mode 100644 documentation/content/en/documentation/2-concepts/packages.md create mode 100644 documentation/content/en/documentation/2-concepts/workflows.md create mode 100644 documentation/content/en/documentation/3-intallation/_index.md create mode 100644 documentation/content/en/documentation/3-intallation/docker.md create mode 100644 documentation/content/en/documentation/3-intallation/homebrew.md create mode 100644 documentation/content/en/documentation/3-intallation/source.md create mode 100644 documentation/content/en/documentation/4-getting-started/_index.md create mode 100644 documentation/content/en/documentation/4-getting-started/quickstart.md create mode 100644 documentation/content/en/documentation/4-getting-started/system-requirements.md create mode 100644 documentation/content/en/documentation/5-guides/_index.md create mode 100644 documentation/content/en/documentation/5-guides/advanced-topics/_index.md create mode 100644 documentation/content/en/documentation/5-guides/advanced-topics/tenant-onboarding.md create mode 100644 documentation/content/en/documentation/5-guides/advanced-topics/understanding-3-way-merge.md create mode 100644 documentation/content/en/documentation/5-guides/advanced-topics/value-propagation-pattern.md create mode 100644 documentation/content/en/documentation/5-guides/advanced-topics/variant-constructor-pattern.md create mode 100644 documentation/content/en/documentation/5-guides/ci-user-guide.md create mode 100644 documentation/content/en/documentation/5-guides/krm-function-developer-guide.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-functions/_index.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-functions/declarative-function-execution.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-functions/developing-functions.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-functions/function-results.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-functions/imperative-function-execution.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/_index.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/composing-a-package.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/creating-a-package.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/deploying-packages.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/editing-a-package.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/excluding-files-with-krmignore.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/exploring-a-package.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/getting-a-package.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/publishing-a-package.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/rendering-a-package.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/updating-a-package/_index.md create mode 100644 documentation/content/en/documentation/5-guides/working-with-kpt-packages/updating-a-package/effective-customizations.md create mode 100644 documentation/content/en/documentation/6-references/_index.md rename documentation/content/en/{reference => documentation/6-references}/annotations/_index.md (83%) rename documentation/content/en/{reference => documentation/6-references}/annotations/apply-time-mutation/_index.md (94%) rename documentation/content/en/{reference => documentation/6-references}/annotations/depends-on/_index.md (97%) rename documentation/content/en/{reference => documentation/6-references}/annotations/local-config/_index.md (97%) rename documentation/content/en/{reference => documentation/6-references}/cli/_index.md (80%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/_index.md (90%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/license/_index.md (88%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/license/info/_index.md (91%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/live/_index.md (83%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/live/plan/_index.md (98%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/sync/_index.md (85%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/sync/create/_index.md (95%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/sync/delete/_index.md (94%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/sync/get/_index.md (92%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/wasm/_index.md (88%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/wasm/pull/_index.md (93%) rename documentation/content/en/{reference => documentation/6-references}/cli/alpha/wasm/push/_index.md (93%) rename documentation/content/en/{reference => documentation/6-references}/cli/fn/_index.md (90%) rename documentation/content/en/{reference => documentation/6-references}/cli/fn/doc/_index.md (97%) rename documentation/content/en/{reference => documentation/6-references}/cli/fn/eval/_index.md (99%) rename documentation/content/en/{reference => documentation/6-references}/cli/fn/render/_index.md (99%) rename documentation/content/en/{reference => documentation/6-references}/cli/fn/sink/_index.md (96%) rename documentation/content/en/{reference => documentation/6-references}/cli/fn/source/_index.md (97%) rename documentation/content/en/{reference => documentation/6-references}/cli/live/_index.md (96%) rename documentation/content/en/{reference => documentation/6-references}/cli/live/apply/_index.md (99%) rename documentation/content/en/{reference => documentation/6-references}/cli/live/destroy/_index.md (98%) rename documentation/content/en/{reference => documentation/6-references}/cli/live/init/_index.md (98%) rename documentation/content/en/{reference => documentation/6-references}/cli/live/install-resource-group/_index.md (92%) rename documentation/content/en/{reference => documentation/6-references}/cli/live/migrate/_index.md (98%) rename documentation/content/en/{reference => documentation/6-references}/cli/live/status/_index.md (97%) rename documentation/content/en/{reference => documentation/6-references}/cli/pkg/_index.md (90%) rename documentation/content/en/{reference => documentation/6-references}/cli/pkg/cat/_index.md (97%) rename documentation/content/en/{reference => documentation/6-references}/cli/pkg/diff/_index.md (98%) rename documentation/content/en/{reference => documentation/6-references}/cli/pkg/get/_index.md (99%) rename documentation/content/en/{reference => documentation/6-references}/cli/pkg/init/_index.md (96%) rename documentation/content/en/{reference => documentation/6-references}/cli/pkg/tree/_index.md (98%) rename documentation/content/en/{reference => documentation/6-references}/cli/pkg/update/_index.md (99%) rename documentation/content/en/{reference => documentation/6-references}/schema/_index.md (70%) rename documentation/content/en/{reference => documentation/6-references}/schema/crd-status-convention/_index.md (97%) rename documentation/content/en/{reference => documentation/6-references}/schema/function-result-list/_index.md (74%) rename documentation/content/en/{reference => documentation/6-references}/schema/kptfile/_index.md (64%) rename documentation/content/en/{reference => documentation/6-references}/schema/kptfile/kptfile.json (100%) rename documentation/content/en/{reference => documentation/6-references}/schema/kptfile/kptfile.yaml (100%) rename documentation/content/en/{reference => documentation/6-references}/schema/plan/_index.md (96%) rename documentation/content/en/{reference => documentation/6-references}/schema/plan/plan.yaml (100%) rename documentation/content/en/{reference => documentation/6-references}/schema/resource-list/_index.md (77%) create mode 100644 documentation/content/en/documentation/7-FAQ/_index.md create mode 100644 documentation/content/en/documentation/8-contributing/_index.md create mode 100644 documentation/content/en/documentation/8-contributing/code-contribution.md create mode 100644 documentation/content/en/documentation/8-contributing/documentation-contribution/_index.md create mode 100644 documentation/content/en/documentation/8-contributing/documentation-contribution/error-messages-style-guide.md create mode 100644 documentation/content/en/documentation/_index.md delete mode 100644 documentation/content/en/reference/_index.md delete mode 100644 documentation/layouts/partials/sidebar-tree.html create mode 100644 documentation/layouts/partials/sidebar.html diff --git a/AGENTS.md b/AGENTS.md index fb4561b121..2e8205efba 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -234,7 +234,7 @@ git config --global user.name "Your Name" ### Module Generation -If changes modify CLI documentation in documentation/content/en/reference/cli/: +If changes modify CLI documentation in documentation/content/en/documentation/6-references/cli/: * Run `make generate` to regenerate `internal/docs/generated/` * Commit generated files @@ -274,7 +274,7 @@ If changes modify CLI documentation in documentation/content/en/reference/cli/: ## Implementation Notes for Code Changes -* **CLI Commands**: Add to `commands/` directory; use Cobra; update `documentation/content/en/reference/cli/` for documentation +* **CLI Commands**: Add to `commands/` directory; use Cobra; update `documentation/content/en/documentation/6-references/cli/` for documentation * **Library Code**: Place in `pkg/` for public APIs; use `internal/` for internal utilities * **Tests**: Colocate `*_test.go` files with source; use testdata directories for fixtures * **Generated Code**: Run `make generate` after modifying templates diff --git a/cli/main.go b/cli/main.go index a8d8cebbdc..612ce36916 100644 --- a/cli/main.go +++ b/cli/main.go @@ -12,13 +12,13 @@ // See the License for the specific language governing permissions and // limitations under the License. -//go:generate mdtogo ../documentation/content/en/reference/cli/live ../internal/docs/generated/livedocs --license=none --strategy=cmdDocs --recursive=true -//go:generate mdtogo ../documentation/content/en/reference/cli/pkg ../internal/docs/generated/pkgdocs --license=none --strategy=cmdDocs --recursive=true -//go:generate mdtogo ../documentation/content/en/reference/cli/fn ../internal/docs/generated/fndocs --license=none --strategy=cmdDocs --recursive=true -//go:generate mdtogo ../documentation/content/en/reference/cli/alpha ../internal/docs/generated/alphadocs --license=none --strategy=cmdDocs --recursive=false -//go:generate mdtogo ../documentation/content/en/reference/cli/alpha/sync ../internal/docs/generated/syncdocs --license=none --strategy=cmdDocs --recursive=true -//go:generate mdtogo ../documentation/content/en/reference/cli/alpha/wasm ../internal/docs/generated/wasmdocs --license=none --strategy=cmdDocs --recursive=true -//go:generate mdtogo ../documentation/content/en/reference/cli/_index.md ../internal/docs/generated/overview --license=none --strategy=cmdDocs +//go:generate mdtogo ../documentation/content/en/documentation/6-references/cli/live ../internal/docs/generated/livedocs --license=none --strategy=cmdDocs --recursive=true +//go:generate mdtogo ../documentation/content/en/documentation/6-references/cli/pkg ../internal/docs/generated/pkgdocs --license=none --strategy=cmdDocs --recursive=true +//go:generate mdtogo ../documentation/content/en/documentation/6-references/cli/fn ../internal/docs/generated/fndocs --license=none --strategy=cmdDocs --recursive=true +//go:generate mdtogo ../documentation/content/en/documentation/6-references/cli/alpha ../internal/docs/generated/alphadocs --license=none --strategy=cmdDocs --recursive=false +//go:generate mdtogo ../documentation/content/en/documentation/6-references/cli/alpha/sync ../internal/docs/generated/syncdocs --license=none --strategy=cmdDocs --recursive=true +//go:generate mdtogo ../documentation/content/en/documentation/6-references/cli/alpha/wasm ../internal/docs/generated/wasmdocs --license=none --strategy=cmdDocs --recursive=true +//go:generate mdtogo ../documentation/content/en/documentation/6-references/cli/_index.md ../internal/docs/generated/overview --license=none --strategy=cmdDocs package main import ( diff --git a/documentation/README.md b/documentation/README.md index 915792ea19..199643cc90 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -120,8 +120,8 @@ The token is only sent to github.com domains. 8. Links to other kpt doc pages should be absolute: - - Correct: `[pkg]: /reference/cli/pkg/get/` - - Incorrect: `[pkg]: ../../../reference/cli/pkg/get` + - Correct: `[pkg]: /documentation/6-references/cli/pkg/get/` + - Incorrect: `[pkg]: ../../../documentation/6-references/cli/pkg/get` 9. Flags must appear after positional args: diff --git a/documentation/assets/scss/_sidebar-left.scss b/documentation/assets/scss/_sidebar-left.scss index 7a253f2189..ae99dae2e8 100644 --- a/documentation/assets/scss/_sidebar-left.scss +++ b/documentation/assets/scss/_sidebar-left.scss @@ -53,7 +53,8 @@ &::after { display: inline-flex; content: '\f078'; - font-family: 'Font Awesome 5 Free'; + font-family: $td-font-awesome-font-name; + font-weight: 900; } } &.active-path { diff --git a/documentation/content/en/_index.md b/documentation/content/en/_index.md index 6852f130a5..3c0d1b4642 100644 --- a/documentation/content/en/_index.md +++ b/documentation/content/en/_index.md @@ -45,7 +45,7 @@ kpt is an open source project and anyone can [contribute](https://github.com/kpt # For users To get familiar with kpt, the best way to start is with the first 4 chapters of the kpt [Book]({{% relref "book" %}}). -Furthermore it is useful to check the [references]({{% relref "reference" %}}) and the catalog of [selected krm functions](https://catalog.kpt.dev). +Furthermore it is useful to check the [references]({{ with or (site.GetPage "/documentation/6-references") (site.GetPage "/reference") }}{{ .RelPermalink }}{{ end }}) and the catalog of [selected krm functions](https://catalog.kpt.dev). Use our [public Dosu space](https://app.dosu.dev/b19fb34f-d249-48ae-a3b1-2bd8ec156e41/ask) to ask anything about kpt. diff --git a/documentation/content/en/book/01-getting-started/_index.md b/documentation/content/en/book/01-getting-started/_index.md index 5fe7f18fd9..d0a5fb3ef2 100644 --- a/documentation/content/en/book/01-getting-started/_index.md +++ b/documentation/content/en/book/01-getting-started/_index.md @@ -39,7 +39,7 @@ Follow the [instructions](https://podman.io/getting-started/installation) to ins If you want to set up a rootless container runtime, then [this](https://rootlesscontaine.rs/) may be a useful resource for you. Environment variables can be used to control which container runtime to use. More details can be found in the reference -documents for [`kpt fn render`]({{% relref "/reference/cli/fn/render" %}}) and [`kpt fn eval`]({{% relref "/reference/cli/fn/eval" %}}). +documents for [`kpt fn render`]({{% relref "/documentation/6-references/cli/fn/render" %}}) and [`kpt fn eval`]({{% relref "/documentation/6-references/cli/fn/eval" %}}). ### Kubernetes cluster @@ -105,7 +105,7 @@ vim deployment.yaml #### Automating one-time edits with functions -The [`kpt fn`]({{% relref "/reference/cli/fn" %}}) set of commands enables you to execute programs called _kpt functions_. These programs are +The [`kpt fn`]({{% relref "/documentation/6-references/cli/fn" %}}) set of commands enables you to execute programs called _kpt functions_. These programs are packaged as containers and take YAML files as input, mutate or validate them, and then output YAML. For example, you can use a function (`ghcr.io/kptdev/krm-functions-catalog/search-replace:latest`) to search for and replace all the occurrences of the `app` key, in the `spec` section of the YAML document (`spec.**.app`), and set the value to `my-nginx`. diff --git a/documentation/content/en/book/02-concepts/_index.md b/documentation/content/en/book/02-concepts/_index.md index cc2f371ccb..ae40d5bf95 100644 --- a/documentation/content/en/book/02-concepts/_index.md +++ b/documentation/content/en/book/02-concepts/_index.md @@ -55,7 +55,7 @@ This enables machine manipulation of configuration for Kubernetes and any infras The kpt toolchain includes the following components: -- [**kpt CLI**]({{% relref "/reference/cli" %}}): The kpt CLI supports package and function operations, and also deployment, via +- [**kpt CLI**]({{% relref "/documentation/6-references/cli" %}}): The kpt CLI supports package and function operations, and also deployment, via either direct apply or GitOps. By keeping an inventory of deployed resources, kpt enables resource pruning, aggregated status and observability, and an improved preview experience. @@ -206,7 +206,7 @@ When you deploy the package with `kpt live apply`, local configuration resources are automatically filtered out. They exist in the package solely to support the pipeline. See [Chapter 4]({{% relref "/book/04-using-functions" %}}) for how function configs use this annotation, and the -[`local-config` annotation reference]({{% relref "/reference/annotations/local-config" %}}) for +[`local-config` annotation reference]({{% relref "/documentation/6-references/annotations/local-config" %}}) for full details. ## Workflows diff --git a/documentation/content/en/book/03-packages/_index.md b/documentation/content/en/book/03-packages/_index.md index d119b7ced0..6918effa0e 100644 --- a/documentation/content/en/book/03-packages/_index.md +++ b/documentation/content/en/book/03-packages/_index.md @@ -25,7 +25,7 @@ kpt pkg get https://github.com/kptdev/kpt.git/package-examples/wordpress@v1.0.0- A package in a Git repository can be fetched by specifying a branch, tag, or commit SHA. In the above example, the tag `v1.0.0-beta.61` is specified. -See the [get command reference]({{% relref "/reference/cli/pkg/get" %}}) for usage. +See the [get command reference]({{% relref "/documentation/6-references/cli/pkg/get" %}}) for usage. The `Kptfile` contains the metadata about the origin of the forked package. Have a look at the content of the `Kptfile` on your local filesystem: @@ -202,7 +202,7 @@ Package "wordpress" (independent) └── [service.yaml] Service wordpress-mysql ``` -See the [tree command reference]({{% relref "/reference/cli/pkg/tree" %}}) for usage. +See the [tree command reference]({{% relref "/documentation/6-references/cli/pkg/tree" %}}) for usage. In addition, you can use a kpt function, such as `search-replace`, to run a query on the package. For example, to search for resources that have a field with the `spec.selector.tier` path, use the following kpt function: @@ -281,7 +281,7 @@ Regardless of how you have edited the package, you need to _render_ it. Use the kpt fn render wordpress ``` -See the [render command reference]({{% relref "/reference/cli/fn/render" %}}) for command usage. +See the [render command reference]({{% relref "/documentation/6-references/cli/fn/render" %}}) for command usage. `render` is a critical step in the package lifecycle. At a high level, it performs the following steps: @@ -350,7 +350,7 @@ The `update` command updates the local `wordpress` package and the dependent `my Several different strategies are available for handling the merge. By default, the `resource-merge` strategy is used. This performs a structural comparison of the resource using the OpenAPI schema. -See the [update command reference]({{% relref "/reference/cli/pkg/update" %}}) for usage. +See the [update command reference]({{% relref "/documentation/6-references/cli/pkg/update" %}}) for usage. ### Committing the updated resources @@ -369,7 +369,7 @@ kpt pkg init awesomeapp This command automatically creates the `awesomeapp` directory, if it does not already exist, eliminating the need to manually create the directory beforehand. -See the [init command reference]({{% relref "/reference/cli/pkg/init" %}}) for usage. +See the [init command reference]({{% relref "/documentation/6-references/cli/pkg/init" %}}) for usage. The `info` section of the `Kptfile` contains some optional package metadata that you may want to set. These fields are not consumed by any functionality in kpt: diff --git a/documentation/content/en/book/04-using-functions/_index.md b/documentation/content/en/book/04-using-functions/_index.md index 954028e7fc..edf22b3651 100644 --- a/documentation/content/en/book/04-using-functions/_index.md +++ b/documentation/content/en/book/04-using-functions/_index.md @@ -84,7 +84,7 @@ Package "wordpress": Successfully executed 3 function(s) in 2 package(s). ``` -See the [render command reference]({{% relref "/reference/cli/fn/render" %}}) for usage. +See the [render command reference]({{% relref "/documentation/6-references/cli/fn/render" %}}) for usage. When you invoke the `render` command, kpt performs the following steps: @@ -408,7 +408,7 @@ This annotation is useful for: - Any resource that should exist in the package but not on the cluster For full details on the annotation schema and behavior, see the -[`local-config` annotation reference]({{% relref "/reference/annotations/local-config" %}}). +[`local-config` annotation reference]({{% relref "/documentation/6-references/annotations/local-config" %}}). ### Specifying function `name` @@ -879,7 +879,7 @@ Alternatively, for convenience, you can use the short-hand form of the above com kpt fn eval wordpress -i set-namespace:latest -- namespace=mywordpress ``` -See the [eval command reference]({{% relref "/reference/cli/fn/eval" %}}) for usage. +See the [eval command reference]({{% relref "/documentation/6-references/cli/fn/eval" %}}) for usage. This changes the resources in the `wordpress` package and the `mysql` subpackage. @@ -1042,8 +1042,8 @@ kpt fn source wordpress \ | kpt fn sink my-wordpress ``` -See the command reference for usage of the [source]({{% relref "/reference/cli/fn/source" %}}) command and the -[sink]({{% relref "/reference/cli/fn/sink" %}}) command. +See the command reference for usage of the [source]({{% relref "/documentation/6-references/cli/fn/source" %}}) command and the +[sink]({{% relref "/documentation/6-references/cli/fn/sink" %}}) command. The above pipeline can be described as follows: diff --git a/documentation/content/en/book/05-developing-functions/_index.md b/documentation/content/en/book/05-developing-functions/_index.md index ed06f4e8a8..c00e5d96d4 100644 --- a/documentation/content/en/book/05-developing-functions/_index.md +++ b/documentation/content/en/book/05-developing-functions/_index.md @@ -97,7 +97,7 @@ When kpt reads resources from disk, each resource in the `ResourceList` carries `internal.config.kubernetes.io/path` annotation indicating its file path relative to the package directory. When a function creates new resources, it should set this annotation to a path relative to the same package directory. See the -[annotations reference]({{% relref "/reference/annotations#path-annotation-details" %}}) +[annotations reference]({{% relref "/documentation/6-references/annotations#path-annotation-details" %}}) for full details. As an example, you can see the `ResourceList` containing resources in the diff --git a/documentation/content/en/book/06-deploying-packages/_index.md b/documentation/content/en/book/06-deploying-packages/_index.md index d91dd19e10..ac0304744f 100644 --- a/documentation/content/en/book/06-deploying-packages/_index.md +++ b/documentation/content/en/book/06-deploying-packages/_index.md @@ -66,7 +66,7 @@ number of pods have been created and become available. For core kubernetes types, reconcile status is computed using hardcoded rules. For CRDs, the status computation is based on the recommended -[convention for status fields]({{% relref "/reference/schema/crd-status-convention" %}}) +[convention for status fields]({{% relref "/documentation/6-references/schema/crd-status-convention" %}}) that must be followed by custom resource publishers. If CRDs follow these conventions, `kpt live apply` will correctly compute the reconciliation status. @@ -117,7 +117,7 @@ uses heuristics to automatically choose the namespace. In this example, all the resources in `wordpress` package are in the `default` namespace, so it chooses `default` for the namespace. Alternatively, you can manually configure the name and namespace of the `ResourceGroup` resource. Refer to the -[init command reference]({{% relref "/reference/cli/live/init" %}}) for usage. +[init command reference]({{% relref "/documentation/6-references/cli/live/init" %}}) for usage. {{% alert title="Warning" color="warning" %}} Once a package is applied to the cluster, do not change the `ResourceGroup` CR. Doing so corrupts the association between the package and the inventory in the cluster, possibly leading to unpredictable and destructive operations. @@ -131,7 +131,7 @@ Note that not all resources in the package are applied to the cluster. Resources annotated with `config.kubernetes.io/local-config: "true"` are automatically filtered out. These are typically function configs or helper resources used only during rendering. The `Kptfile` itself is also excluded. For more details, see -the [`local-config` annotation reference]({{% relref "/reference/annotations/local-config" %}}). +the [`local-config` annotation reference]({{% relref "/documentation/6-references/annotations/local-config" %}}). The `wordpress` package requires a `Secret` containing the mysql password. Let's create that first: @@ -170,7 +170,7 @@ deployment.apps/wordpress reconciled 6 resource(s) reconciled, 0 skipped, 0 failed to reconcile, 0 timed out ``` -Refer to the [apply command reference]({{% relref "/reference/cli/live/apply" %}}) for usage. +Refer to the [apply command reference]({{% relref "/documentation/6-references/cli/live/apply" %}}) for usage. ### `ResourceGroup` CRD @@ -233,7 +233,7 @@ persistentvolumeclaim/mysql-pv-claim is Current: PVC is Bound persistentvolumeclaim/wp-pv-claim is Current: PVC is Bound ``` -Refer to the [status command reference]({{% relref "/reference/cli/live/status" %}}) for usage. +Refer to the [status command reference]({{% relref "/documentation/6-references/cli/live/status" %}}) for usage. ### Delete the package @@ -264,7 +264,7 @@ persistentvolumeclaim/wp-pv-claim reconciled 6 resource(s) reconciled, 0 skipped, 0 failed to reconcile, 0 timed out ``` -Refer to the [destroy command reference]({{% relref "/reference/cli/live/destroy" %}}) for usage. +Refer to the [destroy command reference]({{% relref "/documentation/6-references/cli/live/destroy" %}}) for usage. ## Handling Dependencies @@ -353,4 +353,4 @@ service/wordpress-mysql reconciled 4 resource(s) reconciled, 0 skipped, 0 failed to reconcile, 0 timed out ``` -See [depends-on]({{% relref "/reference/annotations/depends-on" %}}) for more information. +See [depends-on]({{% relref "/documentation/6-references/annotations/depends-on" %}}) for more information. diff --git a/documentation/content/en/book/08-ci-user-guide/_index.md b/documentation/content/en/book/08-ci-user-guide/_index.md index 0d82ae4d69..ca5b0d788b 100644 --- a/documentation/content/en/book/08-ci-user-guide/_index.md +++ b/documentation/content/en/book/08-ci-user-guide/_index.md @@ -105,7 +105,7 @@ It is important to distinguish `kpt fn render` from `kpt fn eval`: ## Applying configuration in CI (optional and gated) Applying configuration from CI should be treated as optional and tightly controlled to prevent accidental cluster -changes. In most pipelines, [kpt live apply]({{% relref "/reference/cli/live/apply" %}}) runs only when a deployment is explicitly +changes. In most pipelines, [kpt live apply]({{% relref "/documentation/6-references/cli/live/apply" %}}) runs only when a deployment is explicitly authorized. Run apply only under these conditions: diff --git a/documentation/content/en/documentation/1-overview/_index.md b/documentation/content/en/documentation/1-overview/_index.md new file mode 100644 index 0000000000..cfeae07a2e --- /dev/null +++ b/documentation/content/en/documentation/1-overview/_index.md @@ -0,0 +1,8 @@ +--- +title: "Overview" +weight: -1 +description: > + kpt overview +--- + +Chapter 2 Concepts / What is kpt \ No newline at end of file diff --git a/documentation/content/en/documentation/2-concepts/_index.md b/documentation/content/en/documentation/2-concepts/_index.md new file mode 100644 index 0000000000..4f8d94c0d2 --- /dev/null +++ b/documentation/content/en/documentation/2-concepts/_index.md @@ -0,0 +1,8 @@ +--- +title: "Concepts" +weight: 2 +description: > + kpt concepts +--- + +Chapter 2 Concepts diff --git a/documentation/content/en/documentation/2-concepts/functions.md b/documentation/content/en/documentation/2-concepts/functions.md new file mode 100644 index 0000000000..1c8c15a3d4 --- /dev/null +++ b/documentation/content/en/documentation/2-concepts/functions.md @@ -0,0 +1,8 @@ +--- +title: "Functions" +weight: 3 +description: > + kpt functions +--- + +Chapter 2 Concepts / Functions diff --git a/documentation/content/en/documentation/2-concepts/packages.md b/documentation/content/en/documentation/2-concepts/packages.md new file mode 100644 index 0000000000..678558e0e9 --- /dev/null +++ b/documentation/content/en/documentation/2-concepts/packages.md @@ -0,0 +1,8 @@ +--- +title: "Packages" +weight: 1 +description: > + kpt packages +--- + +Chapter 2 Concepts / Packages diff --git a/documentation/content/en/documentation/2-concepts/workflows.md b/documentation/content/en/documentation/2-concepts/workflows.md new file mode 100644 index 0000000000..1d39178f7f --- /dev/null +++ b/documentation/content/en/documentation/2-concepts/workflows.md @@ -0,0 +1,8 @@ +--- +title: "Workflows" +weight: 2 +description: > + kpt workflows +--- + +Chapter 2 Concepts / Workflows diff --git a/documentation/content/en/documentation/3-intallation/_index.md b/documentation/content/en/documentation/3-intallation/_index.md new file mode 100644 index 0000000000..534a569831 --- /dev/null +++ b/documentation/content/en/documentation/3-intallation/_index.md @@ -0,0 +1,8 @@ +--- +title: "Installation" +weight: 3 +description: > + kpt installation +--- + +Chapter 3 Installation diff --git a/documentation/content/en/documentation/3-intallation/docker.md b/documentation/content/en/documentation/3-intallation/docker.md new file mode 100644 index 0000000000..7092c6bb0a --- /dev/null +++ b/documentation/content/en/documentation/3-intallation/docker.md @@ -0,0 +1,8 @@ +--- +title: "Docker" +weight: 2 +description: > + kpt Docker installation +--- + +Installation / Docker diff --git a/documentation/content/en/documentation/3-intallation/homebrew.md b/documentation/content/en/documentation/3-intallation/homebrew.md new file mode 100644 index 0000000000..881faff884 --- /dev/null +++ b/documentation/content/en/documentation/3-intallation/homebrew.md @@ -0,0 +1,8 @@ +--- +title: "Homebrew" +weight: 1 +description: > + kpt Homebrew installation +--- + +Installation / Homebrew diff --git a/documentation/content/en/documentation/3-intallation/source.md b/documentation/content/en/documentation/3-intallation/source.md new file mode 100644 index 0000000000..b1022b91ec --- /dev/null +++ b/documentation/content/en/documentation/3-intallation/source.md @@ -0,0 +1,8 @@ +--- +title: "Source" +weight: 3 +description: > + kpt source installation +--- + +Installation / Source diff --git a/documentation/content/en/documentation/4-getting-started/_index.md b/documentation/content/en/documentation/4-getting-started/_index.md new file mode 100644 index 0000000000..5043d1711f --- /dev/null +++ b/documentation/content/en/documentation/4-getting-started/_index.md @@ -0,0 +1,8 @@ +--- +title: "Getting Started" +weight: 4 +description: > + kpt getting started +--- + +Chapter 4 Getting Started diff --git a/documentation/content/en/documentation/4-getting-started/quickstart.md b/documentation/content/en/documentation/4-getting-started/quickstart.md new file mode 100644 index 0000000000..22727b7911 --- /dev/null +++ b/documentation/content/en/documentation/4-getting-started/quickstart.md @@ -0,0 +1,8 @@ +--- +title: "Quickstart" +weight: 2 +description: > + kpt quickstart +--- + +Chapter 1 Getting started / Quickstart diff --git a/documentation/content/en/documentation/4-getting-started/system-requirements.md b/documentation/content/en/documentation/4-getting-started/system-requirements.md new file mode 100644 index 0000000000..87b80c1212 --- /dev/null +++ b/documentation/content/en/documentation/4-getting-started/system-requirements.md @@ -0,0 +1,8 @@ +--- +title: "System Requirements" +weight: 1 +description: > + kpt system requirements +--- + +Chapter 1 Getting started / System requirements diff --git a/documentation/content/en/documentation/5-guides/_index.md b/documentation/content/en/documentation/5-guides/_index.md new file mode 100644 index 0000000000..b2f5693b3b --- /dev/null +++ b/documentation/content/en/documentation/5-guides/_index.md @@ -0,0 +1,8 @@ +--- +title: "Guides" +weight: 5 +description: > + kpt guides +--- + +Chapter 5 Guides diff --git a/documentation/content/en/documentation/5-guides/advanced-topics/_index.md b/documentation/content/en/documentation/5-guides/advanced-topics/_index.md new file mode 100644 index 0000000000..59c60622af --- /dev/null +++ b/documentation/content/en/documentation/5-guides/advanced-topics/_index.md @@ -0,0 +1,6 @@ +--- +title: "Advanced topics" +weight: 5 +description: > + Advanced topics +--- diff --git a/documentation/content/en/documentation/5-guides/advanced-topics/tenant-onboarding.md b/documentation/content/en/documentation/5-guides/advanced-topics/tenant-onboarding.md new file mode 100644 index 0000000000..dcd66f4370 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/advanced-topics/tenant-onboarding.md @@ -0,0 +1,8 @@ +--- +title: "Tenant Onboarding" +weight: 3 +description: > + Tenant Onboarding +--- + +guides/tenant-onboarding diff --git a/documentation/content/en/documentation/5-guides/advanced-topics/understanding-3-way-merge.md b/documentation/content/en/documentation/5-guides/advanced-topics/understanding-3-way-merge.md new file mode 100644 index 0000000000..2d4405910a --- /dev/null +++ b/documentation/content/en/documentation/5-guides/advanced-topics/understanding-3-way-merge.md @@ -0,0 +1,8 @@ +--- +title: "Understanding 3-Way Merge in kpt" +weight: 4 +description: > + Understanding 3-Way Merge in kpt +--- + +guides/3-way-merge diff --git a/documentation/content/en/documentation/5-guides/advanced-topics/value-propagation-pattern.md b/documentation/content/en/documentation/5-guides/advanced-topics/value-propagation-pattern.md new file mode 100644 index 0000000000..e3897f8fe7 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/advanced-topics/value-propagation-pattern.md @@ -0,0 +1,8 @@ +--- +title: "Value Propagation Pattern" +weight: 2 +description: > + Value Propagation Pattern +--- + +guides/value-propagation diff --git a/documentation/content/en/documentation/5-guides/advanced-topics/variant-constructor-pattern.md b/documentation/content/en/documentation/5-guides/advanced-topics/variant-constructor-pattern.md new file mode 100644 index 0000000000..da556619b2 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/advanced-topics/variant-constructor-pattern.md @@ -0,0 +1,8 @@ +--- +title: "Variant Constructor Pattern" +weight: 1 +description: > + Variant Constructor Pattern +--- + +guides/variant-constructor-pattern diff --git a/documentation/content/en/documentation/5-guides/ci-user-guide.md b/documentation/content/en/documentation/5-guides/ci-user-guide.md new file mode 100644 index 0000000000..6be0c83a0b --- /dev/null +++ b/documentation/content/en/documentation/5-guides/ci-user-guide.md @@ -0,0 +1,8 @@ +--- +title: "CI User Guide" +weight: 4 +description: > + CI user guide +--- + +Chapter 9: CI user guide diff --git a/documentation/content/en/documentation/5-guides/krm-function-developer-guide.md b/documentation/content/en/documentation/5-guides/krm-function-developer-guide.md new file mode 100644 index 0000000000..696788c503 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/krm-function-developer-guide.md @@ -0,0 +1,8 @@ +--- +title: "KRM Function Developer Guide" +weight: 3 +description: > + KRM Function Developer Guide +--- + +guides/krm-functions/ diff --git a/documentation/content/en/documentation/5-guides/working-with-functions/_index.md b/documentation/content/en/documentation/5-guides/working-with-functions/_index.md new file mode 100644 index 0000000000..5c9dac6ce8 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-functions/_index.md @@ -0,0 +1,6 @@ +--- +title: "Working with Functions" +weight: 2 +description: > + Working with functions +--- diff --git a/documentation/content/en/documentation/5-guides/working-with-functions/declarative-function-execution.md b/documentation/content/en/documentation/5-guides/working-with-functions/declarative-function-execution.md new file mode 100644 index 0000000000..d11b48c236 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-functions/declarative-function-execution.md @@ -0,0 +1,8 @@ +--- +title: "Declarative function execution" +weight: 1 +description: > + Declarative function execution +--- + +Chapter 4: Using functions / Declarative function execution diff --git a/documentation/content/en/documentation/5-guides/working-with-functions/developing-functions.md b/documentation/content/en/documentation/5-guides/working-with-functions/developing-functions.md new file mode 100644 index 0000000000..d367f3418e --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-functions/developing-functions.md @@ -0,0 +1,8 @@ +--- +title: "Developing Functions" +weight: 4 +description: > + Developing functions +--- + +Chapter 5: Developing Functions diff --git a/documentation/content/en/documentation/5-guides/working-with-functions/function-results.md b/documentation/content/en/documentation/5-guides/working-with-functions/function-results.md new file mode 100644 index 0000000000..5bfaeee557 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-functions/function-results.md @@ -0,0 +1,8 @@ +--- +title: "Function results" +weight: 3 +description: > + Function results +--- + +Chapter 4: Using functions / Function results diff --git a/documentation/content/en/documentation/5-guides/working-with-functions/imperative-function-execution.md b/documentation/content/en/documentation/5-guides/working-with-functions/imperative-function-execution.md new file mode 100644 index 0000000000..3a4aecd55b --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-functions/imperative-function-execution.md @@ -0,0 +1,8 @@ +--- +title: "Imperative function execution" +weight: 2 +description: > + Imperative function execution +--- + +Chapter 4: Using functions / Imperative function execution diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/_index.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/_index.md new file mode 100644 index 0000000000..c58884e292 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/_index.md @@ -0,0 +1,6 @@ +--- +title: "Working with kpt packages" +weight: 1 +description: > + Working with kpt packages +--- diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/composing-a-package.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/composing-a-package.md new file mode 100644 index 0000000000..9653b550b5 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/composing-a-package.md @@ -0,0 +1,8 @@ +--- +title: "Composing a package" +weight: 9 +description: > + Composing a package +--- + +Chapter 3: Packages / Composing a package diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/creating-a-package.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/creating-a-package.md new file mode 100644 index 0000000000..818284da39 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/creating-a-package.md @@ -0,0 +1,8 @@ +--- +title: "Creating a package" +weight: 8 +description: > + Creating a package +--- + +Chapter 3: Packages / Creating a package diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/deploying-packages.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/deploying-packages.md new file mode 100644 index 0000000000..52939be5d6 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/deploying-packages.md @@ -0,0 +1,8 @@ +--- +title: "Deploying packages" +weight: 7 +description: > + Deploying packages +--- + +Chapter 6: Deploying Packages diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/editing-a-package.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/editing-a-package.md new file mode 100644 index 0000000000..bb56246d88 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/editing-a-package.md @@ -0,0 +1,8 @@ +--- +title: "Editing a package" +weight: 4 +description: > + Editing a package +--- + +Chapter 3: Packages / Editing a package diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/excluding-files-with-krmignore.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/excluding-files-with-krmignore.md new file mode 100644 index 0000000000..8472b4c844 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/excluding-files-with-krmignore.md @@ -0,0 +1,8 @@ +--- +title: "Excluding files with .krmignore" +weight: 3 +description: > + Excluding files with .krmignore +--- + +Chapter 3: Packages / Excluding files with .krmignore diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/exploring-a-package.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/exploring-a-package.md new file mode 100644 index 0000000000..c5f687a278 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/exploring-a-package.md @@ -0,0 +1,8 @@ +--- +title: "Exploring a package" +weight: 2 +description: > + Exploring a package +--- + +Chapter 3: Packages / Exploring a package diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/getting-a-package.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/getting-a-package.md new file mode 100644 index 0000000000..0a59369449 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/getting-a-package.md @@ -0,0 +1,8 @@ +--- +title: "Getting a package" +weight: 1 +description: > + Getting a package +--- + +Chapter 3: Packages / Getting a package diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/publishing-a-package.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/publishing-a-package.md new file mode 100644 index 0000000000..50695c55e4 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/publishing-a-package.md @@ -0,0 +1,8 @@ +--- +title: "Publishing a package" +weight: 10 +description: > + Publishing a package +--- + +Chapter 3: Packages / Publishing a package diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/rendering-a-package.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/rendering-a-package.md new file mode 100644 index 0000000000..57fb1582a6 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/rendering-a-package.md @@ -0,0 +1,8 @@ +--- +title: "Rendering a package" +weight: 5 +description: > + Rendering a package +--- + +Chapter 3: Packages / Rendering a package diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/updating-a-package/_index.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/updating-a-package/_index.md new file mode 100644 index 0000000000..1245146467 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/updating-a-package/_index.md @@ -0,0 +1,8 @@ +--- +title: "Updating a package" +weight: 6 +description: > + Updating a package +--- + +Chapter 3: Packages / Updating a package diff --git a/documentation/content/en/documentation/5-guides/working-with-kpt-packages/updating-a-package/effective-customizations.md b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/updating-a-package/effective-customizations.md new file mode 100644 index 0000000000..3dc2ac0b03 --- /dev/null +++ b/documentation/content/en/documentation/5-guides/working-with-kpt-packages/updating-a-package/effective-customizations.md @@ -0,0 +1,8 @@ +--- +title: "Effective Customizations" +weight: 1 +description: > + Effective customizations +--- + +Chapter 7: Effective Customizations diff --git a/documentation/content/en/documentation/6-references/_index.md b/documentation/content/en/documentation/6-references/_index.md new file mode 100644 index 0000000000..52e700f9af --- /dev/null +++ b/documentation/content/en/documentation/6-references/_index.md @@ -0,0 +1,14 @@ +--- +title: "References" +weight: 6 +description: > + kpt references +aliases: + - /reference/ +--- + +Chapter 6 References + +- [CLI Reference]({{% relref "/documentation/6-references/cli" %}}) +- [Schema Reference]({{% relref "/documentation/6-references/schema" %}}) +- [Annotations Reference]({{% relref "/documentation/6-references/annotations" %}}) diff --git a/documentation/content/en/reference/annotations/_index.md b/documentation/content/en/documentation/6-references/annotations/_index.md similarity index 83% rename from documentation/content/en/reference/annotations/_index.md rename to documentation/content/en/documentation/6-references/annotations/_index.md index bc549484b2..c6e4afc966 100644 --- a/documentation/content/en/reference/annotations/_index.md +++ b/documentation/content/en/documentation/6-references/annotations/_index.md @@ -2,11 +2,8 @@ title: Annotations Reference linkTitle: Annotations Reference description: -toc_hide: true -menu: - main: - parent: "References" - weight: 30 +aliases: + - /reference/annotations/ --- The following annotations are used to configure kpt features: @@ -39,6 +36,6 @@ relative to the root package before writing to disk. For `kpt fn eval DIR`, the path is relative to the package directory DIR (the directory passed as the evaluation target). -[config.kubernetes.io/depends-on]: /reference/annotations/depends-on/ -[config.kubernetes.io/apply-time-mutation]: /reference/annotations/apply-time-mutation/ -[config.kubernetes.io/local-config]: /reference/annotations/local-config/ +[config.kubernetes.io/depends-on]: /documentation/6-references/annotations/depends-on/ +[config.kubernetes.io/apply-time-mutation]: /documentation/6-references/annotations/apply-time-mutation/ +[config.kubernetes.io/local-config]: /documentation/6-references/annotations/local-config/ diff --git a/documentation/content/en/reference/annotations/apply-time-mutation/_index.md b/documentation/content/en/documentation/6-references/annotations/apply-time-mutation/_index.md similarity index 94% rename from documentation/content/en/reference/annotations/apply-time-mutation/_index.md rename to documentation/content/en/documentation/6-references/annotations/apply-time-mutation/_index.md index 6bbda94884..eaa8c8ee4f 100644 --- a/documentation/content/en/reference/annotations/apply-time-mutation/_index.md +++ b/documentation/content/en/documentation/6-references/annotations/apply-time-mutation/_index.md @@ -4,6 +4,8 @@ linkTitle: "apply-time-mutation" description: | Specify one or more substitutions to make at apply time using dependencies as input. +aliases: + - /reference/annotations/apply-time-mutation/ --- The `config.kubernetes.io/apply-time-mutation` annotation specifies one or more @@ -219,6 +221,6 @@ pod/pod-a deleted 1 resource(s) deleted, 0 skipped ``` -[Substitution]: /reference/annotations/apply-time-mutation/#substitution -[ObjectReference]: /reference/annotations/apply-time-mutation/#objectreference -[JSONPath]: /reference/annotations/apply-time-mutation/#jsonpath-syntax +[Substitution]: /documentation/6-references/annotations/apply-time-mutation/#substitution +[ObjectReference]: /documentation/6-references/annotations/apply-time-mutation/#objectreference +[JSONPath]: /documentation/6-references/annotations/apply-time-mutation/#jsonpath-syntax diff --git a/documentation/content/en/reference/annotations/depends-on/_index.md b/documentation/content/en/documentation/6-references/annotations/depends-on/_index.md similarity index 97% rename from documentation/content/en/reference/annotations/depends-on/_index.md rename to documentation/content/en/documentation/6-references/annotations/depends-on/_index.md index 154a127d2f..01cc3abadd 100644 --- a/documentation/content/en/reference/annotations/depends-on/_index.md +++ b/documentation/content/en/documentation/6-references/annotations/depends-on/_index.md @@ -4,6 +4,8 @@ linkTitle: "depends-on" description: | Specify one or more resource dependencies. +aliases: + - /reference/annotations/depends-on/ --- The `config.kubernetes.io/depends-on` annotation specifies one or more resource diff --git a/documentation/content/en/reference/annotations/local-config/_index.md b/documentation/content/en/documentation/6-references/annotations/local-config/_index.md similarity index 97% rename from documentation/content/en/reference/annotations/local-config/_index.md rename to documentation/content/en/documentation/6-references/annotations/local-config/_index.md index 0c2a942367..9c28d7685d 100644 --- a/documentation/content/en/reference/annotations/local-config/_index.md +++ b/documentation/content/en/documentation/6-references/annotations/local-config/_index.md @@ -4,6 +4,8 @@ linkTitle: "local-config" description: | Specify a resource to be skipped when applying. +aliases: + - /reference/annotations/local-config/ --- The `config.kubernetes.io/local-config` annotation specifies a resource to be diff --git a/documentation/content/en/reference/cli/_index.md b/documentation/content/en/documentation/6-references/cli/_index.md similarity index 80% rename from documentation/content/en/reference/cli/_index.md rename to documentation/content/en/documentation/6-references/cli/_index.md index 118b86827a..97d3f0719f 100755 --- a/documentation/content/en/reference/cli/_index.md +++ b/documentation/content/en/documentation/6-references/cli/_index.md @@ -2,10 +2,8 @@ title: CLI Reference linkTitle: CLI Reference description: Overview of kpt commands -toc_hide: true -menu: - main: - parent: "References" +aliases: + - /reference/cli/ --- -[pkg]: /reference/cli/pkg/ -[fn]: /reference/cli/fn/ -[live]: /reference/cli/live/ -[alpha]: /reference/cli/alpha/ \ No newline at end of file +[pkg]: /documentation/6-references/cli/pkg/ +[fn]: /documentation/6-references/cli/fn/ +[live]: /documentation/6-references/cli/live/ +[alpha]: /documentation/6-references/cli/alpha/ \ No newline at end of file diff --git a/documentation/content/en/reference/cli/alpha/_index.md b/documentation/content/en/documentation/6-references/cli/alpha/_index.md similarity index 90% rename from documentation/content/en/reference/cli/alpha/_index.md rename to documentation/content/en/documentation/6-references/cli/alpha/_index.md index 167304adb5..542f0640fe 100644 --- a/documentation/content/en/reference/cli/alpha/_index.md +++ b/documentation/content/en/documentation/6-references/cli/alpha/_index.md @@ -4,9 +4,8 @@ linkTitle: "alpha" weight: 4 description: | This command is currently in alpha and might change without notice. -menu: - main: - parent: "References" +aliases: + - /reference/cli/alpha/ --- -[inventory template]: /reference/cli/live/apply/#prune +[inventory template]: /documentation/6-references/cli/live/apply/#prune diff --git a/documentation/content/en/reference/cli/pkg/_index.md b/documentation/content/en/documentation/6-references/cli/pkg/_index.md similarity index 90% rename from documentation/content/en/reference/cli/pkg/_index.md rename to documentation/content/en/documentation/6-references/cli/pkg/_index.md index 9ed78544f4..15f6fa5af6 100644 --- a/documentation/content/en/reference/cli/pkg/_index.md +++ b/documentation/content/en/documentation/6-references/cli/pkg/_index.md @@ -5,9 +5,8 @@ weight: 1 description: | Get, update, and describe packages with resources -menu: - main: - parent: "References" +aliases: + - /reference/cli/pkg/ ---