文档标题(与文首 metadata 中的 title 名称保持一致)
模板说明:
- 本文档为操作指南类模板,主要包含任务信息。你可直接复制使用,并删除模板中不需要的说明。该类文档示例:TiDB 数据库快速上手指南
- 对于新文档,请在 TOC.md 中合适的位置加目录(思考用户最有可能在目录哪里找文档)。
- 文内标题级别不可跳级,尽量避免使用五级标题。
[必须]第一段对该文档进行概括性介绍,几句话即可。
可采用类似“本文介绍如何(使用)……部署……”的句型。
二级标题 1(文内标题级别不可跳级,通常为“准备环境”、“前置检查”等)
介绍在开始操作前需准备的软硬件环境,如机器、网络、软件版本等。
第 1 步:xxx
每一步内可以分小步骤,通常使用有序列表( 1, 2, 3, … )来标示顺序。
xxx
这里如果有进一步的解释内容,请在前面空一行,并在本行首缩进四个空格。
如果需要添加注意或警告事项,需严格遵循以下格式。
警告:
对于可能会给用户带来风险的信息,例如系统可用性、安全、数据丢失等,请使用警告。例如:请勿在备份前删除此文件,否则可能导致系统不可用。
注意:
对于一般性的提示内容,请使用注意。例如:读取历史数据时,即使当前数据的表结构相较于历史数据的表结构已经发生改变,历史数据也会以当时的历史表结构来返回。
如果注意或警告事项嵌套在列表内,需要缩进四个空格(官网文档中的缩进建议统一采用四个空格,以避免 PingCAP 官网显示错乱)。
xxx
如果有代码块,也需在代码块前空一行,并且比上一级缩进四个空格。如果代码块里的内容是用户需要复制的(比如可执行的 shell/bash 命令、SQL 语句等),需要在代码块前加入 ,例如:
xxx
xxx
预期输出:
xxx
xxx
如果输出中有 xxx 报错,请进行 xxx 排除报错。
xxx
如果还有子项,如果子项之间有先后顺序关系,请使用有序列表(1, 2, 3, …)来标示顺序,如果子项之间没有先后顺序关系,请使用无序列表(+/-/*),同样注意比上一级缩进四个空格。
- 子步骤 1
- 子步骤 2
子步骤 3
或
- 并列项描述
- 并列项描述
- 并列项描述
xxx 如果此步骤涉及到某配置文件的更新,请给出此配置文件的详细位置,比如是在哪个节点的哪个位置,配置文档的名称是什么,并在配置文件中关键字段进行解释,方便用户理解。
### tidb-lightning 全局配置
[lightning]
# 用于拉取 web 界面和 Prometheus 监控项的 HTTP 端口。设置为 0 时为禁用状态。
status-addr = ':8289'
# 切换为服务器模式并使用 web 界面
# 详情参见“TiDB Lightning web 界面”文档
server-mode = false
# 日志
level = "info"
file = "tidb-lightning.log"
max-size = 128 # MB
max-days = 28
max-backups = 14
xxx
每一步骤后,最好提供查看/验证操作是否成功的方法,以便用户参考。
第 2 步:xxx
xxx
- xxx
- xxx
xxx
xxx
第 3 步:xxx
探索更多
本小节给出更多用户可能想看到的相关文档,如:
- 如果需要查看 TiFlash 版本、TiFlash 重要日志及系统表,请参阅 TiFlash 集群运维。
- 如果需要移除某个 TiFlash 节点,请参阅缩容 TiFlash 节点。
或直接给出用户接下来可能感兴趣的文档,如: