*: adjust tool order in toc and learning path (#13698)

pingcap · Apr 17, 2023 · a4c504b · a4c504b
1 parent 82f5106
commit a4c504b
Show file tree

Hide file tree

Showing 3 changed files with 101 additions and 103 deletions.
diff --git a/TOC.md b/TOC.md
@@ -383,51 +383,7 @@
       - [tiup-cluster 部署运维生产集群](/tiup/tiup-cluster.md)
       - [tiup-mirror 定制离线镜像](/tiup/tiup-mirror.md)
       - [tiup-bench 进行 TPCC/TPCH 压力测试](/tiup/tiup-bench.md)
-  - PingCAP Clinic 诊断服务
-    - [概述](/clinic/clinic-introduction.md)
-    - [快速上手](/clinic/quick-start-with-clinic.md)
-    - [使用 PingCAP Clinic 诊断集群](/clinic/clinic-user-guide-for-tiup.md)
-    - [使用 PingCAP Clinic 生成诊断报告](/clinic/clinic-report.md)
-    - [采集 SQL 查询计划信息](/clinic/clinic-collect-sql-query-plan.md)
-    - [数据采集说明](/clinic/clinic-data-instruction-for-tiup.md)
   - [TiDB Operator](/tidb-operator-overview.md)
-  - [Dumpling](/dumpling-overview.md)
-  - TiDB Lightning
-    - [概述](/tidb-lightning/tidb-lightning-overview.md)
-    - [快速上手](/get-started-with-tidb-lightning.md)
-    - [部署 TiDB Lightning](/tidb-lightning/deploy-tidb-lightning.md)
-    - [目标数据库要求](/tidb-lightning/tidb-lightning-requirements.md)
-    - 数据源
-      - [文件匹配规则](/tidb-lightning/tidb-lightning-data-source.md)
-      - [CSV](/tidb-lightning/tidb-lightning-data-source.md#csv)
-      - [SQL](/tidb-lightning/tidb-lightning-data-source.md#sql)
-      - [Parquet](/tidb-lightning/tidb-lightning-data-source.md#parquet)
-      - [自定义文件匹配](/tidb-lightning/tidb-lightning-data-source.md#自定义文件匹配)
-    - Physical Import Mode
-      - [概述](/tidb-lightning/tidb-lightning-physical-import-mode.md)
-      - [必要条件及限制](/tidb-lightning/tidb-lightning-physical-import-mode.md#必要条件及限制)
-      - [配置及使用](/tidb-lightning/tidb-lightning-physical-import-mode-usage.md)
-      - [冲突检测](/tidb-lightning/tidb-lightning-physical-import-mode-usage.md#冲突数据检测)
-      - [性能调优](/tidb-lightning/tidb-lightning-physical-import-mode-usage.md#性能调优)
-    - Logical Import Mode
-      - [概述](/tidb-lightning/tidb-lightning-logical-import-mode.md)
-      - [必要条件及限制](/tidb-lightning/tidb-lightning-logical-import-mode.md#必要条件)
-      - [配置及使用](/tidb-lightning/tidb-lightning-logical-import-mode-usage.md)
-      - [冲突检测](/tidb-lightning/tidb-lightning-logical-import-mode-usage.md#冲突数据检测)
-      - [性能调优](/tidb-lightning/tidb-lightning-logical-import-mode-usage.md#性能调优)
-    - [前置检查](/tidb-lightning/tidb-lightning-prechecks.md)
-    - [表库过滤](/table-filter.md)
-    - [断点续传](/tidb-lightning/tidb-lightning-checkpoints.md)
-    - [并行导入](/tidb-lightning/tidb-lightning-distributed-import.md)
-    - [可容忍错误](/tidb-lightning/tidb-lightning-error-resolution.md)
-    - [故障处理](/tidb-lightning/troubleshoot-tidb-lightning.md)
-    - 参考手册
-      - [完整配置文件](/tidb-lightning/tidb-lightning-configuration.md)
-      - [命令行参数](/tidb-lightning/tidb-lightning-command-line-full.md)
-      - [监控告警](/tidb-lightning/monitor-tidb-lightning.md)
-      - [Web 界面](/tidb-lightning/tidb-lightning-web-interface.md)
-      - [FAQ](/tidb-lightning/tidb-lightning-faq.md)
-      - [术语表](/tidb-lightning/tidb-lightning-glossary.md)
   - TiDB Data Migration
     - [关于 Data Migration](/dm/dm-overview.md)
     - [架构简介](/dm/dm-arch.md)
@@ -486,33 +442,33 @@
       - [导出和导入集群的数据源和任务配置](/dm/dm-export-import-config.md)
       - [处理告警](/dm/dm-handle-alerts.md)
       - [日常巡检](/dm/dm-daily-check.md)
-     - 参考手册
-        - 架构组件
-          - [DM-worker 说明](/dm/dm-worker-intro.md)
-          - [安全模式](/dm/dm-safe-mode.md)
-          - [Relay Log](/dm/relay-log.md)
-          - [DDL 特殊处理说明](/dm/dm-ddl-compatible.md)
-        - 运行机制
-          - [DML 同步机制](/dm/dm-dml-replication-logic.md)
-        - 命令行
-          - [DM-master & DM-worker](/dm/dm-command-line-flags.md)
-        - 配置文件
-          - [概述](/dm/dm-config-overview.md)
-          - [数据源配置](/dm/dm-source-configuration-file.md)
-          - [迁移任务配置](/dm/task-configuration-file-full.md)
-          - [DM-master 配置](/dm/dm-master-configuration-file.md)
-          - [DM-worker 配置](/dm/dm-worker-configuration-file.md)
-          - [Table Selector](/dm/table-selector.md)
-        - [OpenAPI](/dm/dm-open-api.md)
-        - [兼容性目录](/dm/dm-compatibility-catalog.md)
-        - 安全
-          - [为 DM 的连接开启加密传输](/dm/dm-enable-tls.md)
-          - [生成自签名证书](/dm/dm-generate-self-signed-certificates.md)
-        - 监控告警
-          - [监控指标](/dm/monitor-a-dm-cluster.md)
-          - [告警信息](/dm/dm-alert-rules.md)
-        - [错误码](/dm/dm-error-handling.md#常见故障处理方法)
-        - [术语表](/dm/dm-glossary.md)
+    - 参考手册
+      - 架构组件
+        - [DM-worker 说明](/dm/dm-worker-intro.md)
+        - [安全模式](/dm/dm-safe-mode.md)
+        - [Relay Log](/dm/relay-log.md)
+        - [DDL 特殊处理说明](/dm/dm-ddl-compatible.md)
+      - 运行机制
+        - [DML 同步机制](/dm/dm-dml-replication-logic.md)
+      - 命令行
+        - [DM-master & DM-worker](/dm/dm-command-line-flags.md)
+      - 配置文件
+        - [概述](/dm/dm-config-overview.md)
+        - [数据源配置](/dm/dm-source-configuration-file.md)
+        - [迁移任务配置](/dm/task-configuration-file-full.md)
+        - [DM-master 配置](/dm/dm-master-configuration-file.md)
+        - [DM-worker 配置](/dm/dm-worker-configuration-file.md)
+        - [Table Selector](/dm/table-selector.md)
+      - [OpenAPI](/dm/dm-open-api.md)
+      - [兼容性目录](/dm/dm-compatibility-catalog.md)
+      - 安全
+        - [为 DM 的连接开启加密传输](/dm/dm-enable-tls.md)
+        - [生成自签名证书](/dm/dm-generate-self-signed-certificates.md)
+      - 监控告警
+        - [监控指标](/dm/monitor-a-dm-cluster.md)
+        - [告警信息](/dm/dm-alert-rules.md)
+      - [错误码](/dm/dm-error-handling.md#常见故障处理方法)
+      - [术语表](/dm/dm-glossary.md)
       - 使用示例
         - [使用 DM 迁移数据](/dm/migrate-data-using-dm.md)
         - [快速创建迁移任务](/dm/quick-start-create-task.md)
@@ -521,6 +477,43 @@
         - [常见问题](/dm/dm-faq.md)
         - [错误处理及恢复](/dm/dm-error-handling.md)
       - [版本发布历史](/dm/dm-release-notes.md)
+  - TiDB Lightning
+    - [概述](/tidb-lightning/tidb-lightning-overview.md)
+    - [快速上手](/get-started-with-tidb-lightning.md)
+    - [部署 TiDB Lightning](/tidb-lightning/deploy-tidb-lightning.md)
+    - [目标数据库要求](/tidb-lightning/tidb-lightning-requirements.md)
+    - 数据源
+      - [文件匹配规则](/tidb-lightning/tidb-lightning-data-source.md)
+      - [CSV](/tidb-lightning/tidb-lightning-data-source.md#csv)
+      - [SQL](/tidb-lightning/tidb-lightning-data-source.md#sql)
+      - [Parquet](/tidb-lightning/tidb-lightning-data-source.md#parquet)
+      - [自定义文件匹配](/tidb-lightning/tidb-lightning-data-source.md#自定义文件匹配)
+    - Physical Import Mode
+      - [概述](/tidb-lightning/tidb-lightning-physical-import-mode.md)
+      - [必要条件及限制](/tidb-lightning/tidb-lightning-physical-import-mode.md#必要条件及限制)
+      - [配置及使用](/tidb-lightning/tidb-lightning-physical-import-mode-usage.md)
+      - [冲突检测](/tidb-lightning/tidb-lightning-physical-import-mode-usage.md#冲突数据检测)
+      - [性能调优](/tidb-lightning/tidb-lightning-physical-import-mode-usage.md#性能调优)
+    - Logical Import Mode
+      - [概述](/tidb-lightning/tidb-lightning-logical-import-mode.md)
+      - [必要条件及限制](/tidb-lightning/tidb-lightning-logical-import-mode.md#必要条件)
+      - [配置及使用](/tidb-lightning/tidb-lightning-logical-import-mode-usage.md)
+      - [冲突检测](/tidb-lightning/tidb-lightning-logical-import-mode-usage.md#冲突数据检测)
+      - [性能调优](/tidb-lightning/tidb-lightning-logical-import-mode-usage.md#性能调优)
+    - [前置检查](/tidb-lightning/tidb-lightning-prechecks.md)
+    - [表库过滤](/table-filter.md)
+    - [断点续传](/tidb-lightning/tidb-lightning-checkpoints.md)
+    - [并行导入](/tidb-lightning/tidb-lightning-distributed-import.md)
+    - [可容忍错误](/tidb-lightning/tidb-lightning-error-resolution.md)
+    - [故障处理](/tidb-lightning/troubleshoot-tidb-lightning.md)
+    - 参考手册
+      - [完整配置文件](/tidb-lightning/tidb-lightning-configuration.md)
+      - [命令行参数](/tidb-lightning/tidb-lightning-command-line-full.md)
+      - [监控告警](/tidb-lightning/monitor-tidb-lightning.md)
+      - [Web 界面](/tidb-lightning/tidb-lightning-web-interface.md)
+      - [FAQ](/tidb-lightning/tidb-lightning-faq.md)
+      - [术语表](/tidb-lightning/tidb-lightning-glossary.md)
+  - [Dumpling](/dumpling-overview.md)
   - TiCDC
     - [概述](/ticdc/ticdc-overview.md)
     - [安装部署与集群运维](/ticdc/deploy-ticdc.md)
@@ -573,6 +566,21 @@
       - [故障诊断](/tidb-binlog/troubleshoot-tidb-binlog.md)
       - [常见错误修复](/tidb-binlog/handle-tidb-binlog-errors.md)
     - [FAQ](/tidb-binlog/tidb-binlog-faq.md)
+  - PingCAP Clinic 诊断服务
+    - [概述](/clinic/clinic-introduction.md)
+    - [快速上手](/clinic/quick-start-with-clinic.md)
+    - [使用 PingCAP Clinic 诊断集群](/clinic/clinic-user-guide-for-tiup.md)
+    - [使用 PingCAP Clinic 生成诊断报告](/clinic/clinic-report.md)
+    - [采集 SQL 查询计划信息](/clinic/clinic-collect-sql-query-plan.md)
+    - [数据采集说明](/clinic/clinic-data-instruction-for-tiup.md)
+  - TiSpark
+    - [TiSpark 用户指南](/tispark-overview.md)
+  - sync-diff-inspector
+    - [概述](/sync-diff-inspector/sync-diff-inspector-overview.md)
+    - [不同库名或表名的数据校验](/sync-diff-inspector/route-diff.md)
+    - [分库分表场景下的数据校验](/sync-diff-inspector/shard-diff.md)
+    - [TiDB 主从集群的数据校验](/sync-diff-inspector/upstream-downstream-diff.md)
+    - [基于 DM 同步场景下的数据校验](/sync-diff-inspector/dm-diff.md)
   - TiUniManager
     - [概述](/tiunimanager/tiunimanager-overview.md)
     - [安装和运维](/tiunimanager/tiunimanager-install-and-maintain.md)
@@ -590,14 +598,6 @@
       - [v1.0.2](/tiunimanager/tiunimanager-release-1.0.2.md)
       - [v1.0.1](/tiunimanager/tiunimanager-release-1.0.1.md)
       - [v1.0.0](/tiunimanager/tiunimanager-release-1.0.0.md)
-  - sync-diff-inspector
-    - [概述](/sync-diff-inspector/sync-diff-inspector-overview.md)
-    - [不同库名或表名的数据校验](/sync-diff-inspector/route-diff.md)
-    - [分库分表场景下的数据校验](/sync-diff-inspector/shard-diff.md)
-    - [TiDB 主从集群的数据校验](/sync-diff-inspector/upstream-downstream-diff.md)
-    - [基于 DM 同步场景下的数据校验](/sync-diff-inspector/dm-diff.md)
-  - TiSpark
-    - [TiSpark 用户指南](/tispark-overview.md)
 - 参考指南
   - 架构
     - [概述](/tidb-architecture.md)

diff --git a/_index.md b/_index.md
@@ -101,24 +101,22 @@ hide_commit: true
 
 [TiUP](https://docs.pingcap.com/zh/tidb/dev/tiup-overview)
 
-[Dumpling](https://docs.pingcap.com/zh/tidb/dev/dumpling-overview)
+[TiDB Operator](https://docs.pingcap.com/zh/tidb/dev/tidb-operator-overview)
 
-[TiDB Lightning](https://docs.pingcap.com/zh/tidb/dev/tidb-lightning-overview)
+[TiDB Data Migration (DM)](https://docs.pingcap.com/zh/tidb/dev/dm-overview)
 
-[Data Migration](https://docs.pingcap.com/zh/tidb/dev/dm-overview)
+[TiDB Lightning](https://docs.pingcap.com/zh/tidb/dev/tidb-lightning-overview)
 
-[Backup & Restore (BR)](https://docs.pingcap.com/zh/tidb/dev/backup-and-restore-overview)
+[Dumpling](https://docs.pingcap.com/zh/tidb/dev/dumpling-overview)
 
 [TiCDC](https://docs.pingcap.com/zh/tidb/dev/ticdc-overview)
 
+[Backup & Restore (BR)](https://docs.pingcap.com/zh/tidb/dev/backup-and-restore-overview)
+
 [PingCAP Clinic](https://docs.pingcap.com/zh/tidb/dev/clinic-introduction)
 
 [TiUniManager](https://docs.pingcap.com/zh/tidb/dev/tiunimanager-overview)
 
-[TiDB Operator](https://docs.pingcap.com/zh/tidb/dev/tidb-operator-overview)
-
-[TiSpark](https://docs.pingcap.com/zh/tidb/dev/tispark-overview)
-
 </LearningPath>
 
 <LearningPath label="参考" icon="cloud-dev">
@@ -127,7 +125,7 @@ hide_commit: true
 
 [TiDB 命令行参数](https://docs.pingcap.com/zh/tidb/dev/command-line-flags-for-tidb-configuration)
 
-[TiDB Control](https://docs.pingcap.com/zh/tidb/dev/tidb-control)  
+[TiDB Control](https://docs.pingcap.com/zh/tidb/dev/tidb-control)
 
 [系统变量](https://docs.pingcap.com/zh/tidb/dev/system-variables)
 

diff --git a/migration-tools.md b/migration-tools.md
@@ -18,15 +18,6 @@ TiDB 提供了丰富的数据迁移相关的工具，用于全量迁移、增量
 | **主要优势** | <ul><li>一体化的数据迁移任务管理工具，支持全量迁移和增量同步</li><li>支持对表与操作进行过滤</li><li>支持分库分表的合并迁移</li></ul>|
 | **使用限制** | 数据导入速度与 TiDB Lightning 的 [Logical Import Mode](/tidb-lightning/tidb-lightning-logical-import-mode.md) 大致相同，而比TiDB Lightning 的 [Physical Import Mode](/tidb-lightning/tidb-lightning-physical-import-mode.md) 低很多。建议用于 1 TB 以内的存量数据迁移。 |
 
-## [Dumpling](/dumpling-overview.md)
-
-| 使用场景 | <span style="font-weight:normal">用于将数据从 MySQL/TiDB 进行全量导出</span> |
-|---|---|
-| **上游** | MySQL，TiDB |
-| **下游（输出文件）** | SQL，CSV |
-| **主要优势** | <ul><li>支持全新的 table-filter，筛选数据更加方便</li><li>支持导出到 Amazon S3 云盘</li></ul> |
-| **使用限制** | <ul><li>如果导出后计划往非 TiDB 的数据库恢复，建议使用 Dumpling。</li><li>如果导出后计划往另一个 TiDB 恢复，建议使用 [BR](/br/backup-and-restore-overview.md)。 </li></ul> |
-
 ## [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md)
 
 | 使用场景 | <span style="font-weight:normal">用于将数据全量导入到 TiDB</span> |
@@ -36,14 +27,14 @@ TiDB 提供了丰富的数据迁移相关的工具，用于全量迁移、增量
 | **主要优势** | <ul><li>支持快速导入大量数据，实现快速初始化 TiDB 集群的指定表</li><li>支持断点续传</li><li>支持数据过滤</li></ul> |
 | **使用限制** | <ul><li>如果使用 [Physical Import Mode](/tidb-lightning/tidb-lightning-physical-import-mode.md) 进行数据导入，TiDB Lightning 运行后，TiDB 集群将无法正常对外提供服务。</li><li>如果你不希望 TiDB 集群的对外服务受到影响，可以参考 TiDB Lightning [Logical Import Mode](/tidb-lightning/tidb-lightning-logical-import-mode.md) 中的硬件需求与部署方式进行数据导入。</li></ul> |
 
-## [Backup & Restore (BR)](/br/backup-and-restore-overview.md)
+## [Dumpling](/dumpling-overview.md)
 
-| 使用场景 | <span style="font-weight:normal">通过对大数据量的 TiDB 集群进行数据备份和恢复，实现数据迁移</span> |
+| 使用场景 | <span style="font-weight:normal">用于将数据从 MySQL/TiDB 进行全量导出</span> |
 |---|---|
-| **上游** | TiDB |
-| **下游（输出文件）** | SST，backup.meta 文件，backup.lock 文件 |
-| **主要优势** | <ul><li>适用于向另一个 TiDB 迁移数据。</li><li>支持数据冷备份到外部存储，可以用于灾备恢复。</li></ul> |
-| **使用限制** | <ul><li>BR 恢复到 TiCDC / Drainer 的上游集群时，恢复数据无法由 TiCDC / Drainer 同步到下游。</li><li>BR 只支持在 `new_collations_enabled_on_first_bootstrap` 开关值相同的集群之间进行操作。</li></ul> |
+| **上游** | MySQL，TiDB |
+| **下游（输出文件）** | SQL，CSV |
+| **主要优势** | <ul><li>支持全新的 table-filter，筛选数据更加方便</li><li>支持导出到 Amazon S3 云盘</li></ul> |
+| **使用限制** | <ul><li>如果导出后计划往非 TiDB 的数据库恢复，建议使用 Dumpling。</li><li>如果导出后计划往另一个 TiDB 恢复，建议使用 [BR](/br/backup-and-restore-overview.md)。 </li></ul> |
 
 ## [TiCDC](/ticdc/ticdc-overview.md)
 
@@ -63,6 +54,15 @@ TiDB 提供了丰富的数据迁移相关的工具，用于全量迁移、增量
 | **主要优势** | <ul><li>支持实时备份和恢复。</li><li>备份 TiDB 集群数据，同时可以用于 TiDB 集群故障时恢复。</li></ul> |
 | **使用限制** | 与部分 TiDB 版本不兼容。推荐使用 [TiCDC](/ticdc/ticdc-overview.md) 替代 TiDB Binlog。|
 
+## [Backup & Restore (BR)](/br/backup-and-restore-overview.md)
+
+| 使用场景 | <span style="font-weight:normal">通过对大数据量的 TiDB 集群进行数据备份和恢复，实现数据迁移</span> |
+|---|---|
+| **上游** | TiDB |
+| **下游（输出文件）** | SST，backup.meta 文件，backup.lock 文件 |
+| **主要优势** | <ul><li>适用于向另一个 TiDB 迁移数据。</li><li>支持数据冷备份到外部存储，可以用于灾备恢复。</li></ul> |
+| **使用限制** | <ul><li>BR 恢复到 TiCDC / Drainer 的上游集群时，恢复数据无法由 TiCDC / Drainer 同步到下游。</li><li>BR 只支持在 `new_collations_enabled_on_first_bootstrap` 开关值相同的集群之间进行操作。</li></ul> |
+
 ## [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md)
 
 | 使用场景 | <span style="font-weight:normal">用于校验 MySQL/TiDB 中两份数据的一致性</span> |