Apply suggestions from code review

Co-authored-by: Grace Cai <[email protected]>
pingcap · Mar 3, 2022 · bf1753d · bf1753d
1 parent ba4fc1b
commit bf1753d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/clinic/clinic-data-instruction-for-tiup.md b/clinic/clinic-data-instruction-for-tiup.md
@@ -78,7 +78,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr
 | All metrics data | `{metric_name}.json` | `--include=monitor` |
 | All alerts data | `alerts.json` | `--include=monitor` |
 
-### TiDB system variable
+### TiDB system variables
 
 | Data type | Exported file | Parameter for data collection by TiDB Clinic |
 | :------ | :------ |:-------- |
@@ -93,7 +93,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr
 | Basic information of the system and hardware | `insight.json` | `--include=system` |
 | Contents in the `/etc/security/limits.conf` | `limits.conf` | `--include=system` |
 | List of kernel parameters | `sysctl.conf` | `--include=system` |
-| Socket system information, which is the output of the ss command | `ss.txt` | `--include=system` |
+| Socket system information, which is the output of the `ss` command | `ss.txt` | `--include=system` |
 
 ## DM clusters
 
@@ -137,4 +137,4 @@ This section lists the types of diagnostic data that can be collected by Diag fr
 | Basic information of the system and hardware | `insight.json` | `--include=system` |
 | Contents in the `/etc/security/limits.conf` system | `limits.conf` | `--include=system` |
 | List of kernel parameters | `sysctl.conf` | `--include=system` |
-| Socket system information, which is the output of the ss command | `ss.txt` | `--include=system` |
+| Socket system information, which is the output of the `ss` command | `ss.txt` | `--include=system` |
diff --git a/clinic/clinic-user-guide-for-tiup.md b/clinic/clinic-user-guide-for-tiup.md
@@ -214,15 +214,15 @@ After the upload is complete, you need to send the data access link of `Download
 
 If the network where your cluster is located cannot access the internet, you need to pack the data on your intranet and upload the data package to the Clinic Server using a device with internet access. The detailed operations are as follows:
 
-1. Pack collected in [Step 2. Collect data](#step-2-collect-data) and compress and encrypt the data package by running the following command:
+1. Pack the collected data obtained in [Step 2. Collect data](#step-2-collect-data) by running the following command:
 
     {{< copyable "shell-regular" >}}
 
     ```bash
     tiup diag package ${filepath}
     ```
 
-    While packaging, Diag encrypts and compresses the data at the same time. In the test environment, 800 MB of data was compressed to 57 MB. The following is an example output:
+    During packaging, Diag encrypts and compresses the data at the same time. In the test environment, 800 MB of data was compressed to 57 MB. The following is an example output:
 
     ```bash
     Starting component `diag`: /root/.tiup/components/diag/v0.5.1/diag package diag-fNTnz5MGhr6
@@ -256,7 +256,7 @@ If the network where your cluster is located cannot access the internet, you nee
     Download URL: "https://clinic.pingcap.com:4433/diag/files?uuid=XXXX"
     ```
 
-    After the upload is complete, you need to send the data access link of `Download URL` to the PingCAP technical support staff you contacted before.
+3. After the upload is complete, send the data access link of `Download URL` to the PingCAP technical support staff you contacted before.
 
     > **Note:**
     >