dev: fix format and wording issues in Roadmap (#1816)

* releases: add 2.1.16 release notes * Revert "releases: add 2.1.16 release notes" This reverts commit 6a5d938. * dev: fix typos, format and wording in Roadmap * Revert "dev: fix typos, format and wording in Roadmap" This reverts commit 8ad68f5. * dev: fix format and wording issues in Roadmap * update header level and content
pingcap · Sep 4, 2019 · c83728b · c83728b
1 parent 8f10f14
commit c83728b
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 33 deletions.
diff --git a/dev/roadmap.md b/dev/roadmap.md
@@ -1,5 +1,5 @@
 ---
-title: TiDB Roadmap
+title: TiDB V4.0 Roadmap
 category: Roadmap
 aliases: ['/docs-cn/ROADMAP/','/docs-cn/roadmap/']
 ---
@@ -10,29 +10,29 @@ aliases: ['/docs-cn/ROADMAP/','/docs-cn/roadmap/']
 
 ## TiDB
 
-### TiDB
+### TiDB Server
 
 #### 功能
 
 * 支持 TiFlash 存储引擎
-* Optimizer Trace
+* 支持 Optimizer Trace
 * 支持多列统计信息
 * 为普通 CM-Sketch 支持 TopN 统计信息
 * 完善 Plan Cache 功能
-* 自适应 SQL 引擎
-* SQL Tuning Advisor
-* SQL Plan Management
+* 支持自适应 SQL 引擎
+* 支持 SQL Tuning Advisor
+* 支持 SQL Plan Management
 * 事务
     + 悲观锁 GA
     + 事务内不限制语句数量
-    + 支持 10GB 事务
+    + 支持 10 GB 事务
 
 #### 性能
 
 * 提升 load CSV/data 性能
 * 提升 Prepare 语句性能
 * Generated Column 支持 Index
-* 优化 SQL 引擎部份算子
+* 优化 SQL 引擎部分算子
     + 提升通过索引回表查询的性能
     + Index Join 拆分为 Index Merge Join 和 Index Hash Join
     + Radix Hash Join
@@ -43,7 +43,7 @@ aliases: ['/docs-cn/ROADMAP/','/docs-cn/roadmap/']
     + Full Vectorized Expression Evaluation
 * Indexes on Expressions
 * Multi-Index Scan
-* Join，Aggregate，Sort 算子支持外部存储
+* Join、Aggregate 和 Sort 算子支持外部存储
 * 优化执行引擎并发模型
 * 支持新 Cascades 优化器，支持 Cascades Planner，扩大优化器的搜索空间
 
@@ -55,24 +55,24 @@ aliases: ['/docs-cn/ROADMAP/','/docs-cn/roadmap/']
 * 空闲连接自动断开
 * 完善支持 MySQL 5.7 DDL 语句
 * 重构日志内容
-* 支持 admin checksum from … to … 校验数据完整性
-* 标准 SQL 查询 DDL 历史记录
-* 标准 SQL 管理 Binlog
-* 标准 SQL 管理集群
+* 支持使用 `admin checksum from … to …` 校验数据完整性
+* 支持使用标准 SQL 查询 DDL 历史记录
+* 支持使用标准 SQL 管理 Binlog
+* 支持使用标准 SQL 管理集群
 * 多个 Ctrl 工具合并一个工具
 
 #### 高可用
 
 * Binlog 支持服务高可用
 * Binlog 支持数据高可靠
 
-### TiKV
+### TiKV Server
 
 #### 功能
 
-* 集群规模最大支持 200+节点
+* 集群规模最大支持 200+ 节点
 * 全量快速备份恢复
-* 动态 Split，Merge 热点 Region
+* 动态 Split 和 Merge 热点 Region
 * 精细的内存控制
 * Raft
     + Joint consensus
@@ -133,21 +133,19 @@ aliases: ['/docs-cn/ROADMAP/','/docs-cn/roadmap/']
 
 * TiDB Lightning 支持多 lightning + importer 实例并行导入
 
-# TiDB 未来规划
+## TiDB 未来规划
 
-## TiDB
-
-### TiDB
+### TiDB Server
 
 #### 功能
 
 * Common Table Expression
 * Invisible Index
 * 支持修改列类型
 * 分区表支持二级分区
-* Table Partition 与 普通表相互转换
+* 分区表与普通表相互转换
 * 视图支持写入及更新
-* Mutil-Schema Change
+* Multi-Schema Change
 * 按 Table 配置副本数及分布策略
 * 精细的 QoS 控制
 * 闪回到任意时间点
@@ -167,20 +165,20 @@ aliases: ['/docs-cn/ROADMAP/','/docs-cn/roadmap/']
 
 * 列级别权限
 
-### TiKV
+### TiKV Server
 
 #### 功能
 
 * 增量快速备份恢复
 * 闪回到任意时间点
 * 分级存储
 * 精细的 QoS 控制
-* 按 Region 配置副本数及分布策
+* 按 Region 配置副本数及分布策略
 * Raft
     + 链式复制数据
     + Witness Role
 * 存储引擎
-    + RocksDB Gaurd，compaction 按特定逻辑切分 SST
+    + 支持 RocksDB 在 compaction 时按照 Guard 信息切分 SSTable
     + 冷热数据分离
 
 #### 性能

diff --git a/...reference/tools/data-migration/features/manually-handling-sharding-ddl-locks.md b/...reference/tools/data-migration/features/manually-handling-sharding-ddl-locks.md
@@ -228,7 +228,7 @@ MySQL 及 DM 操作与处理流程如下：
     ```
 
 4. 由于业务需要，DM-worker-2 对应的 MySQL-2 的数据不再需要同步到下游 TiDB，对 DM-worker-2 执行了下线处理。
-5. DM-master 上 ID 为 ``` test-`shard_db`.`shard_table` ``` 的 lock 无法等到 DM-worker-2 的 DDL 操作信息。
+5. DM-master 上 ID 为 ```test-`shard_db`.`shard_table` ``` 的 lock 无法等到 DM-worker-2 的 DDL 操作信息。
 
     `show-ddl-locks` 返回的 `unsynced` 中一直包含 DM-worker-2 的信息（`127.0.0.1:8263`）。
 

diff --git a/v3.0/how-to/get-started/explore-sql.md b/v3.0/how-to/get-started/explore-sql.md
@@ -151,6 +151,7 @@ SELECT * FROM person;
 |      1 | tom  | 2017-09-12 |
 +--------+------+------------+
 ```
+
 使用 `UPDATE` 语句修改表内数据。例如：
 
 ```sql

diff --git a/v3.0/how-to/secure/enable-tls-between-components.md b/v3.0/how-to/secure/enable-tls-between-components.md
@@ -23,7 +23,7 @@ MySQL Client 与 TiDB 之间使用一套证书，TiDB 集群组件之间使用
 
     推荐为 TiDB、TiKV、PD 分别准备一个 server 证书，并保证可以相互验证，而它们的各种客户端共用 client 证书。
 
-    有多种工具可以生成自签名证书，如 `openssl`，`easy-rsa `，`cfssl`。
+    有多种工具可以生成自签名证书，如 `openssl`，`easy-rsa`，`cfssl`。
 
     这里提供一个使用 `cfssl` 生成证书的示例：[生成自签名证书](/how-to/secure/generate-self-signed-certificates.md)。
 
@@ -75,11 +75,11 @@ MySQL Client 与 TiDB 之间使用一套证书，TiDB 集群组件之间使用
 >
 > 若 TiDB 集群各个组件间已开启 TLS，在使用 tikv-ctl 或 pd-ctl 工具连接集群时，需要指定 client 证书，示例：
 
-    ```bash
-    ./pd-ctl -u https://127.0.0.1:2379 --cacert /path/to/ca.pem --cert /path/to/client.pem --key /path/to/client-key.pem
+```bash
+./pd-ctl -u https://127.0.0.1:2379 --cacert /path/to/ca.pem --cert /path/to/client.pem --key /path/to/client-key.pem
 
-    ./tikv-ctl --host="127.0.0.1:20160" --ca-path="/path/to/ca.pem" --cert-path="/path/to/client.pem" --key-path="/path/to/clinet-key.pem"
-    ```
+./tikv-ctl --host="127.0.0.1:20160" --ca-path="/path/to/ca.pem" --cert-path="/path/to/client.pem" --key-path="/path/to/clinet-key.pem"
+```
 
 ### MySQL 与 TiDB 间开启 TLS
 

diff --git a/v3.0/reference/sql/statements/set-variable.md b/v3.0/reference/sql/statements/set-variable.md
@@ -6,7 +6,7 @@ category: reference
 
 # SET [GLOBAL|SESSION] <variable>
 
-`SET [GLOBAL|SESSION]` 语句用于在 `SESSION` 或 ` GLOBAL` 的范围内，对某个 TiDB 的内置变量进行更改。需注意，对 `GLOBAL` 变量的更改不适用于已有连接或本地连接，这与 MySQL 类似。只有新会话才会反映值的变化。
+`SET [GLOBAL|SESSION]` 语句用于在 `SESSION` 或 `GLOBAL` 的范围内，对某个 TiDB 的内置变量进行更改。需注意，对 `GLOBAL` 变量的更改不适用于已有连接或本地连接，这与 MySQL 类似。只有新会话才会反映值的变化。
 
 ## 语法图
 

diff --git a/v3.0/reference/sql/statements/trace.md b/v3.0/reference/sql/statements/trace.md
@@ -9,6 +9,7 @@ category: reference
 `TRACE` 语句用于提供查询执行的详细信息，可通过 TiDB 服务器状态端口所公开的图形界面进行查看。
 
 ## 语法图
+
 **TraceStmt:**
 
 ![TraceStmt](/media/sqlgram/TraceStmt.png)

diff --git a/v3.0/roadmap.md b/v3.0/roadmap.md
@@ -1,7 +1,6 @@
 ---
 title: TiDB 路线图
 category: Roadmap
-aliases: ['/docs-cn/ROADMAP/','/docs-cn/roadmap/']
 ---
 
 # TiDB 路线图