Skip to content

Commit fa30e95

Browse files
lilin90yikeketi-srebot
authored
*: update links from stable to v4.0 and new docs urls (pingcap#3022)
Co-authored-by: Keke Yi <[email protected]> Co-authored-by: ti-srebot <[email protected]>
1 parent 7a30f0a commit fa30e95

17 files changed

+31
-31
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Welcome to [TiDB](https://github.com/pingcap/tidb) documentation! We are excited
44

55
## What you can contribute
66

7-
You can start from any one of the following items to help improve [TiDB Docs at the PingCAP website](https://pingcap.com/docs/stable/):
7+
You can start from any one of the following items to help improve [TiDB Docs at the PingCAP website](https://docs.pingcap.com/tidb/v4.0):
88

99
- Fix typos or format (punctuation, space, indentation, code block, etc.)
1010
- Fix or update inappropriate or outdated descriptions
@@ -34,8 +34,8 @@ Currently, we maintain four versions of TiDB documentation, each with a separate
3434
| Docs branch name | Version description |
3535
| :--- | :--- |
3636
| `master` branch | the latest development version |
37-
| `release-4.0` branch | the 4.0 Beta version |
38-
| `release-3.1` branch | the 3.1 RC version |
37+
| `release-4.0` branch | the 4.0 stable version |
38+
| `release-3.1` branch | the 3.1 stable version |
3939
| `release-3.0` branch | the 3.0 stable version |
4040
| `release-2.1` branch | the 2.1 stable version |
4141

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Welcome to TiDB documentation!
44

5-
This repository stores all the source files of [TiDB Docs at the PingCAP website](https://pingcap.com/docs/stable/), while the [pingcap/docs-cn](https://github.com/pingcap/docs-cn) repository stores all the source files of [TiDB Documentation in Chinese](https://pingcap.com/docs-cn/stable/).
5+
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).
66

77
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.
88

@@ -13,7 +13,7 @@ Currently, we maintain the following versions of TiDB documentation in different
1313
| Branch name | TiDB docs version |
1414
| :---------|:----------|
1515
| [`master`](https://github.com/pingcap/docs/tree/master) | The latest development version |
16-
| [`release-4.0`](https://github.com/pingcap/docs/tree/release-4.0) | 4.0 RC version |
16+
| [`release-4.0`](https://github.com/pingcap/docs/tree/release-4.0) | 4.0 stable version |
1717
| [`release-3.1`](https://github.com/pingcap/docs/tree/release-3.1) | 3.1 stable version |
1818
| [`release-3.0`](https://github.com/pingcap/docs/tree/release-3.0) | 3.0 stable version |
1919
| [`release-2.1`](https://github.com/pingcap/docs/tree/release-2.1) | 2.1 stable version |

TOC.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@
5454
+ Upgrade
5555
+ [Use TiUP (Recommended)](/upgrade-tidb-using-tiup.md)
5656
+ [Use TiUP Offline (Recommended)](/upgrade-tidb-using-tiup-offline.md)
57-
+ [Use TiDB Operator](https://pingcap.com/docs/tidb-in-kubernetes/stable/upgrade-a-tidb-cluster/)
57+
+ [Use TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/upgrade-a-tidb-cluster)
5858
+ [Use TiDB Ansible](/upgrade-tidb-using-ansible.md)
5959
+ Scale
6060
+ [Use TiUP (Recommended)](/scale-tidb-using-tiup.md)
6161
+ [Use TiDB Ansible](/scale-tidb-using-ansible.md)
62-
+ [Use TiDB Operator](https://pingcap.com/docs/tidb-in-kubernetes/stable/scale-a-tidb-cluster/)
62+
+ [Use TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/scale-a-tidb-cluster)
6363
+ Backup and Restore
6464
+ [Use Mydumper and TiDB Lightning](/backup-and-restore-using-mydumper-lightning.md)
6565
+ [Use Dumpling for Export or Backup](/export-or-backup-using-dumpling.md)

_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ category: introduction
3434
- [Check Environment and Configuration](/check-before-deployment.md)
3535
- [Deploy a TiDB Cluster Using TiUP](/production-deployment-using-tiup.md)
3636
- [Use TiFlash for Analytical Processing](/tiflash/use-tiflash.md)
37-
- [Deploy TiDB in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/)
37+
- [Deploy TiDB in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/v1.1)
3838

3939
</NavColumn>
4040

architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ category: introduction
66

77
# TiDB Architecture
88

9-
The TiDB platform is comprised of three key components: the TiDB server, the PD server, and the TiKV server. In addition, TiDB also provides the [TiSpark](https://github.com/pingcap/tispark/) component for complex OLAP requirements and the [TiDB Operator](https://pingcap.com/docs/tidb-in-kubernetes/stable/tidb-operator-overview/) to make things simpler for the deployment and management on cloud.
9+
The TiDB platform is comprised of three key components: the TiDB server, the PD server, and the TiKV server. In addition, TiDB also provides the [TiSpark](https://github.com/pingcap/tispark/) component for complex OLAP requirements and the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/tidb-operator-overview) to make things simpler for the deployment and management on cloud.
1010

1111
![image alt text](/media/tidb-architecture.png)
1212

br/backup-and-restore-use-cases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ aliases: ['/docs/dev/reference/tools/br/use-cases/']
2020
2121
## Audience
2222

23-
You are expected to have a basic understanding of [TiDB](https://pingcap.com/docs/stable/) and [TiKV](https://tikv.org/). Before reading this document, it is recommended that you read [Use BR to Back up and Restore Data](/br/backup-and-restore-tool.md) first.
23+
You are expected to have a basic understanding of [TiDB](https://docs.pingcap.com/tidb/v4.0) and [TiKV](https://tikv.org/). Before reading this document, it is recommended that you read [Use BR to Back up and Restore Data](/br/backup-and-restore-tool.md) first.
2424

2525
## Prerequisites
2626

dashboard/dashboard-ops-deploy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ See the following documents to learn how to deploy a standard TiDB cluster:
1212

1313
+ [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md#deploy-a-local-test-environment-using-tiup-playground)
1414
+ [Deploy TiDB in Production Environment](/production-deployment-using-tiup.md)
15-
+ [Kubernetes environment deployment](https://pingcap.com/docs/tidb-in-kubernetes/stable/access-dashboard/)
15+
+ [Kubernetes environment deployment](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/access-dashboard)
1616

1717
> **Note:**
1818
>

deploy-test-cluster-using-docker-compose.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ With Docker Compose, you can use a YAML file to configure application services i
1313

1414
> **Warning:**
1515
>
16-
> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production.
16+
> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-tidb-operator) in production.
1717
1818
## Prerequisites
1919

download-ecosystem-tools.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Download [BR](/br/backup-and-restore-tool.md) by using the download link in the
5050
5151
## TiDB DM (Data Migration)
5252

53-
Download [DM](https://pingcap.com/docs/tidb-data-migration/stable/overview/) by using the download link in the following table:
53+
Download [DM](https://docs.pingcap.com/tidb-data-migration/v1.0/overview) by using the download link in the following table:
5454

5555
| Package name | OS | Architecture | SHA256 checksum |
5656
|:---|:---|:---|:---|

ecosystem-tool-user-case.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you need to import full data from MySQL or Aurora, use [Dumpling](/export-or-
1818

1919
## Migrate data from MySQL/Aurora
2020

21-
If you need to migrate both full data and incremental data from MySQL/Aurora, use [TiDB Data Migration](https://pingcap.com/docs/tidb-data-migration/stable/overview/) (DM) to perform the full and incremental data migration.
21+
If you need to migrate both full data and incremental data from MySQL/Aurora, use [TiDB Data Migration](https://docs.pingcap.com/tidb-data-migration/v1.0/overview) (DM) to perform the full and incremental data migration.
2222

2323
If the full data volume is large (at the TB level), you can first use [Dumpling](/export-or-backup-using-dumpling.md) and [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) to perform the full data migration, and then use DM to perform the incremental data migration.
2424

ecosystem-tool-user-guide.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The following are the basics of TiDB Lightning:
3434
- The output file of Dumpling
3535
- Other compatible CSV file
3636
- Supported TiDB versions: v2.1 or later
37-
- Kubernetes support: Yes. See [Quickly restore data into a TiDB cluster in Kubernetes using TiDB Lightning](https://pingcap.com/docs/tidb-in-kubernetes/stable/restore-data-using-tidb-lightning/) for details.
37+
- Kubernetes support: Yes. See [Quickly restore data into a TiDB cluster in Kubernetes using TiDB Lightning](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/restore-data-using-tidb-lightning) for details.
3838

3939
> **Note:**
4040
>
@@ -48,7 +48,7 @@ The following are the basics of BR:
4848

4949
- [Input and output data source](/br/backup-and-restore-tool.md#types-of-backup-files): SST + `backupmeta` file
5050
- Supported TiDB versions: v3.1 and v4.0
51-
- Kubernetes support: Yes. See [Back up Data to S3-Compatible Storage Using BR](https://pingcap.com/docs/tidb-in-kubernetes/stable/backup-to-aws-s3-using-br/) and [Restore Data from S3-Compatible Storage Using BR](https://pingcap.com/docs/tidb-in-kubernetes/stable/restore-from-aws-s3-using-br/) for details.
51+
- Kubernetes support: Yes. See [Back up Data to S3-Compatible Storage Using BR](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/backup-to-aws-s3-using-br) and [Restore Data from S3-Compatible Storage Using BR](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/restore-from-aws-s3-using-br) for details.
5252

5353
## Incremental data replication
5454

@@ -60,11 +60,11 @@ The following are the basics of TiDB Binlog:
6060
- Input: TiDB cluster
6161
- Output: TiDB cluster, MySQL, Kafka or incremental backup files
6262
- Supported TiDB versions: v2.1 or later
63-
- Kubernetes support: Yes. See [TiDB Binlog Cluster Operations](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-binlog/) and [TiDB Binlog Drainer Configurations in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/configure-tidb-binlog-drainer/) for details.
63+
- Kubernetes support: Yes. See [TiDB Binlog Cluster Operations](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-tidb-binlog) and [TiDB Binlog Drainer Configurations in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/configure-tidb-binlog-drainer) for details.
6464

6565
### Data migration
6666

67-
[TiDB Data Migration](https://pingcap.com/docs/tidb-data-migration/stable/) (DM) is an integrated data replication task management platform that supports the full data migration and the incremental data migration from MySQL/MariaDB to TiDB.
67+
[TiDB Data Migration](https://docs.pingcap.com/tidb-data-migration/v1.0) (DM) is an integrated data replication task management platform that supports the full data migration and the incremental data migration from MySQL/MariaDB to TiDB.
6868

6969
The following are the basics of DM:
7070

load-misuse-handling.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ aliases: ['/docs/dev/reference/tools/error-case-handling/load-misuse-handling/']
66

77
# Common Misuses During Full Data Import
88

9-
This document introduces the common error scenarios in using [Loader](/loader-overview.md) or [TiDB Data Migration](https://pingcap.com/docs/tidb-data-migration/stable/overview/) (DM) during the full data import process, and also provides their reasons and solutions.
9+
This document introduces the common error scenarios in using [Loader](/loader-overview.md) or [TiDB Data Migration](https://docs.pingcap.com/tidb-data-migration/v1.0/overview) (DM) during the full data import process, and also provides their reasons and solutions.
1010

1111
## Error: ```Try adjusting the `max_allowed_packet` variable```
1212

migrate-from-aurora-mysql-database.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Assuming that you want to migrate data from two Aurora clusters to TiDB, the inf
1919
| Aurora-1 | pingcap-1-us-east-2a.h8emfqdptyc4.us-east-2.rds.amazonaws.com | 3306 | Reader |
2020
| Aurora-2 | pingcap-2.h8emfqdptyc4.us-east-2.rds.amazonaws.com | 3306 | Writer |
2121

22-
DM relies on the `ROW` format of binlog during the incremental replication process, so you need to set the binlog format as `ROW`. If binlog is not enabled or is incorrectly configured, DM cannot replicate data normally. For more details, see [Checking items](https://pingcap.com/docs/tidb-data-migration/stable/precheck/#checking-items).
22+
DM relies on the `ROW` format of binlog during the incremental replication process, so you need to set the binlog format as `ROW`. If binlog is not enabled or is incorrectly configured, DM cannot replicate data normally. For more details, see [Checking items](https://docs.pingcap.com/tidb-data-migration/v1.0/precheck#checking-items).
2323

2424
> **Note:**
2525
>
@@ -43,11 +43,11 @@ To migrate data based on GTID, set both `gtid-mode` and `enforce_gtid_consistenc
4343
4444
## Step 2: Deploy the DM cluster
4545

46-
It is recommended to use DM-Ansible to deploy a DM cluster. See [Deploy Data Migration Using DM-Ansible](https://pingcap.com/docs/tidb-data-migration/stable/deploy-a-dm-cluster-using-ansible/).
46+
It is recommended to use DM-Ansible to deploy a DM cluster. See [Deploy Data Migration Using DM-Ansible](https://docs.pingcap.com/tidb-data-migration/v1.0/deploy-a-dm-cluster-using-ansible).
4747

4848
> **Note:**
4949
>
50-
> - Use password encrypted with dmctl in all the DM configuration files. If the database password is empty, it is unnecessary to encrypt it. For how to use dmctl to encrypt a cleartext password, see [Encrypt the upstream MySQL user password using dmctl](https://pingcap.com/docs/tidb-data-migration/stable/deploy-a-dm-cluster-using-ansible/#encrypt-the-upstream-mysql-user-password-using-dmctl).
50+
> - Use password encrypted with dmctl in all the DM configuration files. If the database password is empty, it is unnecessary to encrypt it. For how to use dmctl to encrypt a cleartext password, see [Encrypt the upstream MySQL user password using dmctl](https://docs.pingcap.com/tidb-data-migration/v1.0/deploy-a-dm-cluster-using-ansible#encrypt-the-upstream-mysql-user-password-using-dmctl).
5151
> - Both the upstream and downstream users must have the corresponding read and write privileges.
5252
5353
## Step 3: Check the cluster informtaion

overview.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ TiDB can be deployed on-premise or in-cloud. The following deployment options ar
1717

1818
You can use [TiDB Operator](https://github.com/pingcap/tidb-operator) to deploy TiDB on:
1919

20-
- [AWS EKS (Elastic Kubernetes Service)](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-on-aws-eks/)
21-
- [GKE (Google Kubernetes Engine)](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-on-gcp-gke/)
22-
- [Google Cloud Shell](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-gke/)
23-
- [Alibaba Cloud ACK (Container Service for Kubernetes)](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-on-alibaba-cloud/)
20+
- [AWS EKS (Elastic Kubernetes Service)](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-on-aws-eks)
21+
- [GKE (Google Kubernetes Engine)](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-on-gcp-gke)
22+
- [Google Cloud Shell](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-tidb-from-kubernetes-gke)
23+
- [Alibaba Cloud ACK (Container Service for Kubernetes)](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-on-alibaba-cloud)
2424

2525
Or deploy TiDB locally using:
2626

27-
- [kind](https://pingcap.com/docs/tidb-in-kubernetes/stable/get-started/#create-a-kubernetes-cluster-using-kind)
28-
- [Minikube](https://pingcap.com/docs/tidb-in-kubernetes/stable/get-started/#create-a-kubernetes-cluster-using-minikube)
27+
- [kind](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/get-started#create-a-kubernetes-cluster-using-kind)
28+
- [Minikube](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/get-started#create-a-kubernetes-cluster-using-minikube)
2929

3030
- [Binary Tarball Deployment](/production-deployment-from-binary-tarball.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/deploy-tidb-from-binary.md) and [testing](/test-deployment-from-binary-tarball.md) environments are also available.
3131

quick-start-with-tidb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -315,4 +315,4 @@ Click to try TiDB-Wasm playground: <https://tour.tidb.io>. It takes about 10 sec
315315
316316
- [Deploy TiDB online using TiUP](/production-deployment-using-tiup.md)
317317
- [Deploy TiDB offline using TiUP](/production-offline-deployment-using-tiup.md)
318-
- [Deploy TiDB on Cloud using TiDB Operator](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/)
318+
- [Deploy TiDB on Cloud using TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/v1.1)

test-deployment-using-docker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To learn more, see [TiDB architecture](/architecture.md) and [Software and Hardw
1313

1414
> **Warning:**
1515
>
16-
> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production.
16+
> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-tidb-operator) in production.
1717
1818
## Preparation
1919

tidb-troubleshooting-map.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ Check the specific cause for busy by viewing the monitor **Grafana** -> **TiKV**
456456
- 6.2.2 `Access denied for user 'root'@'172.31.43.27' (using password: YES)` shows when you run `query status` or check the log.
457457

458458
- The database related passwords in all the DM configuration files must be encrypted by `dmctl`. If a database password is empty, it is unnecessary to encrypt the password.
459-
- During DM operation, the user of the upstream and downstream databases must have the corresponding read and write privileges. Data Migration also [prechecks the corresponding privileges](https://pingcap.com/docs/tidb-data-migration/stable/precheck/) automatically while starting the data replication task.
459+
- During DM operation, the user of the upstream and downstream databases must have the corresponding read and write privileges. Data Migration also [prechecks the corresponding privileges](https://docs.pingcap.com/tidb-data-migration/v1.0/precheck) automatically while starting the data replication task.
460460
- To deploy different versions of DM-worker/DM-master/dmctl in a DM cluster, see the [case study on AskTUG](https://asktug.com/t/dm1-0-0-ga-access-denied-for-user/1049/5) in Chinese.
461461

462462
- 6.2.3 A replication task is interrupted with the `driver: bad connection` error returned.

0 commit comments

Comments
 (0)