how-to: update doc for deploying tidb cluster using tiup (#2649) (#2717)

* cherry pick #2649 to release-4.0 Signed-off-by: sre-bot <sre-bot@pingcap.com> * change version of template files Co-authored-by: Ran <huangran@pingcap.com>
pingcap · Jun 5, 2020 · 8f84e19 · 8f84e19
1 parent 9c6d15b
commit 8f84e19
Show file tree

Hide file tree

Showing 11 changed files with 66 additions and 1,800 deletions.
diff --git a/geo-distributed-deployment-topology.md b/geo-distributed-deployment-topology.md
@@ -19,7 +19,7 @@ This document takes the typical architecture of three data centers (DC) in two c
 
 ### Topology templates
 
-- [The geo-distributed topology template](https://github.com/pingcap/docs/blob/master/config-templates/geo-redundancy-deployment.yaml)
+- [The geo-distributed topology template](https://github.com/pingcap/docs/blob/release-4.0/config-templates/geo-redundancy-deployment.yaml)
 
 ### Key parameters
 

diff --git a/hybrid-deployment-topology.md b/hybrid-deployment-topology.md
@@ -23,8 +23,8 @@ The deployment machine has multiple CPU processors with sufficient memory. To im
 
 ### Topology templates
 
-- [The simple template for the hybrid deployment](https://github.com/pingcap/docs-cn/blob/master/config-templates/simple-multi-instance.yaml)
-- [The complex template for the hybrid deployment](https://github.com/pingcap/docs/blob/master/config-templates/complex-multi-instance.yaml)
+- [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)
 
 ### Key parameters
 

diff --git a/minimal-deployment-topology.md b/minimal-deployment-topology.md
@@ -19,8 +19,8 @@ This document describes the minimal deployment topology of TiDB clusters.
 
 ### Topology templates
 
-- [The simple template for the minimal topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-mini.yaml)
-- [The complex template for the minimal topology](https://github.com/pingcap/docs/blob/master/config-templates/complex-mini.yaml)
+- [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)
 
 > **Note:**
 >

diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md
diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md
@@ -256,7 +256,7 @@ Other requirements for the target machine:
     ```
 
     - `<cluster-name>`: Set the cluster name
-    - `<tidb-version>`: Set the TiDB cluster version. You can see all the supported TiDB versions by running the `tiup list tidb --refresh` command
+    - `<tidb-version>`: Set the TiDB cluster version. You can see all the supported TiDB versions by running the `tiup list tidb` command
 
     Enter "y" and the `root` user's password to complete the deployment:
 

diff --git a/ticdc-deployment-topology.md b/ticdc-deployment-topology.md
@@ -26,8 +26,8 @@ TiCDC is a tool for replicating the incremental data of TiDB, introduced in TiDB
 
 ### Topology templates
 
-- [The simple template for the TiCDC topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-cdc.yaml)
-- [The complex template for the TiCDC topology](https://github.com/pingcap/docs/blob/master/config-templates/complex-cdc.yaml)
+- [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)
 
 > **Note:**
 >

diff --git a/tidb-binlog-deployment-topology.md b/tidb-binlog-deployment-topology.md
@@ -22,8 +22,8 @@ TiDB Binlog is the widely used component for replicating incremental data. It pr
 
 ### Topology templates
 
-- [The simple template for the TiDB Binlog topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-tidb-binlog.yaml)
-- [The complex template for the TiDB Binlog topology](https://github.com/pingcap/docs/blob/master/config-templates/complex-tidb-binlog.yaml)
+- [The simple template for the TiDB Binlog topology](https://github.com/pingcap/docs/blob/release-4.0/config-templates/simple-tidb-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)
 
 ### Key parameters
 

diff --git a/tiflash-topology-deployment.md → tiflash-deployment-topology.md b/tiflash-topology-deployment.md → tiflash-deployment-topology.md
@@ -22,8 +22,8 @@ TiFlash is a columnar storage engine, and gradually becomes the standard cluster
 
 ### Topology templates
 
-- [The simple template for the TiFlash topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-tiflash.yaml)
-- [The complex template for the TiFlash topology](https://github.com/pingcap/docs/blob/master/config-templates/complex-tiflash.yaml)
+- [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)
 
 ### Key parameters
 

diff --git a/tiup/manage-tiup-component.md b/tiup/manage-tiup-component.md
@@ -44,7 +44,7 @@ Example 2: Get a list of the TiKV component of all installable versions from the
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup list tikv --refresh
+tiup list tikv
 ```
 
 ## Install components

diff --git a/tiup/package-tiup-component.md b/tiup/package-tiup-component.md
@@ -104,7 +104,7 @@ To make it simple, the bash script is used to develop this component. See the fo
     {{< copyable "shell-root" >}}
 
     ```bash
-    tiup list hello --refresh
+    tiup list hello
     ```
 
     ```

diff --git a/tiup/tiup-overview.md b/tiup/tiup-overview.md
@@ -95,7 +95,7 @@ Examples:
   $ tiup update --all                  # Update all installed components to the latest version
   $ tiup update --nightly              # Update all installed components to the nightly version
   $ tiup update --self                 # Update the "tiup" to the latest version
-  $ tiup list --refresh                # Fetch the latest supported components list
+  $ tiup list                          # Fetch the latest supported components list
   $ tiup status                        # Display all running/terminated instances
   $ tiup clean <name>                  # Clean the data of running/terminated instance (Kill process if it's running)
   $ tiup clean --all                   # Clean the data of all running/terminated instances
@@ -124,8 +124,8 @@ The output is long but you can focus on only two parts:
 
 > **Note:**
 >
-> - The number of available components will continue to grow. To check the latest supported components, execute the `tiup list --refresh` command.
-> - The list of available versions of components will also continue to grow. To check the latest supported component versions, execute the `tiup list <component> --refresh` command.
+> - The number of available components will continue to grow. To check the latest supported components, execute the `tiup list` command.
+> - The list of available versions of components will also continue to grow. To check the latest supported component versions, execute the `tiup list <component>` command.
 
 TiUP commands are implemented in TiUP's internal code and used for package management operations, while TiUP components are independent component packages installed by TiUP commands.
-Original file line number
+Diff line change
@@ Expand Up @@
         {{< copyable "shell-root" >}}
         ```bash
-        tiup list hello --refresh
+        tiup list hello
         ```
         ```
@@ Expand Down @@