tiup: align rest files in docs-cn#4868 (pingcap#5331) (pingcap#5373)

ti-srebot · Apr 16, 2021 · 785757c · 785757c
1 parent 461ac77
commit 785757c
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 14 deletions.
diff --git a/TOC.md b/TOC.md
@@ -509,12 +509,15 @@
       + [Overview](/tiflash/tiflash-overview.md)
       + [Use TiFlash](/tiflash/use-tiflash.md)
   + TiUP
-    + [Documentation Guide](/tiup/tiup-documentation-guide.md)
+    + [Documentation Map](/tiup/tiup-documentation-guide.md)
     + [Overview](/tiup/tiup-overview.md)
     + [Terminology and Concepts](/tiup/tiup-terminology-and-concepts.md)
     + [Manage TiUP Components](/tiup/tiup-component-management.md)
     + [FAQ](/tiup/tiup-faq.md)
     + [Troubleshooting Guide](/tiup/tiup-troubleshooting-guide.md)
+    + [Reference Guide](/tiup/tiup-reference.md)
+    + [Cluster Topology Reference](/tiup/tiup-cluster-topology-reference.md)
+    + [Mirror Reference Guide](/tiup/tiup-mirror-reference.md)
     + TiUP Components
       + [tiup-playground](/tiup/tiup-playground.md)
       + [tiup-cluster](/tiup/tiup-cluster.md)

