文档指南 ¶

CLI 命令 ¶

kops 使用 cobra 来实现其 CLI。每个命令应在可能的情况下定义以下帮助字段

Short：用第三人称现在时描述命令的简短语句，以大写字母开头，末尾不加句号。
示例："编辑集群"
Long：用第三人称现在时描述命令的扩展描述和用法，以大写字母开头，末尾加句号。Short 字段中的文本应为 Long 字段的第一句话。示例
```
Edits a cluster.

This command changes the cloud specification in the registry.

It does not update the cloud resources, to apply the changes use "kops update cluster".
```
Example：使用该命令的示例。此字段在文档中格式化为代码片段，因此请确保如果您有注释，这些注释应写为 bash 注释（例如 # this is a comment）。

make live-docs 运行一个 docker 容器，在本地工作时实时构建和查看文档

make build-docs 将构建文档的最终版本，该版本将通过自动化方式签入。