Skip to content

Commit

Permalink
fix some description problems in docs and related codes
Browse files Browse the repository at this point in the history
  • Loading branch information
liu-hm19 committed Jul 14, 2023
1 parent 87c97f3 commit 3570fed
Show file tree
Hide file tree
Showing 32 changed files with 1,501 additions and 1,497 deletions.
11 changes: 5 additions & 6 deletions docs/cmd/en_US/kusion.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kusion

Kusion is the entry point to use KusionStack
Kusion is the platform engineering engine of KusionStack

### Synopsis

The Kusion command line tool is the entry point for users to use KusionStack. Users can use the Kusion command line tool to complete all operation tasks.
Kusion is the platform engineering engine of KusionStack. It delivers intentions to Kubernetes, Clouds, and on-premise resources.

```
kusion [flags]
Expand All @@ -19,14 +19,13 @@ kusion [flags]
### SEE ALSO

* [kusion apply](kusion_apply.md) - Apply the operation intents of various resources to multiple runtime
* [kusion check](kusion_check.md) - Check if KCL configurations in current directory ok to compile
* [kusion compile](kusion_compile.md) - Compile KCL into YAML
* [kusion deps](kusion_deps.md) - Show KCL file dependency information
* [kusion destroy](kusion_destroy.md) - Delete the resources of a specified stack in runtime
* [kusion destroy](kusion_destroy.md) - Delete the specified resources in runtime
* [kusion env](kusion_env.md) - Print Kusion environment information
* [kusion init](kusion_init.md) - Initialize the scaffolding for a project
* [kusion ls](kusion_ls.md) - List all project and stack information
* [kusion ls](kusion_ls.md) - List all Projects and Stacks
* [kusion preview](kusion_preview.md) - Preview a series of resource changes within the stack
* [kusion version](kusion_version.md) - Print the kusion version info

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/en_US/kusion_apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,6 @@ kusion apply [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/en_US/kusion_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ kusion check [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/en_US/kusion_compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,6 @@ kusion compile [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/en_US/kusion_deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ kusion deps [WORKDIR] [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
6 changes: 3 additions & 3 deletions docs/cmd/en_US/kusion_destroy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## kusion destroy

Delete the resources of a specified stack in runtime
Delete the specified resources in runtime

### Synopsis

Expand Down Expand Up @@ -38,6 +38,6 @@ kusion destroy [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/en_US/kusion_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ kusion env [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/en_US/kusion_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ kusion init

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack
* [kusion init templates](kusion_init_templates.md) - List templates used to initialize a project

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
2 changes: 1 addition & 1 deletion docs/cmd/en_US/kusion_init_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ kusion init templates

* [kusion init](kusion_init.md) - Initialize the scaffolding for a project

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
6 changes: 3 additions & 3 deletions docs/cmd/en_US/kusion_ls.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## kusion ls

List all project and stack information
List all Projects and Stacks

### Synopsis

Expand Down Expand Up @@ -45,6 +45,6 @@ kusion ls [WORKDIR] [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/en_US/kusion_preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ kusion preview [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/en_US/kusion_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ kusion version [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion is the entry point to use KusionStack
* [kusion](kusion.md) - Kusion is the platform engineering engine of KusionStack

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
13 changes: 6 additions & 7 deletions docs/cmd/zh_CN/kusion.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kusion

Kusion 是使用 KusionStack 的入口
Kusion KusionStack 的平台工程引擎

### Synopsis

Kusion 命令行工具是用户使用 KusionStack 的入口。 用户可以使用 Kusion 命令行工具完成所有的运维操作
Kusion KusionStack 的平台工程引擎。 它将运维意图交付至 Kubernetes、云服务和本地部署的资源中

```
kusion [flags]
Expand All @@ -19,14 +19,13 @@ kusion [flags]
### SEE ALSO

