diff --git a/docs/_develop/build-docs/build-docs.md b/docs/_develop/build-docs/build-docs.md index 42e6bb9f..b4a160e9 100644 --- a/docs/_develop/build-docs/build-docs.md +++ b/docs/_develop/build-docs/build-docs.md @@ -87,4 +87,4 @@ $ npm run build ## 7. 更新模型文档 -Konfig 中的 [模型文档](/docs/user_docs/reference/model) 是从 KCL 代码，通过 [docgen](/docs/user_docs/reference/cli/kcl/docgen) 工具自动提取产生（比如自动生成的 [ConfigMap](/docs/user_docs/reference/model/kusion_models/kube/frontend/configmap/doc_configmap) 模型文档）。如果希望完善模型文档，首先需要到 [Konfig 代码仓库](https://github.com/KusionStack/konfig) 添加或更新文档，然后重新生成文档（目前还不能自动同步，有兴趣的用户可以尝试 [提供帮助](/docs/governance/contribute/contribute-docs)）。 +Konfig 中的 [模型文档](/docs/user_docs/reference/model) 是从 KCL 代码，通过 [docgen](/docs/user_docs/reference/commands/kcl/docgen) 工具自动提取产生（比如自动生成的 [ConfigMap](/docs/user_docs/reference/model/kusion_models/kube/frontend/configmap/doc_configmap) 模型文档）。如果希望完善模型文档，首先需要到 [Konfig 代码仓库](https://github.com/KusionStack/konfig) 添加或更新文档，然后重新生成文档（目前还不能自动同步，有兴趣的用户可以尝试 [提供帮助](/docs/governance/contribute/contribute-docs)）。 diff --git a/docs/user_docs/getting-started/_konfig.md b/docs/user_docs/getting-started/_konfig.md index 09f9a13c..6bdcf0ee 100644 --- a/docs/user_docs/getting-started/_konfig.md +++ b/docs/user_docs/getting-started/_konfig.md @@ -57,6 +57,6 @@ Konfig 配置大库整体结构如下： ![](/img/docs/user_docs/getting-started/konfig-arch-01.png) -核心模型内部通过前端模型和后端模型两层抽象简化前端用户的配置代码，底层模型则是通过 [KCL OpenAPI](/docs/user_docs/reference/cli/openapi) 工具自动生成。 +核心模型内部通过前端模型和后端模型两层抽象简化前端用户的配置代码，底层模型则是通过 [KCL OpenAPI](/docs/user_docs/reference/commands/openapi) 工具自动生成。 模型的更详细文档可参考 [参考手册/Kusion 模型库](/docs/user_docs/reference/model)。 diff --git a/docs/user_docs/guides/working-with-k8s/1-deploy-application.md b/docs/user_docs/guides/working-with-k8s/1-deploy-application.md index 2023ebf4..1ed69e47 100644 --- a/docs/user_docs/guides/working-with-k8s/1-deploy-application.md +++ b/docs/user_docs/guides/working-with-k8s/1-deploy-application.md @@ -124,7 +124,7 @@ The output of `kusion compile` is the spec format. :::tip -For instructions on the kusion command line tool, execute `kusion -h`, or refer to the tool's online [documentation](/docs/user_docs/reference/cli/kusion/index)。 +For instructions on the kusion command line tool, execute `kusion -h`, or refer to the tool's online [documentation](../../reference/commands/index.md). ::: ## Applying diff --git a/docs/user_docs/intro/kusion-vs-x.md b/docs/user_docs/intro/kusion-vs-x.md index 173d9743..9a92bec7 100644 --- a/docs/user_docs/intro/kusion-vs-x.md +++ b/docs/user_docs/intro/kusion-vs-x.md @@ -10,7 +10,7 @@ It can be difficult to understand how different software compare to each other. According to the [open GitOps principles](https://opengitops.dev/), GitOps systems typically have its desired state expressed declaratively, continuously observe actual system state and attempt to apply the desired state. In the design of Kusion toolchain, we refer to those principles but have no intention to reinvent any GitOps systems wheel. -Kusion adopts your GitOps process and improves it with richness of features. The declarative [AppConfiguration](/docs/user_docs/concepts/appconfiguration) model can be used to express desired intent, once intent is declared [Kusion CLI](/docs/user_docs/reference/cli/kusion) takes the role to make production match intent as safely as possible. +Kusion adopts your GitOps process and improves it with richness of features. The declarative [AppConfiguration](../concepts/appconfiguration.md) model can be used to express desired intent, once intent is declared [Kusion CLI](../reference/commands/index.md) takes the role to make production match intent as safely as possible. **vs. PaaS (Heroku, Vercel, etc.)** diff --git a/docs/user_docs/reference/cli/_category_.json b/docs/user_docs/reference/cli/_category_.json deleted file mode 100644 index 887061ef..00000000 --- a/docs/user_docs/reference/cli/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Command Line Tools", - "position": 1 -} diff --git a/docs/user_docs/reference/cli/index.md b/docs/user_docs/reference/cli/index.md deleted file mode 100644 index b4f861dd..00000000 --- a/docs/user_docs/reference/cli/index.md +++ /dev/null @@ -1 +0,0 @@ -# Command Line Tools diff --git a/docs/user_docs/reference/cli/kusion/_category_.json b/docs/user_docs/reference/commands/_category_.json similarity index 100% rename from docs/user_docs/reference/cli/kusion/_category_.json rename to docs/user_docs/reference/commands/_category_.json diff --git a/docs/user_docs/reference/cli/kusion/index.md b/docs/user_docs/reference/commands/index.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/index.md rename to docs/user_docs/reference/commands/index.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_apply.md b/docs/user_docs/reference/commands/kusion_apply.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_apply.md rename to docs/user_docs/reference/commands/kusion_apply.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_build.md b/docs/user_docs/reference/commands/kusion_build.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_build.md rename to docs/user_docs/reference/commands/kusion_build.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_compile.md b/docs/user_docs/reference/commands/kusion_compile.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_compile.md rename to docs/user_docs/reference/commands/kusion_compile.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_destroy.md b/docs/user_docs/reference/commands/kusion_destroy.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_destroy.md rename to docs/user_docs/reference/commands/kusion_destroy.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_init.md b/docs/user_docs/reference/commands/kusion_init.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_init.md rename to docs/user_docs/reference/commands/kusion_init.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_preview.md b/docs/user_docs/reference/commands/kusion_preview.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_preview.md rename to docs/user_docs/reference/commands/kusion_preview.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_version.md b/docs/user_docs/reference/commands/kusion_version.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_version.md rename to docs/user_docs/reference/commands/kusion_version.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_workspace.md b/docs/user_docs/reference/commands/kusion_workspace.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_workspace.md rename to docs/user_docs/reference/commands/kusion_workspace.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_workspace_create.md b/docs/user_docs/reference/commands/kusion_workspace_create.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_workspace_create.md rename to docs/user_docs/reference/commands/kusion_workspace_create.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_workspace_delete.md b/docs/user_docs/reference/commands/kusion_workspace_delete.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_workspace_delete.md rename to docs/user_docs/reference/commands/kusion_workspace_delete.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_workspace_list.md b/docs/user_docs/reference/commands/kusion_workspace_list.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_workspace_list.md rename to docs/user_docs/reference/commands/kusion_workspace_list.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_workspace_show.md b/docs/user_docs/reference/commands/kusion_workspace_show.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_workspace_show.md rename to docs/user_docs/reference/commands/kusion_workspace_show.md diff --git a/docs/user_docs/reference/cli/kusion/kusion_workspace_update.md b/docs/user_docs/reference/commands/kusion_workspace_update.md similarity index 100% rename from docs/user_docs/reference/cli/kusion/kusion_workspace_update.md rename to docs/user_docs/reference/commands/kusion_workspace_update.md diff --git a/versioned_docs/version-v0.9/_develop/build-docs/build-docs.md b/versioned_docs/version-v0.9/_develop/build-docs/build-docs.md index 42e6bb9f..1efce642 100644 --- a/versioned_docs/version-v0.9/_develop/build-docs/build-docs.md +++ b/versioned_docs/version-v0.9/_develop/build-docs/build-docs.md @@ -87,4 +87,4 @@ $ npm run build ## 7. 更新模型文档 -Konfig 中的 [模型文档](/docs/user_docs/reference/model) 是从 KCL 代码，通过 [docgen](/docs/user_docs/reference/cli/kcl/docgen) 工具自动提取产生（比如自动生成的 [ConfigMap](/docs/user_docs/reference/model/kusion_models/kube/frontend/configmap/doc_configmap) 模型文档）。如果希望完善模型文档，首先需要到 [Konfig 代码仓库](https://github.com/KusionStack/konfig) 添加或更新文档，然后重新生成文档（目前还不能自动同步，有兴趣的用户可以尝试 [提供帮助](/docs/governance/contribute/contribute-docs)）。 +Konfig 中的 [模型文档](../../user_docs/reference/model) 是从 KCL 代码，通过 docgen 工具自动提取产生（比如自动生成的 [ConfigMap](../../user_docs/reference/model/kusion_models/kube/frontend/configmap/doc_configmap) 模型文档）。如果希望完善模型文档，首先需要到 [Konfig 代码仓库](https://github.com/KusionStack/konfig) 添加或更新文档，然后重新生成文档（目前还不能自动同步，有兴趣的用户可以尝试提供帮助。 diff --git a/versioned_docs/version-v0.9/user_docs/getting-started/_konfig.md b/versioned_docs/version-v0.9/user_docs/getting-started/_konfig.md index 09f9a13c..6ab304cc 100644 --- a/versioned_docs/version-v0.9/user_docs/getting-started/_konfig.md +++ b/versioned_docs/version-v0.9/user_docs/getting-started/_konfig.md @@ -57,6 +57,6 @@ Konfig 配置大库整体结构如下： ![](/img/docs/user_docs/getting-started/konfig-arch-01.png) -核心模型内部通过前端模型和后端模型两层抽象简化前端用户的配置代码，底层模型则是通过 [KCL OpenAPI](/docs/user_docs/reference/cli/openapi) 工具自动生成。 +核心模型内部通过前端模型和后端模型两层抽象简化前端用户的配置代码，底层模型则是通过 KCL OpenAPI 工具自动生成。 模型的更详细文档可参考 [参考手册/Kusion 模型库](/docs/user_docs/reference/model)。 diff --git a/versioned_docs/version-v0.9/user_docs/guides/working-with-k8s/1-deploy-application.md b/versioned_docs/version-v0.9/user_docs/guides/working-with-k8s/1-deploy-application.md index 2023ebf4..46c6b011 100644 --- a/versioned_docs/version-v0.9/user_docs/guides/working-with-k8s/1-deploy-application.md +++ b/versioned_docs/version-v0.9/user_docs/guides/working-with-k8s/1-deploy-application.md @@ -124,7 +124,7 @@ The output of `kusion compile` is the spec format. :::tip -For instructions on the kusion command line tool, execute `kusion -h`, or refer to the tool's online [documentation](/docs/user_docs/reference/cli/kusion/index)。 +For instructions on the kusion command line tool, execute `kusion -h`, or refer to the tool's online [documentation](../../reference/cli/kusion/index.md). ::: ## Applying diff --git a/versioned_docs/version-v0.9/user_docs/intro/kusion-vs-x.md b/versioned_docs/version-v0.9/user_docs/intro/kusion-vs-x.md index 173d9743..c98b278e 100644 --- a/versioned_docs/version-v0.9/user_docs/intro/kusion-vs-x.md +++ b/versioned_docs/version-v0.9/user_docs/intro/kusion-vs-x.md @@ -10,7 +10,7 @@ It can be difficult to understand how different software compare to each other. According to the [open GitOps principles](https://opengitops.dev/), GitOps systems typically have its desired state expressed declaratively, continuously observe actual system state and attempt to apply the desired state. In the design of Kusion toolchain, we refer to those principles but have no intention to reinvent any GitOps systems wheel. -Kusion adopts your GitOps process and improves it with richness of features. The declarative [AppConfiguration](/docs/user_docs/concepts/appconfiguration) model can be used to express desired intent, once intent is declared [Kusion CLI](/docs/user_docs/reference/cli/kusion) takes the role to make production match intent as safely as possible. +Kusion adopts your GitOps process and improves it with richness of features. The declarative [AppConfiguration](../concepts/appconfiguration.md) model can be used to express desired intent, once intent is declared [Kusion CLI](../reference/cli/kusion/index.md) takes the role to make production match intent as safely as possible. **vs. PaaS (Heroku, Vercel, etc.)**