*: fix markdownlint issues in all docs

.circleci/config.yml

@@ -13,7 +13,7 @@ jobs:
           command: |
             sudo npm install -g markdownlint-cli
             markdownlint --version
-            
+
       - run:
           name: "Lint dev"
           command: markdownlint dev/

.github/ISSUE_TEMPLATE/bug-report.md

@@ -3,6 +3,10 @@ name: "\U0001F41B Bug Report"
 about: Typo, Grammatical error, etc.。
 ---
 
+<!-- markdownlint-disable MD012 -->
+<!-- markdownlint-disable MD029 -->
+<!-- markdownlint-disable MD041 -->
+
 ## Bug 报告
 
 **This repository is ONLY used to solve problems related to DOCS-CN.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -3,8 +3,11 @@ name: "\U0001F680 Feature Request"
 about: Any suggestion? Want to add something new?
 ---
 
-## Feature Request
+<!-- markdownlint-disable MD012 -->
+<!-- markdownlint-disable MD029 -->
+<!-- markdownlint-disable MD041 -->
 
+## Feature Request
 
 **This repository is ONLY used to solve problems related to DOCS-CN.
 For other issues (TiDB, TiKV, etc), please move to [other repositories](https://github.com/pingcap/).**

.github/ISSUE_TEMPLATE/question.md

@@ -3,10 +3,12 @@ name: "\U0001F914 Question"
 about: Usage question that isn't answered in docs or discussion
 ---
 
+<!-- markdownlint-disable MD041 -->
+
 ## Question
 
 **This repository is ONLY used to solve problems related to DOCS-CN.
-For other issues (TiDB, TiKV, etc), please move to [other repositories](https://github.com/pingcap/).**  
+For other issues (TiDB, TiKV, etc), please move to [other repositories](https://github.com/pingcap/).**
 <!-- 本仓库仅用于解决与中文文档相关的问题，
 其他方面问题（如 TiDB、TiKV 等），请移步其他[相关仓库](https://github.com/pingcap/)。 -->
 
@@ -19,6 +21,6 @@ Before asking a question, make sure you have:
 - Searched open and closed [GitHub issues](https://github.com/pingcap/docs-cn/issues?utf8=%E2%9C%93&q=is%3Aissue).
 <!-- - 查阅了相关的 issues。 -->
 - Read the documentation:
+    - [TiDB Doc](https://github.com/pingcap/docs)
+    - [TiDB Doc-cn](https://github.com/pingcap/docs-cn)
 <!-- - 阅读了相关文档。 -->
-  - [TiDB Doc](https://github.com/pingcap/docs)
-  - [TiDB Doc-cn](https://github.com/pingcap/docs-cn)

.markdownlint.yaml

@@ -16,7 +16,7 @@ no-missing-space-atx: true
 no-multiple-space-atx: true
 blanks-around-headings: true
 heading-start-left: true
-no-duplicate-heading: 
+no-duplicate-heading:
   siblings_only: true
 single-title:
   front_matter_title: ''

_index.md

@@ -10,7 +10,7 @@ TiDB 是 PingCAP 公司设计的开源分布式 HTAP (Hybrid Transactional and A
 TiDB 具备如下特性：
 
 - 高度兼容 MySQL
-    
+
     [大多数情况下](/v3.0/reference/mysql-compatibility.md)，无需修改代码即可从 MySQL 轻松迁移至 TiDB，分库分表后的 MySQL 集群亦可通过 TiDB 工具进行实时迁移。
 
 - 水平弹性扩展

dev/benchmark/sysbench-v3.md

@@ -26,7 +26,7 @@ IDC 机器：
 | OS | Linux (CentOS 7.3.1611) |
 | CPU | 40 vCPUs, Intel(R) Xeon(R) CPU E5-2630 v4 @ 2.20GHz |
 | RAM | 128GB |
-| DISK | Optane 500GB SSD \* 1 |  
+| DISK | Optane 500GB SSD \* 1 |
 
 Sysbench 版本：1.1.0
 

dev/benchmark/sysbench.md

@@ -49,7 +49,7 @@ CREATE TABLE `sbtest` (
   `pad` char(60) NOT NULL DEFAULT '',
   PRIMARY KEY (`id`),
   KEY `k_1` (`k`)
-) ENGINE=InnoDB  
+) ENGINE=InnoDB
 ```
 
 部署方案以及配置参数
@@ -59,7 +59,7 @@ CREATE TABLE `sbtest` (
 172.16.20.4    4*tikv    1*tidb    1*sysbench
 172.16.20.6    4*tikv    1*tidb    1*sysbench
 172.16.20.7    4*tikv    1*tidb    1*sysbench
-172.16.10.8    1*tidb    1*pd      1*sysbench  
+172.16.10.8    1*tidb    1*pd      1*sysbench
 
 // 每个物理节点有三块盘：
 data3: 2 tikv  (Optane SSD)
@@ -89,8 +89,8 @@ Mysql version: 5.6.37
 thread_cache_size = 64
 innodb_buffer_pool_size = 64G
 innodb_file_per_table = 1
-innodb_flush_log_at_trx_commit = 0  
-datadir = /data3/mysql  
+innodb_flush_log_at_trx_commit = 0
+datadir = /data3/mysql
 max_connections = 2000
 ```
 

dev/benchmark/tpcc.md

@@ -26,7 +26,7 @@ IDC 机器：
 | OS | Linux (CentOS 7.3.1611) |
 | CPU | 40 vCPUs, Intel(R) Xeon(R) CPU E5-2630 v4 @ 2.20GHz |
 | RAM | 128GB |
-| DISK | 1.5TB SSD \* 2 |  
+| DISK | 1.5TB SSD \* 2 |
 
 本文使用开源的 BenchmarkSQL 5.0 作为 TPC-C 测试工具并添加对 MySQL 协议支持， 可以通过以下命令下载测试程序:
 

dev/how-to/deploy/tidb-binlog.md

@@ -82,9 +82,9 @@ category: reference
     参照上文配置完 `inventory.ini` 文件后，从以下两种方式中选择一种进行部署。
 
     **方式一**：在已有的 TiDB 集群上增加 Pump 组件，需按以下步骤逐步进行。
-  
+
     1. 部署 pump_servers 和 node_exporters
-  
+
         ```
         ansible-playbook deploy.yml -l ${pump1_ip},${pump2_ip},[${alias1_name},${alias2_name}]
         ```
@@ -336,7 +336,7 @@ Drainer="192.168.0.13"
         ```bash
         ./bin/pump -config pump.toml
         ```
-  
+
         如果命令行参数与配置文件中的参数重合，则使用命令行设置的参数的值。
 
 2. 使用 binary 部署 Drainer
@@ -474,7 +474,7 @@ Drainer="192.168.0.13"
         # topic-name = ""
         ```
 
-    - 启动示例  
+    - 启动示例
 
         > **注意：**
         >

dev/how-to/get-started/deploy-tidb-from-kubernetes-dind.md

@@ -427,7 +427,7 @@ demo-tikv-2                       1/1       Running     0          1m
     mkdir -p /home/tidb/demo && \
     helm inspect values pingcap/tidb-cluster --version=${chartVersion} > /home/tidb/demo/values-demo.yaml
     ```
-  
+
 2. 编辑 `/home/tidb/demo/values-demo.yaml`。
 
     例如，要扩容集群，可以将 TiKV `replicas` 从 3 修改为 5，或者将 TiDB `replicas` 从 2 修改为 3。

dev/how-to/maintain/tidb-binlog.md

@@ -116,7 +116,7 @@ Usage of binlogctl:
     ```
 
 - 修改 Pump/Drainer 的状态
-  
+
     设置 `cmd` 为 `update-pump` 或者 `update-drainer` 来更新 Pump 或者 Drainer 的状态。Pump 和 Drainer 的状态可以为：online，pausing，paused，closing 以及 offline。例如：
 
     {{< copyable "shell-regular" >}}

dev/how-to/scale/with-ansible.md

@@ -117,7 +117,7 @@ TiDB 集群可以在不影响线上服务的情况下进行扩容和缩容。以
 
 例如，如果要添加一个 PD 节点（node103），IP 地址为 172.16.10.103，可以进行如下操作：
 
-1. 编辑 `inventory.ini` 文件，添加节点信息置于 `[pd_servers]` 主机组最后一行：  
+1. 编辑 `inventory.ini` 文件，添加节点信息置于 `[pd_servers]` 主机组最后一行：
 
     ```ini
     [tidb_servers]

dev/how-to/secure/generate-self-signed-certificates.md

@@ -54,7 +54,7 @@ cfssl print-defaults csr > ca-csr.json
 
 ### 配置 CA 选项
 
-根据实际需求修改 `ca-config.json`：  
+根据实际需求修改 `ca-config.json`：
 
 ```json
 {
@@ -85,7 +85,7 @@ cfssl print-defaults csr > ca-csr.json
 }
 ```
 
-根据实际需求修改 `ca-csr.json` ：  
+根据实际需求修改 `ca-csr.json` ：
 
 ```json
 {

dev/how-to/upgrade/from-previous-version.md

@@ -115,7 +115,7 @@ $ ansible-playbook local_prepare.yml
 >
 > 为优化 TiDB 集群组件的运维管理，TiDB 3.0 版本对 `systemd` 模式下的 `PD service` 名称进行了调整。与之前版本相比，滚动升级 TiDB 3.0 版本集群组件的操作略有不同，注意升级前后 `process_supervision` 参数配置须保持一致。
 
-如果 `process_supervision` 变量使用默认的 `systemd` 参数，则通过 `excessive_rolling_update.yml` 滚动升级 TiDB 集群。  
+如果 `process_supervision` 变量使用默认的 `systemd` 参数，则通过 `excessive_rolling_update.yml` 滚动升级 TiDB 集群。
 
 ```
 $ ansible-playbook excessive_rolling_update.yml

dev/reference/sql/language-structure/schema-object-names.md

@@ -60,7 +60,7 @@ CREATE TABLE t (i int);
 CREATE TABLE test.t (i int);
 ```
 
-对于 `.` 左右两端可以出现空格，`table_name.col_name` 等于 `table_name . col_name`。  
+对于 `.` 左右两端可以出现空格，`table_name.col_name` 等于 `table_name . col_name`。
 
 如果你要引用这个 identifier，那么请使用：
 

dev/reference/sql/statements/split-region.md

@@ -193,7 +193,7 @@ create table t (a int, b int,index idx1(a)) shard_row_id_bits = 4 pre_split_regi
 4 个 table Region 的范围区间如下：
 
 ```
-region1:   [ -inf      ,  1<<61 )  
+region1:   [ -inf      ,  1<<61 )
 region2:   [ 1<<61     ,  2<<61 )
 region3:   [ 2<<61     ,  3<<61 )
 region4:   [ 3<<61     ,  +inf  )

dev/reference/tispark.md

@@ -304,7 +304,7 @@ TiSpark 可以使用 TiDB 的统计信息：
 
 统计信息将在 Spark Driver 进行缓存，请确定 Driver 内存足够缓存统计信息。
 可以在`spark-defaults.conf`中开启或关闭统计信息读取：
-  
+
 | Property Name | Default | Description
 | --------   | -----:   | :----: |
 | spark.tispark.statistics.auto_load | true | 是否默认进行统计信息读取 |

dev/reference/tools/data-migration/cluster-operations.md

@@ -253,7 +253,7 @@ DM-master 重启时会自动向每个 DM-worker 实例请求任务信息，重
 
 1. 为中控机设置 SSH 互信以及 sudo 规则。
 
-    1. 参考[在中控机上配置 SSH 互信和 sudo 规则](/how-to/deploy/data-migration-with-ansible.md#第-5-步-在中控机上配置-ssh-互信和-sudo-规则)，使用 `tidb` 账户登录至中控机，并将 `172.16.10.80` 添加至 `hosts.ini` 文件中的 `[servers]` 部分。  
+    1. 参考[在中控机上配置 SSH 互信和 sudo 规则](/how-to/deploy/data-migration-with-ansible.md#第-5-步-在中控机上配置-ssh-互信和-sudo-规则)，使用 `tidb` 账户登录至中控机，并将 `172.16.10.80` 添加至 `hosts.ini` 文件中的 `[servers]` 部分。
 
         ```bash
         $ cd /home/tidb/dm-ansible

dev/reference/tools/data-migration/skip-replace-sqls.md

@@ -591,7 +591,7 @@ err:Error 1105: can't drop column c2 with index covered now
     args:"ALTER TABLE `shard_db`.`shard_table` DROP INDEX idx_c2;"
     args:"ALTER TABLE `shard_db`.`shard_table` DROP COLUMN `c2`"
     sqlPattern:"~(?i)ALTER\\s+TABLE\\s+`shard_db`.`shard_table`\\s+DROP\\s+COLUMN\\s+`c2`"
-    sharding:true  
+    sharding:true
     with key ~(?i)ALTER\s+TABLE\s+`shard_db`.`shard_table`\s+DROP\s+COLUMN\s+`c2` matched SQL
     USE `shard_db`; ALTER TABLE `shard_db`.`shard_table` DROP COLUMN `c2`;
     ```

dev/reference/tools/loader.md

@@ -33,7 +33,7 @@ Loader 包含在 tidb-enterprise-tools 安装包中，可[在此下载](/referen
 
 如果 mydumper 使用 -m 参数，会导出不带表结构的数据，这时 loader 无法导入数据。
 
-如果使用默认的 `checkpoint-schema` 参数，在导完一个 database 数据库后，请 `drop database tidb_loader` 后再开始导入下一个 database。  
+如果使用默认的 `checkpoint-schema` 参数，在导完一个 database 数据库后，请 `drop database tidb_loader` 后再开始导入下一个 database。
 
 推荐数据库开始导入的时候，明确指定 `checkpoint-schema = "tidb_loader"` 参数。
 
@@ -125,7 +125,7 @@ port = 4000
 ## FAQ
 
 ### 合库合表场景案例说明
-  
+
 根据配置文件的 route-rules 可以支持将分库分表的数据导入到同一个库同一个表中，但是在开始前需要检查分库分表规则：
 
 + 是否可以利用 route-rules 的语义规则表示

dev/reference/tools/mydumper.md

@@ -15,7 +15,7 @@ mydumper 包含在 tidb-enterprise-tools 安装包中，可[在此下载](/refer
 ## 相比于普通的 mydumper，此工具有哪些改进之处？
 
 + 使用 `tidb_snapshot` 而非 `FLUSH TABLES WITH READ LOCK` 提供备份一致性
-+ [允许设置](/how-to/get-started/read-historical-data.md#操作流程) `tidb_snapshot` 的值（即可备份不同时间点的数据）  
++ [允许设置](/how-to/get-started/read-historical-data.md#操作流程) `tidb_snapshot` 的值（即可备份不同时间点的数据）
 
 ### 新添参数
 

dev/reference/tools/sync-diff-inspector.md

@@ -171,7 +171,6 @@ schema = "test"
 # 需要检查的表的名称
 tables = ["test"]
 
-
 # 配置该表对应的分表的相关配置
 [[table-config]]
 # 目标库的名称

dev/reference/transactions/transaction-pessimistic.md

@@ -67,7 +67,7 @@ default = true
 
 - 其次是 session 变量 `tidb_txn_mode`。
 
-- 最后是配置文件里的 `default`，当使用普通的 `BEGIN` 语句，且 `tidb_txn_mode` 的值为空字符串 `''` 时，根据 `default` 来决定启用悲观事务还是乐观事务。  
+- 最后是配置文件里的 `default`，当使用普通的 `BEGIN` 语句，且 `tidb_txn_mode` 的值为空字符串 `''` 时，根据 `default` 来决定启用悲观事务还是乐观事务。
 
 ## 相关配置参数
 

dev/releases/2.0.10.md

@@ -23,7 +23,7 @@ category: Releases
 - 修复统计信息某些情况下对点查估算的问题 [#8493](https://github.com/pingcap/tidb/pull/8493)
 - 修复某些情况下返回 Enum 默认值为字符串导致的 panic [#8476](https://github.com/pingcap/tidb/pull/8476)
 - 修复在宽表场景下，占用太多内存的问题 [#8467](https://github.com/pingcap/tidb/pull/8467)
-- 修复 Parser 对取模操作错误格式化导致的问题 [#8431](https://github.com/pingcap/tidb/pull/8431)  
+- 修复 Parser 对取模操作错误格式化导致的问题 [#8431](https://github.com/pingcap/tidb/pull/8431)
 - 修复某些情况下添加外键约束导致的 panic 问题 [#8421](https://github.com/pingcap/tidb/pull/8421)，[#8410](https://github.com/pingcap/tidb/pull/8410)
 - 修复 `YEAR` 类型错误转换零值的问题 [#8396](https://github.com/pingcap/tidb/pull/8396)
 - 修复 `VALUES` 函数在参数不为列的时候 panic 的问题 [#8404](https://github.com/pingcap/tidb/pull/8404)

dev/releases/2.1.8.md

@@ -28,7 +28,7 @@ TiDB-Ansible 版本：2.1.8
 - 统一日志格式规范，利于工具收集分析 [日志规范](https://github.com/tikv/rfcs/blob/master/text/2018-12-19-unified-log-format.md)
 - 修复大量 NULL 值导致统计信息估算不准确的问题 [#9979](https://github.com/pingcap/tidb/pull/9979)
 - 修复 TIMESTAMP 类型默认值为边界值的时候报错的问题 [#9987](https://github.com/pingcap/tidb/pull/9987)
-- 检查设置 `time_zone` 值的合法性 [#10000](https://github.com/pingcap/tidb/pull/10000)  
+- 检查设置 `time_zone` 值的合法性 [#10000](https://github.com/pingcap/tidb/pull/10000)
 - 支持时间格式 `2019.01.01` [#10001](https://github.com/pingcap/tidb/pull/10001)
 - 修复某些情况下 `EXPLAIN` 结果中行数估计错误显示的问题 [#10044](https://github.com/pingcap/tidb/pull/10044)
 - 修复 `KILL TIDB [session id]` 某些情况下无法快速停止语句执行的问题 [#9976](https://github.com/pingcap/tidb/pull/9976)
@@ -45,7 +45,7 @@ TiDB-Ansible 版本：2.1.8
 ## TiKV
 
 - 修复读流量统计错误的问题 [#4441](https://github.com/tikv/tikv/pull/4441)
-- 修复 Region 数过多的情况下 raftstore 的性能问题 [#4484](https://github.com/tikv/tikv/pull/4484)  
+- 修复 Region 数过多的情况下 raftstore 的性能问题 [#4484](https://github.com/tikv/tikv/pull/4484)
 - 调整当 level 0 SST 数量超过 `level_zero_slowdown_writes_trigger/2` 时不再继续 ingest file [#4464](https://github.com/tikv/tikv/pull/4464)
 
 ## Tools

dev/releases/2.1ga.md

@@ -46,7 +46,7 @@ category: Releases
 
     + 支持内建函数：
 
-        - `json_contains`  
+        - `json_contains`
         - `json_contains_path`
         - `encode/decode`
 

dev/releases/3.0.0-beta.1.md

@@ -73,7 +73,7 @@ TiDB-Ansible 版本：3.0.0-beta.1
 + 增加 store 地址为维度的监控项，代替原有的 Store ID [#1429](https://github.com/pingcap/pd/pull/1429)
 + 优化 `GetStores` 开销，加快 Region 巡检周期 [#1410](https://github.com/pingcap/pd/pull/1410)
 + 新增删除 Tombstone Store 的接口 [#1472](https://github.com/pingcap/pd/pull/1472)
-  
+
 ## TiKV
 
 + 优化 Coprocessor 计算执行框架，完成 TableScan 算子，单 TableScan 即扫表操作性能提升 5% ~ 30%

dev/releases/3.0.0-rc.2.md

@@ -66,7 +66,7 @@ TiDB Ansible 版本：3.0.0-rc.2
 - 主动下发 operator 加快调度速度 [#1536](https://github.com/pingcap/pd/pull/1536)
 - 添加 store limit 机制，限制单个 store 的调度速度 [#1474](https://github.com/pingcap/pd/pull/1474)
 - 修复 `config` 状态不一致的问题 [#1476](https://github.com/pingcap/pd/pull/1476)
-  
+
 ## TiKV
 
 + Engine