*: improve deployment doc and toc (#19653) (#19718)

pingcap · Dec 18, 2024 · 416e400 · 416e400
1 parent 16d99df
commit 416e400
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 17 deletions.
diff --git a/TOC.md b/TOC.md
@@ -13,8 +13,8 @@
 - Get Started
   - [Quick Start with TiDB](/quick-start-with-tidb.md)
   - [Quick Start with HTAP](/quick-start-with-htap.md)
-  - [Learn TiDB SQL](/basic-sql-operations.md)
-  - [Learn HTAP](/explore-htap.md)
+  - [Explore SQL with TiDB](/basic-sql-operations.md)
+  - [Explore HTAP](/explore-htap.md)
   - [Import Example Database](/import-example-data.md)
 - Develop
   - [Overview](/develop/dev-guide-overview.md)

diff --git a/best-practices/tidb-best-practices.md b/best-practices/tidb-best-practices.md
@@ -141,7 +141,7 @@ In the last section, we discussed some basic implementation mechanisms of TiDB a
 
 ### Deployment
 
-Before deployment, read [Software and Hardware Requirements](/hardware-and-software-requirements.md).
+Before deployment, read [TiDB Software and Hardware Requirements](/hardware-and-software-requirements.md).
 
 It is recommended to deploy the TiDB cluster using [TiUP](/production-deployment-using-tiup.md). This tool can deploy, stop, destroy, and upgrade the whole cluster, which is quite convenient. It is not recommended to manually deploy the TiDB cluster, which might be troublesome to maintain and upgrade later.
 

diff --git a/check-before-deployment.md b/check-before-deployment.md
@@ -148,7 +148,7 @@ Some operations in TiDB require writing temporary files to the server, so it is
     When the variable [`tidb_ddl_enable_fast_reorg`](/system-variables.md#tidb_ddl_enable_fast_reorg-new-in-v630) is set to `ON` (the default value in v6.5.0 and later versions), `Fast Online DDL` is enabled, and some DDL operations need to read and write temporary files in filesystems. The location is defined by the configuration item [`temp-dir`](/tidb-configuration-file.md#temp-dir-new-in-v630). You need to ensure that the user that runs TiDB has read and write permissions for that directory of the operating system. The default directory `/tmp/tidb` uses tmpfs (temporary file system). It is recommended to explicitly specify a disk directory. The following uses `/data/tidb-deploy/tempdir` as an example:
 
     > **Note:**
-    > 
+    >
     > If DDL operations on large objects exist in your application, it is highly recommended to configure an independent large file system for [`temp-dir`](/tidb-configuration-file.md#temp-dir-new-in-v630).
 
     ```shell

diff --git a/faq/deploy-and-maintain-faq.md b/faq/deploy-and-maintain-faq.md
@@ -15,7 +15,7 @@ For the TiDB-supported operating systems, see [Software and Hardware Recommendat
 
 ### What is the recommended hardware configuration for a TiDB cluster in the development, test, or production environment?
 
-You can deploy and run TiDB on the 64-bit generic hardware server platform in the Intel x86-64 architecture or on the hardware server platform in the ARM architecture. For the requirements and recommendations about server hardware configuration for development, test, and production environments, see [Software and Hardware Recommendations - Server recommendations](/hardware-and-software-requirements.md#server-recommendations).
+You can deploy and run TiDB on the 64-bit generic hardware server platform in the Intel x86-64 architecture or on the hardware server platform in the ARM architecture. For the requirements and recommendations about server hardware configuration for development, test, and production environments, see [Software and Hardware Recommendations - Server requirements](/hardware-and-software-requirements.md#server-requirements).
 
 ### What's the purposes of 2 network cards of 10 gigabit?
 

diff --git a/faq/sql-faq.md b/faq/sql-faq.md
@@ -353,7 +353,7 @@ The `count(1)` statement counts the total number of rows in a table. Improving t
 
 Recommendations:
 
-- Improve the hardware configuration. See [Software and Hardware Requirements](/hardware-and-software-requirements.md).
+- Improve the hardware configuration. See [TiDB Software and Hardware Requirements](/hardware-and-software-requirements.md).
 - Improve the concurrency. The default value is 10. You can improve it to 50 and have a try. But usually the improvement is 2-4 times of the default value.
 - Test the `count` in the case of large amount of data.
 - Optimize the TiKV configuration. See [Tune TiKV Thread Performance](/tune-tikv-thread-performance.md) and [Tune TiKV Memory Performance](/tune-tikv-memory-performance.md).

diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md
@@ -1,9 +1,9 @@
 ---
-title: Software and Hardware Recommendations
+title: TiDB Software and Hardware Requirements
 summary: Learn the software and hardware recommendations for deploying and running TiDB.
 ---
 
-# Software and Hardware Recommendations
+# TiDB Software and Hardware Requirements
 
 <!-- Localization note for TiDB:
 
@@ -13,7 +13,7 @@ summary: Learn the software and hardware recommendations for deploying and runni
 
 -->
 
-As an open-source distributed SQL database with high performance, TiDB can be deployed in the Intel architecture server, ARM architecture server, and major virtualization environments and runs well. TiDB supports most of the major hardware networks and Linux operating systems.
+This document describes the software and hardware requirements for deploying and running the TiDB database. As an open-source distributed SQL database with high performance, TiDB can be deployed in the Intel architecture server, ARM architecture server, and major virtualization environments and runs well. TiDB supports most of the major hardware networks and Linux operating systems.
 
 ## OS and platform requirements
 
@@ -140,7 +140,7 @@ The following CPU architectures are supported:
 - x86_64. Starting from TiDB v6.6.0, the [x86-64-v2 instruction set](https://developers.redhat.com/blog/2021/01/05/building-red-hat-enterprise-linux-9-for-the-x86-64-v2-microarchitecture-level) is required.
 - ARM 64
 
-## Software recommendations
+## Software requirements
 
 ### Control machine
 
@@ -161,7 +161,7 @@ The following CPU architectures are supported:
 | numa | 2.0.12 or later |
 | tar | any |
 
-## Server recommendations
+## Server requirements
 
 You can deploy and run TiDB on the 64-bit generic hardware server platform in the Intel x86-64 architecture or on the hardware server platform in the ARM architecture. The requirements and recommendations about server hardware configuration (ignoring the resources occupied by the operating system itself) for development, test, and production environments are as follows:
 

diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md
@@ -5,16 +5,20 @@ summary: Learn how to easily deploy a TiDB cluster using TiUP.
 
 # Deploy a TiDB Cluster Using TiUP
 
-[TiUP](https://github.com/pingcap/tiup) is a cluster operation and maintenance tool introduced in TiDB 4.0. TiUP provides [TiUP cluster](https://github.com/pingcap/tiup/tree/master/components/cluster), a cluster management component written in Golang. By using TiUP cluster, you can easily perform daily database operations, including deploying, starting, stopping, destroying, scaling, and upgrading a TiDB cluster, and manage TiDB cluster parameters.
+This guide describes how to deploy a TiDB Self-Managed cluster using [TiUP](https://github.com/pingcap/tiup) in the production environment.
 
-TiUP supports deploying TiDB, TiFlash, TiCDC, and the monitoring system. This document introduces how to deploy TiDB clusters of different topologies.
+TiUP is a cluster operation and maintenance tool introduced in TiDB v4.0. It provides [TiUP cluster](https://github.com/pingcap/tiup/tree/master/components/cluster), a Golang-based component for managing TiDB clusters. By using the TiUP cluster, you can easily perform routine database operations, such as deploying, starting, stopping, destroying, scaling, upgrading TiDB clusters, and managing TiDB cluster parameters.
+
+TiUP also supports deploying TiDB, TiFlash, TiCDC, and the monitoring system. This guide introduces how to deploy TiDB clusters with different topologies.
 
 ## Step 1. Prerequisites and precheck
 
 Make sure that you have read the following documents:
 
-- [Hardware and software requirements](/hardware-and-software-requirements.md)
-- [Environment and system configuration check](/check-before-deployment.md)
+- [TiDB Software and Hardware Requirements](/hardware-and-software-requirements.md)
+- [TiDB Environment and System Configuration Check](/check-before-deployment.md)
+
+In addition, it is recommended to learn the [Best Practices for TiDB Security Configuration](/best-practices-for-security-configuration.md).
 
 ## Step 2. Deploy TiUP on the control machine
 
@@ -440,9 +444,11 @@ If you have deployed [TiFlash](/tiflash/tiflash-overview.md) along with the TiDB
 - [TiFlash Alert Rules and Solutions](/tiflash/tiflash-alert-rules.md)
 - [Troubleshoot TiFlash](/tiflash/troubleshoot-tiflash.md)
 
-If you have deployed [TiCDC](/ticdc/ticdc-overview.md) along with the TiDB cluster, see the following documents:
+If you have deployed [TiCDC](/ticdc/ticdc-overview.md) along with the TiDB cluster, see the following documents to stream data:
 
 - [Changefeed Overview](/ticdc/ticdc-changefeed-overview.md)
 - [Manage Changefeed](/ticdc/ticdc-manage-changefeed.md)
 - [Troubleshoot TiCDC](/ticdc/troubleshoot-ticdc.md)
 - [TiCDC FAQs](/ticdc/ticdc-faq.md)
+
+If you want to scale out or scale in your TiDB cluster without interrupting the online services, see [Scale a TiDB Cluster Using TiUP](/scale-tidb-using-tiup.md).
diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md
@@ -519,7 +519,13 @@ If you are ready to deploy a TiDB cluster for the production environment, here a
 - [Deploy TiDB using TiUP](/production-deployment-using-tiup.md)
 - Alternatively, you can deploy TiDB on Cloud using TiDB Operator by referring to the [TiDB on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable) documentation.
 
+If you are an application developer and want to quickly build an application using TiDB, here are the next steps:
+
+- [Developer Guide Overview](/develop/dev-guide-overview.md)
+- [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
+- [Example Applications](/develop/dev-guide-sample-application-java-jdbc.md)
+
 If you are looking for an analytics solution with TiFlash, here are the next steps:
 
-- [Use TiFlash](/tiflash/tiflash-overview.md#use-tiflash)
 - [TiFlash Overview](/tiflash/tiflash-overview.md)
+- [Use TiFlash](/tiflash/tiflash-overview.md#use-tiflash)