Skip to content

Commit

Permalink
*: optimize 4 docs descriptions (pingcap#13947)
Browse files Browse the repository at this point in the history
  • Loading branch information
ran-huang authored Jul 6, 2023
1 parent cb45d9d commit 3504d36
Show file tree
Hide file tree
Showing 4 changed files with 97 additions and 93 deletions.
38 changes: 19 additions & 19 deletions _docHome.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@ hide_leftNav: true

<DocHomeSection label="TiDB Cloud" anchor="tidb-cloud" id="tidb-cloud">

TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings everything great about TiDB to your cloud, and lets you focus on your applications, not the complexities of your database.
TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings everything great about TiDB to your cloud, letting you focus on your applications instead of the complexities of your database.

<DocHomeCardContainer>

<DocHomeCard href="https://docs.pingcap.com/tidbcloud" icon="doc2" label="TiDB Cloud Docs">

See the documentation of TiDB Cloud
View the documentation for TiDB Cloud.

</DocHomeCard>

<DocHomeCard href="https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart" icon="cloud5" label="Get Started with TiDB Cloud">

Guides you through an easy way to get started with TiDB Cloud
Guide for an easy way to get started with TiDB Cloud.

</DocHomeCard>

<DocHomeCard href="https://docs.pingcap.com/tidbcloud/tidb-cloud-poc" icon="cloud3" label="Perform a PoC with TiDB Cloud">

Helps you quickly complete a Proof of Concept (PoC) of TiDB Cloud
Helps you quickly complete a Proof of Concept (PoC) with TiDB Cloud.

</DocHomeCard>

Expand Down Expand Up @@ -55,25 +55,25 @@ TiDB is an open-source distributed SQL database that supports Hybrid Transaction

<DocHomeCard href="https://docs.pingcap.com/tidb/stable" icon="doc1" label="TiDB Docs">

See the documentation of TiDB
View the documentation for TiDB.

</DocHomeCard>

<DocHomeCard href="https://docs.pingcap.com/tidb/stable/quick-start-with-tidb" icon="doc5" label="Get Started with TiDB">

Walks you through the quickest way to get started with TiDB
Walks you through the quickest way to get started with TiDB.

</DocHomeCard>

<DocHomeCard href="https://docs.pingcap.com/tidb/stable/production-deployment-using-tiup" icon="cloud7" label="Deploy a Local TiDB Cluster">

Learn how to deploy TiDB locally in production
Learn how to deploy TiDB locally in a production environment.

</DocHomeCard>

</DocHomeCardContainer>

The open-source TiDB platform is released under the Apache 2.0 license, and supported by the community.
The open-source TiDB platform is released under the Apache 2.0 license and is supported by the community.

<a href="https://en.pingcap.com/download/" class="button" target="_blank" referrerpolicy="no-referrer-when-downgrade">Download</a>

Expand All @@ -85,13 +85,13 @@ The open-source TiDB platform is released under the Apache 2.0 license, and supp

<DocHomeCard href="https://docs.pingcap.com/tidb/stable/dev-guide-overview" icon="doc8" label="Developer Guide">

Documentation for TiDB application developers
Documentation for TiDB application developers.

</DocHomeCard>

<DocHomeCard href="https://docs.pingcap.com/tidbcloud/dev-guide-overview" icon="cloud-dev" label="Developer Guide">

Documentation for TiDB Cloud application developers
Documentation for TiDB Cloud application developers.

</DocHomeCard>

Expand All @@ -105,55 +105,55 @@ Documentation for TiDB Cloud application developers

<DocHomeCard href="https://play.tidbcloud.com/?utm_source=docs&utm_medium=home_more_resources" icon="playground" label="TiDB Playground">

One-stop and interactive experience of TiDB's capabilities WITHOUT registration
Experience the capabilities of TiDB WITHOUT registration.

</DocHomeCard>

<DocHomeCard href="https://en.pingcap.com/education/" icon="cloud1" label="PingCAP Education">

Learn TiDB and TiDB Cloud through well-designed online courses and instructor-led training
Learn TiDB and TiDB Cloud through well-designed online courses and instructor-led training.

</DocHomeCard>

<DocHomeCard href="https://en.pingcap.com/community/" icon="doc9" label="Community">

Join us on Slack or become a contributor
Join us on Slack or become a contributor.

</DocHomeCard>

<DocHomeCard href="https://en.pingcap.com/blog/" icon="doc10" label="Blog Posts">

Learn great articles about TiDB and TiDB Cloud
Read great articles about TiDB and TiDB Cloud.

</DocHomeCard>

<DocHomeCard href="https://en.pingcap.com/videos/" icon="doc11" label="Videos">

See a compilation of short videos describing TiDB and a variety of use cases
Watch a compilation of short videos describing TiDB and various use cases.

</DocHomeCard>

<DocHomeCard href="https://en.pingcap.com/event/" icon="events" label="Events">

Learn events about PingCAP and the community
Learn about events hosted by PingCAP and the community.

</DocHomeCard>

<DocHomeCard href="https://en.pingcap.com/ebook-whitepaper/" icon="papers" label="eBooks & Papers">

Download eBooks and papers
Download eBooks and papers.

</DocHomeCard>

<DocHomeCard href="https://ossinsight.io/" icon="ossinsight" label="OSS Insight">

A powerful insight tool that analyzes in depth any GitHub repository, powered by TiDB Cloud
A powerful insight tool that analyzes any GitHub repository in depth, powered by TiDB Cloud.

</DocHomeCard>

<DocHomeCard href="https://github.com/pingcap/docs/blob/master/CONTRIBUTING.md" icon="contributor" label="Contribute">

Lets work together to make the documentation better!
Let's work together to improve the documentation!

</DocHomeCard>

Expand Down
70 changes: 35 additions & 35 deletions quick-start-with-tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliases: ['/docs/dev/quick-start-with-tidb/','/docs/dev/test-deployment-using-do

# Quick Start Guide for the TiDB Database Platform

This guide walks you through the quickest way to get started with TiDB. For non-production environments, you can deploy your TiDB database by either of the following methods:
This guide provides the quickest way to get started with TiDB. For non-production environments, you can deploy your TiDB database using either of the following methods:

- [Deploy a local test cluster](#deploy-a-local-test-cluster) (for macOS and Linux)
- [Simulate production deployment on a single machine](#simulate-production-deployment-on-a-single-machine) (for Linux only)
Expand All @@ -17,7 +17,7 @@ In addition, you can try out TiDB features on [TiDB Playground](https://play.tid
>
> The deployment method provided in this guide is **ONLY FOR** quick start, **NOT FOR** production.
>
> - To deploy a self-hosted production cluster, see [production installation guide](/production-deployment-using-tiup.md).
> - To deploy a self-hosted production cluster, see the [production installation guide](/production-deployment-using-tiup.md).
> - To deploy TiDB on Kubernetes, see [Get Started with TiDB on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/get-started).
> - To manage TiDB in the cloud, see [TiDB Cloud Quick Start](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart).
Expand All @@ -28,7 +28,7 @@ In addition, you can try out TiDB features on [TiDB Playground](https://play.tid
<SimpleTab>
<div label="macOS">

As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB instances, 3 TiKV instances, 3 PD instances, and optional TiFlash instances. With TiUP Playground, you can quickly build the test cluster by taking the following steps:
As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB instances, 3 TiKV instances, 3 PD instances, and optional TiFlash instances. With TiUP Playground, you can quickly build the test cluster by following these steps:

1. Download and install TiUP:

Expand All @@ -38,7 +38,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
```

If the following message is displayed, you have installed TiUP successfully:
If the following message is displayed, you have successfully installed TiUP:

```log
Successfully set mirror to https://tiup-mirrors.pingcap.com
Expand Down Expand Up @@ -68,15 +68,15 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in

3. Start the cluster in the current session:

- If you want 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:
- 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" >}}

```shell
tiup playground
```

- If you want to specify the TiDB version and the number of the instances of each component, run a command like this:
- To specify the TiDB version and the number of instances of each component, run a command like this:

{{< copyable "shell-regular" >}}

Expand All @@ -102,7 +102,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
>
> + 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 [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag).
> + 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:

Expand All @@ -114,7 +114,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
tiup client
```

+ You can also use the MySQL client to connect to TiDB.
+ Alternatively, you can use the MySQL client to connect to TiDB.

{{< copyable "shell-regular" >}}

Expand All @@ -124,7 +124,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in

5. Access the Prometheus dashboard of TiDB at <http://127.0.0.1:9090>.

6. Access the [TiDB Dashboard](/dashboard/dashboard-intro.md) at <http://127.0.0.1:2379/dashboard>. The default username is `root`, with an empty password.
6. Access the [TiDB Dashboard](/dashboard/dashboard-intro.md) at <http://127.0.0.1:2379/dashboard>. The default username is `root`, and the password is empty.

7. Access the Grafana dashboard of TiDB through <http://127.0.0.1:3000>. Both the default username and password are `admin`.

Expand All @@ -149,7 +149,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
</div>
<div label="Linux">

As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB instances, 3 TiKV instances, 3 PD instances, and optional TiFlash instances. With TiUP Playground, you can quickly build the test cluster by taking the following steps:
As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB instances, 3 TiKV instances, 3 PD instances, and optional TiFlash instances. With TiUP Playground, you can quickly build the test cluster by following these steps:

1. Download and install TiUP:

Expand All @@ -159,7 +159,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
```

If the following message is displayed, you have installed TiUP successfully:
If the following message is displayed, you have successfully installed TiUP:

```log
Successfully set mirror to https://tiup-mirrors.pingcap.com
Expand Down Expand Up @@ -189,15 +189,15 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in

3. Start the cluster in the current session:

- If you want 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:
- 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" >}}

```shell
tiup playground
```

- If you want to specify the TiDB version and the number of the instances of each component, run a command like this:
- To specify the TiDB version and the number of instances of each component, run a command like this:

{{< copyable "shell-regular" >}}

Expand All @@ -221,7 +221,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
> **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 [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag).
> 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:

Expand All @@ -233,7 +233,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
tiup client
```

+ You can also use the MySQL client to connect to TiDB.
+ Alternatively, you can use the MySQL client to connect to TiDB.

{{< copyable "shell-regular" >}}

Expand All @@ -243,7 +243,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in

5. Access the Prometheus dashboard of TiDB at <http://127.0.0.1:9090>.

6. Access the [TiDB Dashboard](/dashboard/dashboard-intro.md) at <http://127.0.0.1:2379/dashboard>. The default username is `root`, with an empty password.
6. Access the [TiDB Dashboard](/dashboard/dashboard-intro.md) at <http://127.0.0.1:2379/dashboard>. The default username is `root`, and the password is empty.

7. Access the Grafana dashboard of TiDB through <http://127.0.0.1:3000>. Both the default username and password are `admin`.

Expand Down Expand Up @@ -276,16 +276,16 @@ This section describes how to deploy a TiDB cluster using a YAML file of the sma

### Prepare

Prepare a target machine that meets the following requirements:
Before deploying the TiDB cluster, ensure that the target machine meets the following requirements:

- CentOS 7.3 or a later version is installed
- The Linux OS has access to the Internet, which is required to download TiDB and related software installation packages
- CentOS 7.3 or a later version is installed.
- The Linux OS has access to the internet, which is required to download TiDB and related software installation packages.

The smallest TiDB cluster topology is as follows:
The smallest TiDB cluster topology consists of the following instances:

> **Note:**
>
> The IP address of the following instances only serves as an example IP. In your actual deployment, you need to replace the IP with your actual IP.
> The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.

| Instance | Count | IP | Configuration |
|:-- | :-- | :-- | :-- |
Expand All @@ -295,14 +295,14 @@ The smallest TiDB cluster topology is as follows:
| TiFlash | 1 | 10.0.1.1 | The default port <br/> Global directory configuration |
| Monitor | 1 | 10.0.1.1 | The default port <br/> Global directory configuration |

Other requirements for the target machine:
Other requirements for the target machine include:

- The `root` user and its password is required
- The `root` user and its password are required
- [Stop the firewall service of the target machine](/check-before-deployment.md#check-and-stop-the-firewall-service-of-target-machines), or open the port needed by the TiDB cluster nodes
- Currently, the TiUP cluster supports deploying TiDB on the x86_64 (AMD64) and ARM architectures:

- It is recommended to use CentOS 7.3 or later versions on AMD64
- It is recommended to use CentOS 7.6 1810 on ARM
- It is recommended to use CentOS 7.3 or later versions on AMD64.
- It is recommended to use CentOS 7.6 1810 on ARM.

### Deploy

Expand Down Expand Up @@ -346,7 +346,7 @@ Other requirements for the target machine:
tiup update --self && tiup update cluster
```

5. Use the root user privilege to increase the connection limit of the `sshd` service. This is because TiUP needs to simulate deployment on multiple machines.
5. Increase the connection limit of the `sshd` service using the root user privilege. This is because TiUP needs to simulate deployment on multiple machines.

1. Modify `/etc/ssh/sshd_config`, and set `MaxSessions` to `20`.
2. Restart the `sshd` service:
Expand Down Expand Up @@ -499,17 +499,17 @@ Other requirements for the target machine:
## What's next
- If you have just deployed a TiDB cluster for the local test environment:
If you have just deployed a TiDB cluster for the local test environment, here are the next steps:
- Learn [Basic SQL operations in TiDB](/basic-sql-operations.md)
- [Migrate data to TiDB](/migration-overview.md)
- Learn about basic SQL operations in TiDB by referring to [Basic SQL operations in TiDB](/basic-sql-operations.md).
- You can also migrate data to TiDB by referring to [Migrate data to TiDB](/migration-overview.md).
- If you are ready to deploy a TiDB cluster for the production environment:
If you are ready to deploy a TiDB cluster for the production environment, here are the next steps:
- [Deploy TiDB using TiUP](/production-deployment-using-tiup.md)
- [Deploy TiDB on Cloud using TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable)
- [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're looking for analytics solution with TiFlash:
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)
- [TiFlash Overview](/tiflash/tiflash-overview.md)
4 changes: 2 additions & 2 deletions sql-statements/sql-statement-flush-privileges.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliases: ['/docs/dev/sql-statements/sql-statement-flush-privileges/','/docs/dev/

# FLUSH PRIVILEGES

This statement triggers TiDB to reload the in-memory copy of privileges from the privilege tables. You should execute `FLUSH PRIVILEGES` after making manual edits to tables such as `mysql.user`. Executing this statement is not required after using privilege statements such as `GRANT` or `REVOKE`. Executing this statement requires the `RELOAD` privilege.
The statement `FLUSH PRIVILEGES` instructs TiDB to reload the in-memory copy of privileges from the privilege tables. You must execute this statement after manually editing tables such as `mysql.user`. However, executing this statement is not necessary after using privilege statements like `GRANT` or `REVOKE`. To execute this statement, the `RELOAD` privilege is required.

## Synopsis

Expand Down Expand Up @@ -35,7 +35,7 @@ Query OK, 0 rows affected (0.01 sec)

## MySQL compatibility

This statement is understood to be fully compatible with MySQL. Any compatibility differences should be [reported via an issue](https://github.com/pingcap/tidb/issues/new/choose) on GitHub.
This statement is fully compatible with MySQL. If you find any compatibility differences, report them via [an issue on GitHub](https://github.com/pingcap/tidb/issues/new/choose).

## See also

Expand Down
Loading

0 comments on commit 3504d36

Please sign in to comment.