文档标题（与文首 metadata 中的 title 名称保持一致）

模板说明：

  • 本文档为概念介绍类模板，主要包含概念和说明信息。你可直接复制使用，并删除模板中不需要的说明。该类文档示例：TiDB Binlog。
  • 对于新文档，请在 TOC.md 中合适的位置加目录（思考用户最有可能在目录哪里找文档）。
  • 文内标题级别不可跳级，尽量避免使用五级标题。

[必须]第一段对该文档进行概括性介绍，几句话即可。

对于某些概念和定义，你可在本段落用一到三句话介绍这些核心名词（类似定义）。

二级标题 1

以整体架构为例，你可以先一两句话介绍该架构包含哪些核心组件，再提供对应的架构图。

图片的大小请控制在 300 KB 以内，建议使用 .png 或.jpg 格式的图片，不支持使用 .gif 和 .svg 格式的图片。

架构图下面可以提供通过无序列表的形式分别介绍各组件。

这里可以简单介绍一下工作原理，或者融入到以上的组件介绍中。

三级标题 1 （可选，如组件名称）

如果文档内容较复杂，也可采用三级标题的形式。

三级标题 2

xxx

二级标题 2（可选，如“主要特性/功能介绍/使用限制”）

对于概念简介类文档，本标题下可介绍用户在使用前应了解的信息，如“主要特性/功能介绍/使用限制”等。如果不需要提供这类信息，可略去本标题。

如果需要添加注意或警告事项，需严格遵循以下格式。

警告：

对于可能会给用户带来风险的信息，例如系统可用性、安全、数据丢失等，请使用警告。例如：当前该功能为实验特性，不建议在生产环境中使用。

注意：

对于一般性的提示内容，请使用注意。例如：读取历史数据时，即使当前数据的表结构相较于历史数据的表结构已经发生改变，历史数据也会以当时的历史表结构来返回。

如果注意或警告事项嵌套在列表内，需要缩进四个空格（官网文档中的缩进建议统一采用四个空格，以避免 PingCAP 官网显示错乱）。

探索更多

本小节给出更多用户可能想看到的相关文档，如：

或直接给出用户接下来可能感兴趣的文档，如：