* [kusion apply](kusion_apply.md) - 将各类资源的运维意图 apply 至多种运行时里 (Kubernetes、AWS/阿里云以及自建系统等)
* [kusion check](kusion_check.md) - Check if KCL configurations in current directory ok to compile
* [kusion compile](kusion_compile.md) - 将 KCL 编译成 YAML
* [kusion deps](kusion_deps.md) - Show KCL file dependency information
* [kusion destroy](kusion_destroy.md) - 删除一个特定 stack 在运行时中的资源
* [kusion destroy](kusion_destroy.md) - 删除运行时中指定的资源
* [kusion env](kusion_env.md) - Print Kusion environment information
* [kusion init](kusion_init.md) - 初始化一个 project 的脚手架
* [kusion ls](kusion_ls.md) - List all project and stack information
* [kusion init](kusion_init.md) - 初始化一个 Project 的脚手架
* [kusion ls](kusion_ls.md) - List all Projects and Stacks
* [kusion preview](kusion_preview.md) - 预览 Stack 中的一系列资源更改
* [kusion version](kusion_version.md) - Print the kusion version info

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/zh_CN/kusion_apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ kusion apply [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/zh_CN/kusion_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ kusion check [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/zh_CN/kusion_compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,6 @@ kusion compile [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
6 changes: 3 additions & 3 deletions docs/cmd/zh_CN/kusion_deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ kusion deps [WORKDIR] [flags]
### Options

```
--direct string project 信息的输出格式。可选值:json、yaml、tree、human (default "up")
--direct string Project 信息的输出格式。可选值:json、yaml、tree、human (default "up")
--focus strings Paths to focus on to inspect. It cannot be empty and each path needs to be a valid relative path from the workdir
-h, --help help for deps
--ignore strings File paths to ignore when filtering the affected stacks/projects. Each path needs to be a valid relative path from the workdir. If not set, no paths will be ignored.
Expand All @@ -38,6 +38,6 @@ kusion deps [WORKDIR] [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
6 changes: 3 additions & 3 deletions docs/cmd/zh_CN/kusion_destroy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## kusion destroy

删除一个特定 stack 在运行时中的资源
删除运行时中指定的资源

### Synopsis

Expand Down Expand Up @@ -38,6 +38,6 @@ kusion destroy [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/zh_CN/kusion_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ kusion env [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
24 changes: 12 additions & 12 deletions docs/cmd/zh_CN/kusion_init.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kusion init

初始化一个 project 的脚手架
初始化一个 Project 的脚手架

### Synopsis

该指令用于初始化一个 project 脚手架,从选定的模板生成具备正确结构的 project.
该指令用于初始化一个 Project 脚手架,从选定的模板生成具备正确结构的 Project。

脚手架模板可以从本地或者线上获取。默认使用内置模板;若需要使用自定义的模板,需要指定模板仓库的地址。

Expand All @@ -15,16 +15,16 @@ kusion init
### Examples

```
# 从本地内置模板中初始化一个 project
# 从本地内置模板中初始化一个 Project
kusion init
# 从默认的在线模板中初始化一个 project
# 从默认的在线模板中初始化一个 Project
kusion init --online=true
# 从指定的在线模板初始化一个 project
# 从指定的在线模板初始化一个 Project
kusion init https://github.com/<user>/<repo> --online=true
# 从指定的本地模板初始化一个 project
# 从指定的本地模板初始化一个 Project
kusion init /path/to/templates
```

Expand All @@ -34,15 +34,15 @@ kusion init
--custom-params string JSON 格式的自定义参数。若指定,那么会用其作为默认的模板参数,并跳过提示
--force 强制生成脚手架文件,即使会更改现有文件
-h, --help help for init
--online 使用线上模板初始化 project,否则使用本地缓存模板
--project-name string 用指定的 project 名称初始化。若不指定,将有提示请求获取
--online 使用线上模板初始化 Project,否则使用本地缓存模板
--project-name string 用指定的 Project 名称初始化。若不指定,将有提示请求获取
--template-name string 用指定的模板初始化。若不指定,将有提示请求获取
--yes 跳过提示,使用默认值初始化 project
--yes 跳过提示,使用默认值初始化 Project
```

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion init templates](kusion_init_templates.md) - 列出用于初始化 project 的模板
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎
* [kusion init templates](kusion_init_templates.md) - 列出用于初始化 Project 的模板

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
10 changes: 5 additions & 5 deletions docs/cmd/zh_CN/kusion_init_templates.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kusion init templates

列出用于初始化 project 的模板
列出用于初始化 Project 的模板

### Synopsis

该指令获取用于初始化 project 脚手架的模板的描述和定义。
该指令获取用于初始化 Project 脚手架的模板的描述和定义。

```
kusion init templates
Expand All @@ -30,11 +30,11 @@ kusion init templates
### Options inherited from parent commands

```
--online 使用线上模板初始化 project,否则使用本地缓存模板
--online 使用线上模板初始化 Project,否则使用本地缓存模板
```

### SEE ALSO

* [kusion init](kusion_init.md) - 初始化一个 project 的脚手架
* [kusion init](kusion_init.md) - 初始化一个 Project 的脚手架

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
8 changes: 4 additions & 4 deletions docs/cmd/zh_CN/kusion_ls.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## kusion ls

List all project and stack information
List all Projects and Stacks

### Synopsis

Expand Down Expand Up @@ -40,11 +40,11 @@ kusion ls [WORKDIR] [flags]
```
--format string project 信息的输出格式。可选值:json、yaml、tree、human (default "human")
-h, --help help for ls
-L, --level int projectstack 树的最大显示深度。可选值:0、1、2 (default 2)
-L, --level int ProjectStack 树的最大显示深度。可选值:0、1、2 (default 2)
```

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/zh_CN/kusion_preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ kusion preview [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
4 changes: 2 additions & 2 deletions docs/cmd/zh_CN/kusion_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ kusion version [flags]

### SEE ALSO

* [kusion](kusion.md) - Kusion 是使用 KusionStack 的入口
* [kusion](kusion.md) - Kusion KusionStack 的平台工程引擎

###### Auto generated by spf13/cobra on 13-Jul-2023
###### Auto generated by spf13/cobra on 14-Jul-2023
7 changes: 3 additions & 4 deletions pkg/cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,11 @@ func NewKusionctlCmd(in io.Reader, out, err io.Writer) *cobra.Command {
updateCheckResult := make(chan string)

var (
rootShort = i18n.T(`Kusion is the entry point to use KusionStack`)
rootShort = i18n.T(`Kusion is the platform engineering engine of KusionStack`)

rootLong = i18n.T(`
The Kusion command line tool is the entry point for users to use KusionStack.
Users can use the Kusion command line tool to complete all operation tasks.
`)
Kusion is the platform engineering engine of KusionStack.
It delivers intentions to Kubernetes, Clouds, and on-premise resources.`)
)

// Parent command to which all subcommands are added.
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/destroy/destroy.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (

func NewCmdDestroy() *cobra.Command {
var (
destroyShort = i18n.T(`Delete the resources of a specified stack in runtime`)
destroyShort = i18n.T(`Delete the specified resources in runtime`)

destroyLong = i18n.T(`
Delete resources by resource spec.
Expand Down
Loading

0 comments on commit 3570fed

Please sign in to comment.