From 2c444d6bf4a2466f41c9e9f6243bf899280d179a Mon Sep 17 00:00:00 2001 From: Jeong Jinwoo Date: Sun, 17 Sep 2023 16:05:32 +0900 Subject: [PATCH] docs(api/kustomizaion-file): migrate field sections --- .../{kustomization_file.md => Kustomization File/_index.md} | 4 ++-- .../en/docs/Reference/API/{ => Kustomization File}/bases.md | 2 +- .../Reference/API/{ => Kustomization File}/buildMetadata.md | 0 .../API/{ => Kustomization File}/commonAnnotations.md | 0 .../Reference/API/{ => Kustomization File}/commonLabels.md | 2 +- .../docs/Reference/API/{ => Kustomization File}/components.md | 0 .../API/{ => Kustomization File}/configMapGenerator.md | 0 .../en/docs/Reference/API/{ => Kustomization File}/crds.md | 0 .../API/{ => Kustomization File}/generatorOptions.md | 2 +- .../docs/Reference/API/{ => Kustomization File}/helmCharts.md | 0 .../en/docs/Reference/API/{ => Kustomization File}/images.md | 0 .../en/docs/Reference/API/{ => Kustomization File}/labels.md | 0 .../docs/Reference/API/{ => Kustomization File}/namePrefix.md | 0 .../docs/Reference/API/{ => Kustomization File}/nameSuffix.md | 0 .../docs/Reference/API/{ => Kustomization File}/namespace.md | 0 .../en/docs/Reference/API/{ => Kustomization File}/openapi.md | 0 .../en/docs/Reference/API/{ => Kustomization File}/patches.md | 4 ++-- .../API/{ => Kustomization File}/patchesStrategicMerge.md | 2 +- .../Reference/API/{ => Kustomization File}/patchesjson6902.md | 2 +- .../Reference/API/{ => Kustomization File}/replacements.md | 0 .../docs/Reference/API/{ => Kustomization File}/replicas.md | 0 .../docs/Reference/API/{ => Kustomization File}/resources.md | 0 .../Reference/API/{ => Kustomization File}/secretGenerator.md | 2 +- .../Reference/API/{ => Kustomization File}/sortOptions.md | 0 .../en/docs/Reference/API/{ => Kustomization File}/vars.md | 4 ++-- 25 files changed, 12 insertions(+), 12 deletions(-) rename site/content/en/docs/Reference/API/{kustomization_file.md => Kustomization File/_index.md} (88%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/bases.md (91%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/buildMetadata.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/commonAnnotations.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/commonLabels.md (96%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/components.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/configMapGenerator.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/crds.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/generatorOptions.md (93%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/helmCharts.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/images.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/labels.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/namePrefix.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/nameSuffix.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/namespace.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/openapi.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/patches.md (97%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/patchesStrategicMerge.md (96%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/patchesjson6902.md (96%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/replacements.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/replicas.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/resources.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/secretGenerator.md (93%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/sortOptions.md (100%) rename site/content/en/docs/Reference/API/{ => Kustomization File}/vars.md (98%) diff --git a/site/content/en/docs/Reference/API/kustomization_file.md b/site/content/en/docs/Reference/API/Kustomization File/_index.md similarity index 88% rename from site/content/en/docs/Reference/API/kustomization_file.md rename to site/content/en/docs/Reference/API/Kustomization File/_index.md index 0bea5c073..feefe31b9 100644 --- a/site/content/en/docs/Reference/API/kustomization_file.md +++ b/site/content/en/docs/Reference/API/Kustomization File/_index.md @@ -2,7 +2,7 @@ title: "Kustomization File" linkTitle: "Kustomization File" weight: 1 -date: 2023-07-28 +date: 2023-09-17 description: > The Kustomization file is the entry point for Kustomize execution. ---- \ No newline at end of file +--- diff --git a/site/content/en/docs/Reference/API/bases.md b/site/content/en/docs/Reference/API/Kustomization File/bases.md similarity index 91% rename from site/content/en/docs/Reference/API/bases.md rename to site/content/en/docs/Reference/API/Kustomization File/bases.md index 9b4fdb711..2d7bed3d3 100644 --- a/site/content/en/docs/Reference/API/bases.md +++ b/site/content/en/docs/Reference/API/Kustomization File/bases.md @@ -18,7 +18,7 @@ kustomize CLI, and removal itself will happen in a future major version bump. You can run `kustomize edit fix` to automatically convert `bases` to `resources`. {{% /pageinfo %}} -Move entries into the [resources](/docs/reference/api/resources) +Move entries into the [resources](/docs/reference/api/kustomization-file/resources) field. This allows bases - which are still a [central concept](/docs/concepts/bases) - to be ordered relative to other input resources. diff --git a/site/content/en/docs/Reference/API/buildMetadata.md b/site/content/en/docs/Reference/API/Kustomization File/buildMetadata.md similarity index 100% rename from site/content/en/docs/Reference/API/buildMetadata.md rename to site/content/en/docs/Reference/API/Kustomization File/buildMetadata.md diff --git a/site/content/en/docs/Reference/API/commonAnnotations.md b/site/content/en/docs/Reference/API/Kustomization File/commonAnnotations.md similarity index 100% rename from site/content/en/docs/Reference/API/commonAnnotations.md rename to site/content/en/docs/Reference/API/Kustomization File/commonAnnotations.md diff --git a/site/content/en/docs/Reference/API/commonLabels.md b/site/content/en/docs/Reference/API/Kustomization File/commonLabels.md similarity index 96% rename from site/content/en/docs/Reference/API/commonLabels.md rename to site/content/en/docs/Reference/API/Kustomization File/commonLabels.md index 20a907eb1..379a35a95 100644 --- a/site/content/en/docs/Reference/API/commonLabels.md +++ b/site/content/en/docs/Reference/API/Kustomization File/commonLabels.md @@ -7,7 +7,7 @@ description: > Add labels and selectors to add all resources. --- -[labels]: /docs/reference/api/labels/ +[labels]: /docs/reference/api/kustomization-file/labels/ Add labels and selectors to all resources. If the label key already is present on the resource, the value will be overridden. diff --git a/site/content/en/docs/Reference/API/components.md b/site/content/en/docs/Reference/API/Kustomization File/components.md similarity index 100% rename from site/content/en/docs/Reference/API/components.md rename to site/content/en/docs/Reference/API/Kustomization File/components.md diff --git a/site/content/en/docs/Reference/API/configMapGenerator.md b/site/content/en/docs/Reference/API/Kustomization File/configMapGenerator.md similarity index 100% rename from site/content/en/docs/Reference/API/configMapGenerator.md rename to site/content/en/docs/Reference/API/Kustomization File/configMapGenerator.md diff --git a/site/content/en/docs/Reference/API/crds.md b/site/content/en/docs/Reference/API/Kustomization File/crds.md similarity index 100% rename from site/content/en/docs/Reference/API/crds.md rename to site/content/en/docs/Reference/API/Kustomization File/crds.md diff --git a/site/content/en/docs/Reference/API/generatorOptions.md b/site/content/en/docs/Reference/API/Kustomization File/generatorOptions.md similarity index 93% rename from site/content/en/docs/Reference/API/generatorOptions.md rename to site/content/en/docs/Reference/API/Kustomization File/generatorOptions.md index 731a5cd85..75c40d0d1 100644 --- a/site/content/en/docs/Reference/API/generatorOptions.md +++ b/site/content/en/docs/Reference/API/Kustomization File/generatorOptions.md @@ -10,7 +10,7 @@ description: > Additionally, generatorOptions can be set on a per resource level within each generator. For details on per-resource generatorOptions usage see -[configMapGenerator](/docs/reference/api/configmapgenerator/) and see [secretGenerator](/docs/reference/api/secretgenerator/). +[configMapGenerator](/docs/reference/api/kustomization-file/configmapgenerator/) and see [secretGenerator](/docs/reference/api/kustomization-file/secretgenerator/). ```yaml apiVersion: kustomize.config.k8s.io/v1beta1 diff --git a/site/content/en/docs/Reference/API/helmCharts.md b/site/content/en/docs/Reference/API/Kustomization File/helmCharts.md similarity index 100% rename from site/content/en/docs/Reference/API/helmCharts.md rename to site/content/en/docs/Reference/API/Kustomization File/helmCharts.md diff --git a/site/content/en/docs/Reference/API/images.md b/site/content/en/docs/Reference/API/Kustomization File/images.md similarity index 100% rename from site/content/en/docs/Reference/API/images.md rename to site/content/en/docs/Reference/API/Kustomization File/images.md diff --git a/site/content/en/docs/Reference/API/labels.md b/site/content/en/docs/Reference/API/Kustomization File/labels.md similarity index 100% rename from site/content/en/docs/Reference/API/labels.md rename to site/content/en/docs/Reference/API/Kustomization File/labels.md diff --git a/site/content/en/docs/Reference/API/namePrefix.md b/site/content/en/docs/Reference/API/Kustomization File/namePrefix.md similarity index 100% rename from site/content/en/docs/Reference/API/namePrefix.md rename to site/content/en/docs/Reference/API/Kustomization File/namePrefix.md diff --git a/site/content/en/docs/Reference/API/nameSuffix.md b/site/content/en/docs/Reference/API/Kustomization File/nameSuffix.md similarity index 100% rename from site/content/en/docs/Reference/API/nameSuffix.md rename to site/content/en/docs/Reference/API/Kustomization File/nameSuffix.md diff --git a/site/content/en/docs/Reference/API/namespace.md b/site/content/en/docs/Reference/API/Kustomization File/namespace.md similarity index 100% rename from site/content/en/docs/Reference/API/namespace.md rename to site/content/en/docs/Reference/API/Kustomization File/namespace.md diff --git a/site/content/en/docs/Reference/API/openapi.md b/site/content/en/docs/Reference/API/Kustomization File/openapi.md similarity index 100% rename from site/content/en/docs/Reference/API/openapi.md rename to site/content/en/docs/Reference/API/Kustomization File/openapi.md diff --git a/site/content/en/docs/Reference/API/patches.md b/site/content/en/docs/Reference/API/Kustomization File/patches.md similarity index 97% rename from site/content/en/docs/Reference/API/patches.md rename to site/content/en/docs/Reference/API/Kustomization File/patches.md index 24e04831b..19805b0d0 100644 --- a/site/content/en/docs/Reference/API/patches.md +++ b/site/content/en/docs/Reference/API/Kustomization File/patches.md @@ -7,8 +7,8 @@ description: > Patch resources --- -[strategic merge]: /docs/reference/api/patchesstrategicmerge/ -[JSON6902]: /docs/reference/api/patchesjson6902/ +[strategic merge]: /docs/reference/api/kustomization-file/patchesstrategicmerge/ +[JSON6902]: /docs/reference/api/kustomization-file/patchesjson6902/ Patches (also called overlays) add or override fields on resources. They are provided using the `patches` Kustomization field. diff --git a/site/content/en/docs/Reference/API/patchesStrategicMerge.md b/site/content/en/docs/Reference/API/Kustomization File/patchesStrategicMerge.md similarity index 96% rename from site/content/en/docs/Reference/API/patchesStrategicMerge.md rename to site/content/en/docs/Reference/API/Kustomization File/patchesStrategicMerge.md index 51ab157e9..d8f32add4 100644 --- a/site/content/en/docs/Reference/API/patchesStrategicMerge.md +++ b/site/content/en/docs/Reference/API/Kustomization File/patchesStrategicMerge.md @@ -16,7 +16,7 @@ two releases between deprecation and removal of Kustomization v1beta1 support fr kustomize CLI, and removal itself will happen in a future major version bump. Please move your `patchesStrategicMerge` into -the [patches](/docs/reference/api/patches) field. This field supports patchesStrategicMerge, +the [patches](/docs/reference/api/kustomization-file/patches) field. This field supports patchesStrategicMerge, but with slightly different syntax. You can run `kustomize edit fix` to automatically convert `patchesStrategicMerge` to `patches`. {{% /pageinfo %}} diff --git a/site/content/en/docs/Reference/API/patchesjson6902.md b/site/content/en/docs/Reference/API/Kustomization File/patchesjson6902.md similarity index 96% rename from site/content/en/docs/Reference/API/patchesjson6902.md rename to site/content/en/docs/Reference/API/Kustomization File/patchesjson6902.md index 7c4682ef4..66771533e 100644 --- a/site/content/en/docs/Reference/API/patchesjson6902.md +++ b/site/content/en/docs/Reference/API/Kustomization File/patchesjson6902.md @@ -16,7 +16,7 @@ two releases between deprecation and removal of Kustomization v1beta1 support fr kustomize CLI, and removal itself will happen in a future major version bump. Please move your `patchesJson6902` into -the [patches](/docs/reference/api/patches) field. This field supports patchesJson6902, +the [patches](/docs/reference/api/kustomization-file/patches) field. This field supports patchesJson6902, but with slightly different syntax. You can run `kustomize edit fix` to automatically convert `patchesJson6902` to `patches`. {{% /pageinfo %}} diff --git a/site/content/en/docs/Reference/API/replacements.md b/site/content/en/docs/Reference/API/Kustomization File/replacements.md similarity index 100% rename from site/content/en/docs/Reference/API/replacements.md rename to site/content/en/docs/Reference/API/Kustomization File/replacements.md diff --git a/site/content/en/docs/Reference/API/replicas.md b/site/content/en/docs/Reference/API/Kustomization File/replicas.md similarity index 100% rename from site/content/en/docs/Reference/API/replicas.md rename to site/content/en/docs/Reference/API/Kustomization File/replicas.md diff --git a/site/content/en/docs/Reference/API/resources.md b/site/content/en/docs/Reference/API/Kustomization File/resources.md similarity index 100% rename from site/content/en/docs/Reference/API/resources.md rename to site/content/en/docs/Reference/API/Kustomization File/resources.md diff --git a/site/content/en/docs/Reference/API/secretGenerator.md b/site/content/en/docs/Reference/API/Kustomization File/secretGenerator.md similarity index 93% rename from site/content/en/docs/Reference/API/secretGenerator.md rename to site/content/en/docs/Reference/API/Kustomization File/secretGenerator.md index 8155776e1..e06c8e275 100644 --- a/site/content/en/docs/Reference/API/secretGenerator.md +++ b/site/content/en/docs/Reference/API/Kustomization File/secretGenerator.md @@ -9,7 +9,7 @@ description: > Each entry in the argument list results in the creation of one Secret resource (it's a generator of N secrets). -This works like the [configMapGenerator](/docs/reference/api/configmapgenerator). +This works like the [configMapGenerator](/docs/reference/api/kustomization-file/configmapgenerator). ```yaml apiVersion: kustomize.config.k8s.io/v1beta1 diff --git a/site/content/en/docs/Reference/API/sortOptions.md b/site/content/en/docs/Reference/API/Kustomization File/sortOptions.md similarity index 100% rename from site/content/en/docs/Reference/API/sortOptions.md rename to site/content/en/docs/Reference/API/Kustomization File/sortOptions.md diff --git a/site/content/en/docs/Reference/API/vars.md b/site/content/en/docs/Reference/API/Kustomization File/vars.md similarity index 98% rename from site/content/en/docs/Reference/API/vars.md rename to site/content/en/docs/Reference/API/Kustomization File/vars.md index 3c8edc428..db93bd459 100644 --- a/site/content/en/docs/Reference/API/vars.md +++ b/site/content/en/docs/Reference/API/Kustomization File/vars.md @@ -7,7 +7,7 @@ description: > Substitute name references. --- -[replacements]: /docs/reference/api/replacements/ +[replacements]: /docs/reference/api/kustomization-file/replacements/ {{% pageinfo color="warning" %}} The `vars` field was deprecated in v5.0.0. This field will never be removed from the @@ -18,7 +18,7 @@ two releases between deprecation and removal of Kustomization v1beta1 support fr kustomize CLI, and removal itself will happen in a future major version bump. Please try to migrate to the -the [replacements](/docs/reference/api/replacements) field. If you are +the [replacements](/docs/reference/api/kustomization-file/replacements) field. If you are unable to restructure your configuration to use replacements instead of vars, please ask for help in slack or file an issue for guidance.