Skip to content

Commit

Permalink
master/5.0: bump version and links to v5.0.0 (pingcap#5533)
Browse files Browse the repository at this point in the history
  • Loading branch information
CharLotteiu authored Apr 30, 2021
1 parent a7a9492 commit 84b484f
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 26 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Welcome to TiDB documentation!

This repository stores all the source files of [TiDB Docs at the PingCAP website](https://docs.pingcap.com/tidb/v4.0), while the [pingcap/docs-cn](https://github.com/pingcap/docs-cn) repository stores all the source files of [TiDB Documentation in Chinese](https://docs.pingcap.com/zh/tidb/v4.0).
This repository stores all the source files of [TiDB Docs at the PingCAP website](https://docs.pingcap.com/tidb/stable), while the [pingcap/docs-cn](https://github.com/pingcap/docs-cn) repository stores all the source files of [TiDB Documentation in Chinese](https://docs.pingcap.com/zh/tidb/stable).

If you find documentation issues, feel free to [create an Issue](https://github.com/pingcap/docs/issues/new/choose) to let us know or directly [create a Pull Request](/CONTRIBUTING.md#how-to-contribute) to help fix or update it.

Expand All @@ -24,6 +24,7 @@ Currently, we maintain the following versions of TiDB documentation in different
| Branch name | TiDB docs version |
| :---------|:----------|
| [`master`](https://github.com/pingcap/docs/tree/master) | The latest development version |
| [`release-5.0`](https://github.com/pingcap/docs/tree/release-5.0) | 5.0 stable version |
| [`release-4.0`](https://github.com/pingcap/docs/tree/release-4.0) | 4.0 stable version |
| [`release-3.1`](https://github.com/pingcap/docs/tree/release-3.1) | 3.1 stable version |
| [`release-3.0`](https://github.com/pingcap/docs/tree/release-3.0) | 3.0 stable version |
Expand Down
10 changes: 5 additions & 5 deletions download-ecosystem-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you want to download the latest version of [TiDB Binlog](/tidb-binlog/tidb-bi

> **Note:**
>
> `{version}` in the above download link indicates the version number of TiDB. For example, the download link for `v4.0.8` is `https://download.pingcap.org/tidb-v4.0.8-linux-amd64.tar.gz`.
> `{version}` in the above download link indicates the version number of TiDB. For example, the download link for `v5.0.0` is `https://download.pingcap.org/tidb-v5.0.0-linux-amd64.tar.gz`.
## TiDB Lightning

Expand All @@ -30,7 +30,7 @@ Download [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) by using t

> **Note:**
>
> `{version}` in the above download link indicates the version number of TiDB Lightning. For example, the download link for `v4.0.8` is `https://download.pingcap.org/tidb-toolkit-v4.0.8-linux-amd64.tar.gz`.
> `{version}` in the above download link indicates the version number of TiDB Lightning. For example, the download link for `v5.0.0` is `https://download.pingcap.org/tidb-toolkit-v5.0.0-linux-amd64.tar.gz`.
## BR (backup and restore)

Expand All @@ -42,7 +42,7 @@ Download [BR](/br/backup-and-restore-tool.md) by using the download link in the

> **Note:**
>
> `{version}` in the above download link indicates the version number of BR. For example, the download link for `v4.0.8-beta` is `http://download.pingcap.org/tidb-toolkit-v4.0.8-beta-linux-amd64.tar.gz`.
> `{version}` in the above download link indicates the version number of BR. For example, the download link for `v5.0.0-beta` is `http://download.pingcap.org/tidb-toolkit-v5.0.0-beta-linux-amd64.tar.gz`.
## TiDB DM (Data Migration)

Expand All @@ -54,7 +54,7 @@ Download [DM](https://docs.pingcap.com/tidb-data-migration/v1.0/overview) by usi

> **Note:**
>
> `{version}` in the above download link indicates the version number of DM. For example, the download link for `v1.0.6` is `https://download.pingcap.org/dm-v1.0.6-linux-amd64.tar.gz`. You can check the published DM versions in the [DM Release](https://github.com/pingcap/dm/releases) page.
> `{version}` in the above download link indicates the version number of DM. For example, the download link for `v2.0.1` is `https://download.pingcap.org/dm-v2.0.1-linux-amd64.tar.gz`. You can check the published DM versions in the [DM Release](https://github.com/pingcap/dm/releases) page.
## Dumpling

Expand All @@ -66,7 +66,7 @@ Download [Dumpling](/dumpling-overview.md) from the links below:

> **Note:**
>
> The `{version}` in the download link is the version number of Dumpling. For example, the link for downloading the `v4.0.2` version of Dumpling is `https://download.pingcap.org/tidb-toolkit-v4.0.2-linux-amd64.tar.gz`. You can view the currently released versions in [Dumpling Releases](https://github.com/pingcap/dumpling/releases).
> The `{version}` in the download link is the version number of Dumpling. For example, the link for downloading the `v4.0.11` version of Dumpling is `https://download.pingcap.org/tidb-toolkit-v4.0.11-linux-amd64.tar.gz`. You can view the currently released versions in [Dumpling Releases](https://github.com/pingcap/dumpling/releases).
>
> Dumpling supports arm64 linux. You can replace `amd64` in the download link with `arm64`, which means the `arm64` version of Dumpling.
Expand Down
4 changes: 2 additions & 2 deletions maintain-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ When the cluster is in operation, if you need to modify the parameters of a comp

**Use `.` to represent the hierarchy of the configuration items**.

For more information on the configuration parameters of components, refer to [TiDB `config.toml.example`](https://github.com/pingcap/tidb/blob/v4.0.0-rc/config/config.toml.example), [TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/v4.0.0-rc/etc/config-template.toml), and [PD `config.toml.example`](https://github.com/pingcap/pd/blob/v4.0.0-rc/conf/config.toml).
For more information on the configuration parameters of components, refer to [TiDB `config.toml.example`](https://github.com/pingcap/tidb/blob/master/config/config.toml.example), [TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/master/etc/config-template.toml), and [PD `config.toml.example`](https://github.com/tikv/pd/blob/master/conf/config.toml).

3. Rolling update the configuration and restart the corresponding components by running the `reload` command:

Expand All @@ -125,7 +125,7 @@ When the cluster is in operation, if you need to modify the parameters of a comp

### Example

If you want to set the transaction size limit parameter (`txn-total-size-limit` in the [performance](https://github.com/pingcap/tidb/blob/v4.0.0-rc/config/config.toml.example) module) to `1G` in tidb-server, edit the configuration as follows:
If you want to set the transaction size limit parameter (`txn-total-size-limit` in the [performance](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) module) to `1G` in tidb-server, edit the configuration as follows:

```
server_configs:
Expand Down
4 changes: 2 additions & 2 deletions pd-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you want to download the latest version of `pd-ctl`, directly download the Ti

> **Note:**
>
> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v4.0.0-rc.2`, the package download link is `https://download.pingcap.org/tidb-v4.0.0-rc.2-linux-amd64.tar.gz`. You can also download the latest unpublished version by replacing `{version}` with `latest`.
> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v5.0.0`, the package download link is `https://download.pingcap.org/tidb-v5.0.0-linux-amd64.tar.gz`.
### Compile from source code

Expand Down Expand Up @@ -179,7 +179,7 @@ Usage:
}

>> config show cluster-version // Display the current version of the cluster, which is the current minimum version of TiKV nodes in the cluster and does not correspond to the binary version.
"4.0.0"
"5.0.0"
```

- `max-snapshot-count` controls the maximum number of snapshots that a single store receives or sends out at the same time. The scheduler is restricted by this configuration to avoid taking up normal application resources. When you need to improve the speed of adding replicas or balancing, increase this value.
Expand Down
4 changes: 2 additions & 2 deletions pd-recover.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To download the latest version of PD Recover, directly download the TiDB package

> **Note:**
>
> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v4.0.0`, the package download link is `https://download.pingcap.org/tidb-v4.0.0-linux-amd64.tar.gz`. You can also download the latest unpublished version by replacing `{version}` with `latest`.
> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v5.0.0`, the package download link is `https://download.pingcap.org/tidb-v5.0.0-linux-amd64.tar.gz`.
## Quick Start

Expand Down Expand Up @@ -89,7 +89,7 @@ The allocated ID value you specify must be larger than the currently largest all
#### Get allocated ID from the monitor (recommended)

To get allocated ID from the monitor, you need to make sure that the metrics you are viewing are the metrics of **the last PD leader**, and you can get the largest allocated ID from the **Current ID allocation** panel in PD dashboard.

#### Get allocated ID from PD log

To get the allocated ID from the PD log, you need to make sure that the log you are viewing is the log of **the last PD leader**, and you can get the maximum allocated ID by running the following command:
Expand Down
8 changes: 4 additions & 4 deletions post-installation-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The following information indicates successful login:
```sql
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 3
Server version: 5.7.25-TiDB-v4.0.0 TiDB Server (Apache License 2.0) Community Edition, MySQL 5.7 compatible
Server version: 5.7.25-TiDB-v5.0.0 TiDB Server (Apache License 2.0) Community Edition, MySQL 5.7 compatible
Copyright (c) 2000, 2015, Oracle and/or its affiliates. All rights reserved.
Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
Expand All @@ -84,7 +84,7 @@ Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

```sql
*************************** 1. row ***************************
tidb_version(): Release Version: v4.0.0
tidb_version(): Release Version: v5.0.0
Edition: Community
Git Commit Hash: 689a6b6439ae7835947fcaccf329a3fc303986cb
Git Branch: HEAD
Expand Down Expand Up @@ -149,7 +149,7 @@ Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
{{< copyable "sql" >}}

```sql
insert into `tab_tidb` values (1,'TiDB',5,'TiDB-v4.0.0');
insert into `tab_tidb` values (1,'TiDB',5,'TiDB-v5.0.0');
```

Expected output:
Expand All @@ -172,7 +172,7 @@ Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
+----+------+-----+-------------+
| id | name | age | version |
+----+------+-----+-------------+
| 1 | TiDB | 5 | TiDB-v4.0.0 |
| 1 | TiDB | 5 | TiDB-v5.0.0 |
+----+------+-----+-------------+
1 row in set (0.00 sec)
```
Expand Down
2 changes: 1 addition & 1 deletion quick-start-with-tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
To view the dashboard: http://127.0.0.1:2379/dashboard
To view the monitor: http://127.0.0.1:9090
```

> **Note:**
>
> For the playground operated in this way, after the test is finished, TiUP will clean up the original cluster data. You will get a new cluster after re-running the command.
Expand Down
2 changes: 1 addition & 1 deletion scale-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ If you want to remove a TiKV node from the `10.0.1.5` host, take the following s
```
Starting /root/.tiup/components/cluster/v1.3.0/cluster display <cluster-name>
TiDB Cluster: <cluster-name>
TiDB Version: v4.0.0-rc
TiDB Version: v5.0.0
ID Role Host Ports Status Data Dir Deploy Dir
-- ---- ---- ----- ------ -------- ----------
10.0.1.3:8300 cdc 10.0.1.3 8300 Up - deploy/cdc-8300
Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,12 +373,12 @@ Global Flags:
-y, --yes Skip all confirmations and assumes 'yes'
```

For example, the following command upgrades the cluster to v5.0.0-rc:
For example, the following command upgrades the cluster to v5.0.0:

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

```bash
tiup cluster upgrade tidb-test v5.0.0-rc
tiup cluster upgrade tidb-test v5.0.0
```

## Update configuration
Expand Down
12 changes: 6 additions & 6 deletions tiup/tiup-component-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ Example 2: Use TiUP to install the nightly version of TiDB.
tiup install tidb:nightly
```

Example 3: Use TiUP to install TiKV v3.0.6.
Example 3: Use TiUP to install TiKV v5.0.0.

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

```shell
tiup install tikv:v3.0.6
tiup install tikv:v5.0.0
```

## Upgrade components
Expand Down Expand Up @@ -128,12 +128,12 @@ Before the component is started, TiUP creates a directory for it, and then puts

If you want to start the same component multiple times and reuse the previous working directory, you can use `--tag` to specify the same name when the component is started. After the tag is specified, the working directory will *not be automatically deleted* when the instance is terminated, which makes it convenient to reuse the working directory.

Example 1: Operate TiDB v3.0.8.
Example 1: Operate TiDB v5.0.0.

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

```shell
tiup tidb:v3.0.8
tiup tidb:v5.0.0
```

Example 2: Specify the tag with which TiKV operates.
Expand Down Expand Up @@ -219,12 +219,12 @@ The following flags are supported in this command:
- If the version is ignored, adding `--all` means to uninstall all versions of this component.
- If the version and the component are both ignored, adding `--all` means to uninstall all components of all versions.

Example 1: Uninstall TiDB v3.0.8.
Example 1: Uninstall TiDB v5.0.0.

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

```shell
tiup uninstall tidb:v3.0.8
tiup uninstall tidb:v5.0.0
```

Example 2: Uninstall TiKV of all versions.
Expand Down

0 comments on commit 84b484f

Please sign in to comment.