updated tiup docs

pingcap · Dec 13, 2024 · 19baf4a · 19baf4a
1 parent 38354e9
commit 19baf4a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 9 deletions.
diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md
@@ -68,6 +68,11 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
 
 3. Start the cluster in the current session:
 
+        > **Note:**
+        >
+        > - For the playground operated in the following way, after the test deployment is finished, TiUP will clean up the original cluster data. You will get a new cluster after re-running the command.
+        > - If you want the data to be persisted on storage, run `tiup --tag <your-tag> playground ...`. For details, refer to [Specify a tag when starting the TiDB cluster to store the data](/tiup/tiup-playground.md#specify-a-tag-when-starting-the-tidb-cluster-to-store-the-data).
+
     - To start a TiDB cluster of the latest version with 1 TiDB instance, 1 TiKV instance, 1 PD instance, and 1 TiFlash instance, run the following command:
 
         {{< copyable "shell-regular" >}}
@@ -100,9 +105,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
 
         > **Note:**
         >
-        > + Since v5.2.0, TiDB supports running `tiup playground` on the machine that uses the Apple M1 chip.
-        > + For the playground operated in this way, after the test deployment is finished, TiUP will clean up the original cluster data. You will get a new cluster after re-running the command.
-        > + If you want the data to be persisted on storage, run `tiup --tag <your-tag> playground ...`. For details, refer to the [TiUP Reference](/tiup/tiup-reference.md#-t---tag) guide.
+        > Starting from v5.2.0, TiDB supports running `tiup playground` on the machine that uses the Apple M1 chip.
 
 4. Start a new session to access TiDB:
 
@@ -189,6 +192,11 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
 
 3. Start the cluster in the current session:
 
+        > **Note:**
+        >
+        > - For the playground operated in the following way, after the test deployment is finished, TiUP will clean up the original cluster data. You will get a new cluster after re-running the command.
+        > - If you want the data to be persisted on storage, run `tiup --tag <your-tag> playground ...`. For details, refer to [Specify a tag when starting the TiDB cluster to store the data](/tiup/tiup-playground.md#specify-a-tag-when-starting-the-tidb-cluster-to-store-the-data).
+
     - To start a TiDB cluster of the latest version with 1 TiDB instance, 1 TiKV instance, 1 PD instance, and 1 TiFlash instance, run the following command:
 
         {{< copyable "shell-regular" >}}
@@ -218,11 +226,6 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
         To view the Grafana: http://127.0.0.1:3000
         ```
 
-        > **Note:**
-        >
-        > For the playground operated in this way, after the test deployment is finished, TiUP will clean up the original cluster data. You will get a new cluster after re-running the command.
-        > If you want the data to be persisted on storage, run `tiup --tag <your-tag> playground ...`. For details, refer to the [TiUP Reference](/tiup/tiup-reference.md#-t---tag) guide.
-
 4. Start a new session to access TiDB:
 
     + Use the TiUP client to connect to TiDB.

diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md
@@ -121,7 +121,7 @@ By default, only one instance is started for each TiDB, TiKV, and PD component.
 tiup playground --db 3 --pd 3 --kv 3
 ```
 
-### Specify a tag when starting the TiDB cluster
+### Specify a tag when starting the TiDB cluster to store the data
 
 After you stop a TiDB cluster started using TiUP playground, all cluster data is cleaned up as well. To start a TiDB cluster using TiUP playground and ensure that the cluster data is not cleaned up automatically, you can specify a tag when starting the cluster. After specifying the tag, you can find the cluster data in the `~/.tiup/data` directory. Run the following command to specify a tag: