文档标题(与文首 metadata 中的 title 名称保持一致)
- 本文档为操作指南类模板,主要包含任务信息。你可直接复制使用,并删除模板中不需要的说明。该类文档示例:TiDB 数据库快速上手指南
- 对于新文档,请在 TOC.md 中合适的位置加目录(思考用户最有可能在目录哪里找文档)。
- 文内标题级别不可跳级,尽量避免使用五级标题。
[必须]第一段对该文档进行概括性介绍,几句话即可。
可采用类似“本文介绍如何(使用)……部署……”的句型。
介绍在开始操作前需准备的软硬件环境,如机器、网络、软件版本等。
每一步内可以分小步骤,通常使用有序列表( 1, 2, 3, … )来标示顺序。
xxx
这里如果有进一步的解释内容,请在前面空一行,并在本行首缩进四个空格。
如果需要添加注意或警告事项,需严格遵循以下格式。
如果注意或警告事项嵌套在列表内,需要缩进四个空格(官网文档中的缩进建议统一采用四个空格,以避免 PingCAP 官网显示错乱)。
xxx
- 子步骤 1
- 子步骤 2
子步骤 3
或
- 并列项描述
- 并列项描述
- 并列项描述
xxx 如果此步骤涉及到某配置文件的更新,请给出此配置文件的详细位置,比如是在哪个节点的哪个位置,配置文档的名称是什么,并在配置文件中关键字段进行解释,方便用户理解。
xxx
每一步骤后,最好提供查看/验证操作是否成功的方法,以便用户参考。
xxx
xxx
- 如果需要查看 TiFlash 版本、TiFlash 重要日志及系统表,请参阅 TiFlash 集群运维。
- 如果需要移除某个 TiFlash 节点,请参阅。
或直接给出用户接下来可能感兴趣的文档,如: