文档变更¶
文档帮助我们的客户理解如何使用工作流并自行解决问题。
文档变更会由CI检查拼写、失效链接和代码规范问题。如需本地检查，请运行make docs。
通用指南：
- 解释何时需要使用某个功能。
- 提供实际可用的示例。
- 使用反引号格式化代码，避免被标记为拼写错误。
- Markdown文档建议每行只写一个句子
- Follow the recommendations in the official Kubernetes Documentation Style Guide.
本地运行¶
本地测试/运行：
make docs-serve
提示¶
使用像Grammarly这样的服务来检查你的语法。
让电脑朗读文本是发现问题的有效方法，例如：
- 单词替换（即使用了错误的单词，但拼写正确）。
- 读起来不正确的句子听起来会很别扭。
在Mac上，设置步骤如下：
- 前往
System Preferences / Accessibility / Spoken Content（系统偏好设置/辅助功能/朗读内容）。 - 选择一个系统语音（我喜欢
Siri Voice 1）。 - 启用
Speak selection功能。
要听取文本内容，请先选中您想听的文本，然后按下option+escape键。