diff --git a/geo-distributed-deployment-topology.md b/geo-distributed-deployment-topology.md
@@ -21,6 +21,8 @@ This document takes the typical architecture of three data centers (DC) in two c
 
 - [The geo-distributed topology template](https://github.com/pingcap/docs/blob/release-4.0/config-templates/geo-redundancy-deployment.yaml)
 
+For detailed descriptions of the configuration items in the above TiDB cluster topology file, see [Topology Configuration File for Deploying TiDB Using TiUP](/tiup/tiup-cluster-topology-reference.md).
+
 ### Key parameters
 
 This section describes the key parameter configuration of the TiDB geo-distributed deployment.

diff --git a/hybrid-deployment-topology.md b/hybrid-deployment-topology.md
@@ -26,6 +26,8 @@ The deployment machine has multiple CPU processors with sufficient memory. To im
 - [The simple template for the hybrid deployment](https://github.com/pingcap/docs/blob/release-4.0/config-templates/simple-multi-instance.yaml)
 - [The complex template for the hybrid deployment](https://github.com/pingcap/docs/blob/release-4.0/config-templates/complex-multi-instance.yaml)
 
+For detailed descriptions of the configuration items in the above TiDB cluster topology file, see [Topology Configuration File for Deploying TiDB Using TiUP](/tiup/tiup-cluster-topology-reference.md).
+
 ### Key parameters
 
 This section introduces the key parameters when you deploy multiple instances on a single machine, which is mainly used in scenarios when multiple instances of TiDB and TiKV are deployed on a single machine. You need to fill in the results into the configuration template according to the calculation methods provided below.

diff --git a/minimal-deployment-topology.md b/minimal-deployment-topology.md
@@ -22,6 +22,8 @@ This document describes the minimal deployment topology of TiDB clusters.
 - [The simple template for the minimal topology](https://github.com/pingcap/docs/blob/release-4.0/config-templates/simple-mini.yaml)
 - [The complex template for the minimal topology](https://github.com/pingcap/docs/blob/release-4.0/config-templates/complex-mini.yaml)
 
+For detailed descriptions of the configuration items in the above TiDB cluster topology file, see [Topology Configuration File for Deploying TiDB Using TiUP](/tiup/tiup-cluster-topology-reference.md).
+
 > **Note:**
 >
 > - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.

diff --git a/ticdc-deployment-topology.md b/ticdc-deployment-topology.md
@@ -29,6 +29,8 @@ TiCDC is a tool for replicating the incremental data of TiDB, introduced in TiDB
 - [The simple template for the TiCDC topology](https://github.com/pingcap/docs/blob/release-4.0/config-templates/simple-cdc.yaml)
 - [The complex template for the TiCDC topology](https://github.com/pingcap/docs/blob/release-4.0/config-templates/complex-cdc.yaml)
 
+For detailed descriptions of the configuration items in the above TiDB cluster topology file, see [Topology Configuration File for Deploying TiDB Using TiUP](/tiup/tiup-cluster-topology-reference.md).
+
 > **Note:**
 >
 > - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.

diff --git a/tidb-binlog-deployment-topology.md b/tidb-binlog-deployment-topology.md
@@ -26,6 +26,8 @@ TiDB Binlog is the widely used component for replicating incremental data. It pr
 - [The simple template for the TiDB Binlog topology (with `file` as the downstream type)](https://github.com/pingcap/docs/blob/release-4.0/config-templates/simple-file-binlog.yaml)
 - [The complex template for the TiDB Binlog topology](https://github.com/pingcap/docs/blob/release-4.0/config-templates/complex-tidb-binlog.yaml)
 
+For detailed descriptions of the configuration items in the above TiDB cluster topology file, see [Topology Configuration File for Deploying TiDB Using TiUP](/tiup/tiup-cluster-topology-reference.md).
+
 ### Key parameters
 
 The key parameters in the topology configuration templates are as follows:

diff --git a/tiflash-deployment-topology.md b/tiflash-deployment-topology.md
@@ -25,6 +25,8 @@ TiFlash is a columnar storage engine, and gradually becomes the standard cluster
 - [The simple template for the TiFlash topology](https://github.com/pingcap/docs/blob/release-4.0/config-templates/simple-tiflash.yaml)
 - [The complex template for the TiFlash topology](https://github.com/pingcap/docs/blob/release-4.0/config-templates/complex-tiflash.yaml)
 
+For detailed descriptions of the configuration items in the above TiDB cluster topology file, see [Topology Configuration File for Deploying TiDB Using TiUP](/tiup/tiup-cluster-topology-reference.md).
+
 ### Key parameters
 
 - To enable the [Placement Rules](/configure-placement-rules.md) feature of PD, set the value of `replication.enable-placement-rules` in the configuration template to `true`.

diff --git a/tispark-deployment-topology.md b/tispark-deployment-topology.md
@@ -30,6 +30,8 @@ For more information about the TiSpark architecture and how to use it, see [TiSp
 - [Simple TiSpark topology template](https://github.com/pingcap/docs/blob/master/config-templates/simple-tispark.yaml)
 - [Complex TiSpark topology template](https://github.com/pingcap/docs/blob/master/config-templates/complex-tispark.yaml)
 
+For detailed descriptions of the configuration items in the above TiDB cluster topology file, see [Topology Configuration File for Deploying TiDB Using TiUP](/tiup/tiup-cluster-topology-reference.md).
+
 > **Note:**
 >
 > - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.

diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md
@@ -222,7 +222,7 @@ For the PD component, `|L` or `|UI` might be appended to `Up` or `Down`. `|L` in
 >
 > This section describes only the syntax of the scale-in command. For detailed steps of online scaling, refer to [Scale the TiDB Cluster Using TiUP](/scale-tidb-using-tiup.md).
 
-Scaling in a cluster means making some node(s) offline. This operation removes the specific node(s) from the cluster and deletes the remaining data files.
+Scaling in a cluster means making some node(s) offline. This operation removes the specific node(s) from the cluster and deletes the remaining files.
 
 Because the offline process of the TiKV and TiDB Binlog components is asynchronous (which requires removing the node through API), and the process takes a long time (which requires continuous observation on whether the node is successfully taken offline), special treatment is given to the TiKV and TiDB Binlog components.
 

diff --git a/tiup/tiup-documentation-guide.md b/tiup/tiup-documentation-guide.md
@@ -1,26 +1,20 @@
 ---
-title: TiUP Documentation Guide
+title: TiUP Documentation Map
 summary: Guide you through TiUP documentation with links and introductions.
 aliases: ['/docs/stable/tiup/tiup-documentation-guide/','/docs/v4.0/tiup/tiup-documentation-guide/']
 ---
 
-# TiUP Documentation Guide
+# TiUP Documentation Map
 
-## TiUP user guide
+## User guide
 
-- [TiUP Overview](/tiup/tiup-overview.md): Gives an overall introduction to TiUP, for example, how to install and use TiUP
+- [TiUP Overview](/tiup/tiup-overview.md): Gives an overall introduction to TiUP, for example, how to install and use TiUP, and the related terminologies.
 - [TiUP Terminology and Concepts](/tiup/tiup-terminology-and-concepts.md): Explains the terms that you might bump into when using TiUP, and help you understand the key concepts of TiUP
 - [TiUP Component Management](/tiup/tiup-component-management.md): Introduces all TiUP commands in detail, and how to use TiUP to download, update and delete components
 - [TiUP FAQ](/tiup/tiup-faq.md): Introduces common issues when you use TiUP, including FAQs of the third-party components of TiUP
 - [TiUP Troubleshooting Guide](/tiup/tiup-troubleshooting-guide.md): Introduces the troubleshooting methods and solutions if you encounter issues when using TiUP
-
-## TiUP component user guide
-
-- [tiup-playground](/tiup/tiup-playground.md): Introduces how to use the TiUP playground component to quickly build a local TiDB cluster for testing
-- [tiup-cluster](/tiup/tiup-cluster.md): Introduces the usage and command-line flags of the TiUP cluster component, which is used to deploy and maintain a TiDB cluster for production
-- [tiup-mirror](/tiup/tiup-mirror.md): Introduces how to use the TiUP mirror component to customize a local offline mirror
-- [tiup-bench](/tiup/tiup-bench.md): Introduces how to use the TiUP bench component for common stress testings, such as TPCC/TPCH
+- [TiUP Reference Guide](/tiup/tiup-reference.md): Introduces detailed references, including commands, components, and mirrors.
 
 ## TiUP resources
 
-- [TiUP Issues](https://github.com/pingcap/tiup/issues): Lists TiUP Github issues
+- [TiUP Issues](https://github.com/pingcap/tiup/issues): Lists TiUP GitHub issues