glossary: Add more abbreviations (#19213)

pingcap · Nov 15, 2024 · 85e27f3 · 85e27f3
1 parent 0f01266
commit 85e27f3
Show file tree

Hide file tree

Showing 10 changed files with 195 additions and 23 deletions.
diff --git a/br/br-snapshot-guide.md b/br/br-snapshot-guide.md
@@ -33,7 +33,7 @@ tiup br backup full --pd "${PD_IP}:2379" \
 
 In the preceding command:
 
-- `--backupts`: The time point of the snapshot. The format can be [TSO](/glossary.md#tso) or timestamp, such as `400036290571534337` or `2018-05-11 01:42:23 +08:00`. If the data of this snapshot is garbage collected, the `tiup br backup` command returns an error and `br` exits. When backing up using a timestamp, it is recommended to specify the time zone as well. Otherwise, `br` uses the local time zone to construct the timestamp by default, which might lead to an incorrect backup time point. If you leave this parameter unspecified, `br` picks the snapshot corresponding to the backup start time.
+- `--backupts`: The time point of the snapshot. The format can be [TSO](/tso.md) or timestamp, such as `400036290571534337` or `2018-05-11 01:42:23 +08:00`. If the data of this snapshot is garbage collected, the `tiup br backup` command returns an error and `br` exits. When backing up using a timestamp, it is recommended to specify the time zone as well. Otherwise, `br` uses the local time zone to construct the timestamp by default, which might lead to an incorrect backup time point. If you leave this parameter unspecified, `br` picks the snapshot corresponding to the backup start time.
 - `--storage`: The storage address of the backup data. Snapshot backup supports Amazon S3, Google Cloud Storage, and Azure Blob Storage as backup storage. The preceding command uses Amazon S3 as an example. For more details, see [URI Formats of External Storage Services](/external-storage-uri.md).
 - `--ratelimit`: The maximum speed **per TiKV** performing backup tasks. The unit is in MiB/s.
 
@@ -129,8 +129,8 @@ tiup br restore full \
 
 ### Restore tables in the `mysql` schema
 
-- Starting from BR v5.1.0, when you back up snapshots, BR automatically backs up the **system tables** in the `mysql` schema, but does not restore these system tables by default. 
-- Starting from v6.2.0, BR lets you specify `--with-sys-table` to restore **data in some system tables**. 
+- Starting from BR v5.1.0, when you back up snapshots, BR automatically backs up the **system tables** in the `mysql` schema, but does not restore these system tables by default.
+- Starting from v6.2.0, BR lets you specify `--with-sys-table` to restore **data in some system tables**.
 - Starting from v7.6.0, BR enables `--with-sys-table` by default, which means that BR restores **data in some system tables** by default.
 
 **BR can restore data in the following system tables:**

diff --git a/br/br-snapshot-manual.md b/br/br-snapshot-manual.md
@@ -42,7 +42,7 @@ tiup br backup full \
 
 In the preceding command:
 
-- `--backupts`: The time point of the snapshot. The format can be [TSO](/glossary.md#tso) or timestamp, such as `400036290571534337` or `2024-06-28 13:30:00 +08:00`. If the data of this snapshot is garbage collected, the `tiup br backup` command returns an error and 'br' exits. If you leave this parameter unspecified, `br` picks the snapshot corresponding to the backup start time.
+- `--backupts`: The time point of the snapshot. The format can be [TSO](/tso.md) or timestamp, such as `400036290571534337` or `2024-06-28 13:30:00 +08:00`. If the data of this snapshot is garbage collected, the `tiup br backup` command returns an error and 'br' exits. If you leave this parameter unspecified, `br` picks the snapshot corresponding to the backup start time.
 - `--ratelimit`: The maximum speed **per TiKV** performing backup tasks. The unit is in MiB/s.
 - `--log-file`: The target file where `br` log is written.
 

diff --git a/dm/dm-glossary.md b/dm/dm-glossary.md
@@ -8,6 +8,8 @@ aliases: ['/docs/tidb-data-migration/dev/glossary/']
 
 This document lists the terms used in the logs, monitoring, configurations, and documentation of TiDB Data Migration (DM).
 
+For TiDB-related terms and definitions, see [TiDB glossary](/glossary.md).
+
 ## B
 
 ### Binlog

diff --git a/glossary.md b/glossary.md
diff --git a/latency-breakdown.md b/latency-breakdown.md
@@ -104,7 +104,7 @@ tidb_session_execute_duration_seconds{type="general"} =
     read value duration
 ```
 
-`pd_client_cmd_handle_cmds_duration_seconds{type="wait"}` records the duration of fetching [TSO (Timestamp Oracle)](/glossary.md#tso) from PD. When reading in an auto-commit transaction mode with a clustered primary index or from a snapshot, the value will be zero.
+`pd_client_cmd_handle_cmds_duration_seconds{type="wait"}` records the duration of fetching [TSO (Timestamp Oracle)](/tso.md) from PD. When reading in an auto-commit transaction mode with a clustered primary index or from a snapshot, the value will be zero.
 
 The `read handle duration` and `read value duration` are calculated as:
 

diff --git a/scripts/check-glossary.py b/scripts/check-glossary.py
@@ -0,0 +1,34 @@
+#!/bin/python3
+import sys
+from difflib import unified_diff
+
+print("Checking alphabetic sorting of glossary.md")
+
+with open("glossary.md") as fh:
+    # Extract the lines that start with ### into itemsA (unsorted)
+    itemsA = ""
+    for line in fh.readlines():
+        if line.startswith("###"):
+            itemsA += line
+    fh.seek(0)
+
+    # Extract the lines that start with ### into itemsB (sorted)
+    itemsB = ""
+    for line in sorted(fh.readlines(), key=str.casefold):
+        if line.startswith("###"):
+            itemsB += line
+
+    if itemsA == itemsB:
+        print("result: OK")
+        sys.exit(0)
+
+    print("result: differences found, see diff for details")
+    # diff itemsA and itemsB
+    diff = unified_diff(
+        itemsA.splitlines(keepends=True),
+        itemsB.splitlines(keepends=True),
+        fromfile="before",
+        tofile="after",
+    )
+    sys.stdout.writelines(diff)
+    sys.exit(1)
diff --git a/ticdc/ticdc-glossary.md b/ticdc/ticdc-glossary.md
@@ -7,7 +7,7 @@ summary: Learn the terms about TiCDC and their definitions.
 
 This glossary provides TiCDC-related terms and definitions. These terms appears in TiCDC logs, monitoring metrics, configurations, and documents.
 
-For TiDB-related terms and definitions, refer to [TiDB glossary](/glossary.md).
+For TiDB-related terms and definitions, see [TiDB glossary](/glossary.md).
 
 ## C
 

diff --git a/tidb-lightning/tidb-lightning-glossary.md b/tidb-lightning/tidb-lightning-glossary.md
@@ -8,6 +8,8 @@ aliases: ['/docs/dev/tidb-lightning/tidb-lightning-glossary/','/docs/dev/referen
 
 This page explains the special terms used in TiDB Lightning's logs, monitoring, configurations, and documentation.
 
+For TiDB-related terms and definitions, see [TiDB glossary](/glossary.md).
+
 <!-- A -->
 
 ## A

diff --git a/tiflash/tiflash-mintso-scheduler.md b/tiflash/tiflash-mintso-scheduler.md
@@ -5,7 +5,7 @@ summary: Learn the implementation principles of the TiFlash MinTSO Scheduler.
 
 # TiFlash MinTSO Scheduler
 
-The TiFlash MinTSO scheduler is a distributed scheduler for [MPP](/glossary.md#mpp) tasks in TiFlash. This document describes the implementation principles of the TiFlash MinTSO scheduler.
+The TiFlash MinTSO scheduler is a distributed scheduler for [MPP](/glossary.md#massively-parallel-processing-mpp) tasks in TiFlash. This document describes the implementation principles of the TiFlash MinTSO scheduler.
 
 ## Background
 

diff --git a/tiflash/use-tiflash-mpp-mode.md b/tiflash/use-tiflash-mpp-mode.md
@@ -7,7 +7,7 @@ summary: Learn the MPP mode of TiFlash and how to use it.
 
 <CustomContent platform="tidb">
 
-This document introduces the [Massively Parallel Processing (MPP)](/glossary.md#mpp) mode of TiFlash and how to use it.
+This document introduces the [Massively Parallel Processing (MPP)](/glossary.md#massively-parallel-processing-mpp) mode of TiFlash and how to use it.
 
 </CustomContent>