Skip to content

Commit ecf0287

Browse files
kolbemorgo
authored andcommitted
Updated URLs for DITA (pingcap#1137)
* Updated URLs for DITA
1 parent 0234253 commit ecf0287

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+125
-125
lines changed

Diff for: dev/how-to/deploy/data-migration-with-ansible.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ You can choose one of the following two types of cluster topology according to y
193193

194194
- [The cluster topology of multiple DM-worker instances on each node](#option-2-use-the-cluster-topology-of-multiple-dm-worker-instances-on-each-node)
195195

196-
Generally, it is recommended to deploy one DM-worker instance on each node. However, if the CPU and memory of your machine are much better than the required in [Hardware and Software Requirements](/op-guide/recommendation.md), and you have more than 2 disks in one node or the capacity of one SSD is larger than 2 TB, you can deploy no more than 2 DM-worker instances on a single node.
196+
Generally, it is recommended to deploy one DM-worker instance on each node. However, if the CPU and memory of your machine are much better than the required in [Hardware and Software Requirements](/dev/how-to/deploy/hardware-recommendations.md), and you have more than 2 disks in one node or the capacity of one SSD is larger than 2 TB, you can deploy no more than 2 DM-worker instances on a single node.
197197

198198
### Option 1: Use the cluster topology of a single DM-worker instance on each node
199199

Diff for: dev/how-to/deploy/from-tarball/production-environment.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ Follow the steps below to start PD, TiKV, and TiDB:
202202
> **Note:**
203203
>
204204
> - If you start TiKV or deploy PD in the production environment, it is highly recommended to specify the path for the configuration file using the `--config` parameter. If the parameter is not set, TiKV or PD does not read the configuration file.
205-
> - To tune TiKV, see [Performance Tuning for TiKV](/op-guide/tune-tikv.md).
206-
> - If you use `nohup` to start the cluster in the production environment, write the startup commands in a script and then run the script. If not, the `nohup` process might abort because it receives exceptions when the Shell command exits. For more information, see [The TiDB/TiKV/PD process aborts unexpectedly](/trouble-shooting.md#the-tidbtikvpd-process-aborts-unexpectedly).
205+
> - To tune TiKV, see [Performance Tuning for TiKV](/dev/reference/performance/tune-tikv.md).
206+
> - If you use `nohup` to start the cluster in the production environment, write the startup commands in a script and then run the script. If not, the `nohup` process might abort because it receives exceptions when the Shell command exits. For more information, see [The TiDB/TiKV/PD process aborts unexpectedly](/dev/how-to/troubleshoot/cluster-setup.md#the-tidbtikvpd-process-aborts-unexpectedly).
207207
208-
For the deployment and use of TiDB monitoring services, see [Monitor a TiDB Cluster](/op-guide/monitor.md).
208+
For the deployment and use of TiDB monitoring services, see [Monitor a TiDB Cluster](/dev/how-to/monitor/monitor-a-cluster.md).

Diff for: dev/how-to/deploy/orchestrated/ansible.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ You can use the TiDB-Ansible configuration file to set up the cluster topology a
2121
- Deploy the whole TiDB cluster
2222
- [Start the TiDB cluster](/dev/how-to/deploy/orchestrated/ansible-operations.md#start-a-cluster)
2323
- [Stop the TiDB cluster](/dev/how-to/deploy/orchestrated/ansible-operations.md#stop-a-cluster)
24-
- [Modify component configuration](/op-guide/ansible-deployment-rolling-update.md#modify-component-configuration)
25-
- [Scale the TiDB cluster](/op-guide/ansible-deployment-scale.md)
26-
- [Upgrade the component version](/op-guide/ansible-deployment-rolling-update.md#upgrade-the-component-version)
27-
- [Enable the cluster binlog](/tools/tidb-binlog-cluster.md)
24+
- [Modify component configuration](/dev/how-to/maintain/upgrade/rolling-updates-with-ansible.md#modify-component-configuration)
25+
- [Scale the TiDB cluster](/dev/how-to/maintain/scale/with-ansible.md)
26+
- [Upgrade the component version](/dev/how-to/upgrade/rolling-updates-with-ansible.md#upgrade-the-component-version)
27+
- [Enable the cluster binlog](/dev/reference/tools/tidb-binlog/overview.md)
2828
- [Clean up data of the TiDB cluster](/dev/how-to/deploy/orchestrated/ansible-operations.md#clean-up-cluster-data)
2929
- [Destroy the TiDB cluster](/dev/how-to/deploy/orchestrated/ansible-operations.md#destroy-a-cluster)
3030

@@ -539,7 +539,7 @@ To enable the following control variables, use the capitalized `True`. To disabl
539539
| cluster_name | the name of a cluster, adjustable |
540540
| tidb_version | the version of TiDB, configured by default in TiDB-Ansible branches |
541541
| process_supervision | the supervision way of processes, systemd by default, supervise optional |
542-
| timezone | the global default time zone configured when a new TiDB cluster bootstrap is initialized; you can edit it later using the global `time_zone` system variable and the session `time_zone` system variable as described in [Time Zone Support](/sql/time-zone.md); the default value is `Asia/Shanghai` and see [the list of time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for more optional values |
542+
| timezone | the global default time zone configured when a new TiDB cluster bootstrap is initialized; you can edit it later using the global `time_zone` system variable and the session `time_zone` system variable as described in [Time Zone Support](/dev/how-to/configure/time-zone.md); the default value is `Asia/Shanghai` and see [the list of time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for more optional values |
543543
| enable_firewalld | to enable the firewall, closed by default; to enable it, add the ports in [network requirements](/dev/how-to/deploy/hardware-recommendations.md#network-requirements) to the white list |
544544
| enable_ntpd | to monitor the NTP service of the managed node, True by default; do not close it |
545545
| set_hostname | to edit the hostname of the managed node based on the IP, False by default |

Diff for: dev/how-to/deploy/tispark.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases: ['/docs/tispark/tispark-quick-start-guide/']
77

88
# TiSpark Quick Start Guide
99

10-
To make it easy to [try TiSpark](/tispark/tispark-user-guide.md), the TiDB cluster installed using TiDB-Ansible integrates Spark, TiSpark jar package and TiSpark sample data by default.
10+
To make it easy to [try TiSpark](/dev/reference/tispark.md), the TiDB cluster installed using TiDB-Ansible integrates Spark, TiSpark jar package and TiSpark sample data by default.
1111

1212
## Deployment information
1313

Diff for: dev/how-to/get-started/explore-sql.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases: ['/docs/try-tidb']
77

88
# Explore SQL with TiDB
99

10-
After you successfully deploy a TiDB cluster, you can run SQL statements in TiDB. Because TiDB is compatible with MySQL, you can use THE MySQL client to connect to TiDB and run MySQL statements directly in most of the cases. For more information, see [Compatibility with MySQL](/sql/mysql-compatibility.md).
10+
After you successfully deploy a TiDB cluster, you can run SQL statements in TiDB. Because TiDB is compatible with MySQL, you can use THE MySQL client to connect to TiDB and run MySQL statements directly in most of the cases. For more information, see [Compatibility with MySQL](/dev/reference/mysql-compatibility.md).
1111

1212
This page includes some basic SQL statements such as CRUD operations. For a complete list of the statements, see [TiDB SQL Syntax Diagram](https://pingcap.github.io/sqlgram/).
1313

Diff for: dev/how-to/get-started/local-cluster/install-from-binary.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ aliases: ['/docs/op-guide/binary-local-deployment/']
99

1010
This guide provides installation instructions for all TiDB components on a single developer machine. It is intended for evaluation purposes, and does not match the recommended usage for production systems.
1111

12-
See also [testing environment](/op-guide/binary-testing-deployment.md) and [production enviroment](/op-guide/binary-deployment.md) deployment.
12+
See also [testing environment](/dev/how-to/deploy/from-tarball/testing-environment.md) and [production enviroment](/dev/how-to/deploy/from-tarball/production-environment.md) deployment.
1313

1414
The following local TCP ports will be used:
1515

@@ -37,7 +37,7 @@ EOF
3737
sudo cp /tmp/tidb.conf /etc/security/limits.d/
3838
sudo sysctl -w fs.file-max=1000000
3939
```
40-
See the [production deployment](/op-guide/binary-deployment.md) optional kernel tuning parameters.
40+
See the [production deployment](/dev/how-to/deploy/from-tarball/production-environment.md) optional kernel tuning parameters.
4141

4242
### Create a database running user account
4343

Diff for: dev/how-to/get-started/local-cluster/install-from-docker-compose.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,6 @@ docker-compose exec tispark-master /opt/spark/bin/pyspark
174174
docker-compose exec tispark-master /opt/spark/bin/sparkR
175175
```
176176
177-
For more details about TiSpark, see [here](/tispark/tispark-quick-start-guide.md).
177+
For more details about TiSpark, see [here](/dev/how-to/deploy/tispark.md).
178178
179179
Here is [a 5-minute tutorial](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) for macOS users that shows how to spin up a standard TiDB cluster using Docker Compose on your local computer.

Diff for: dev/how-to/get-started/read-historical-data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ After reading data from history versions, you can read data from the latest vers
3636

3737
TiDB implements Multi-Version Concurrency Control (MVCC) to manage data versions. The history versions of data are kept because each update/removal creates a new version of the data object instead of updating/removing the data object in-place. But not all the versions are kept. If the versions are older than a specific time, they will be removed completely to reduce the storage occupancy and the performance overhead caused by too many history versions.
3838

39-
In TiDB, Garbage Collection (GC) runs periodically to remove the obsolete data versions. For GC details, see [TiDB Garbage Collection (GC)](/op-guide/gc.md)
39+
In TiDB, Garbage Collection (GC) runs periodically to remove the obsolete data versions. For GC details, see [TiDB Garbage Collection (GC)](/dev/reference/garbage-collection.md)
4040

4141
Pay special attention to the following two variables:
4242

Diff for: dev/how-to/maintain/backup-and-restore.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ cd tidb-enterprise-tools-latest-linux-amd64
3939

4040
## Full backup and restoration using `mydumper`/`loader`
4141

42-
You can use [`mydumper`](/tools/mydumper.md) to export data from MySQL and [`loader`](/tools/loader.md) to import the data into TiDB.
42+
You can use [`mydumper`](/dev/reference/tools/mydumper.md) to export data from MySQL and [`loader`](/dev/reference/tools/loader.md) to import the data into TiDB.
4343

4444
> **Important**: You must use the `mydumper` from the Enterprise Tools package, and not the `mydumper` provided by your operating system's package manager. The upstream version of `mydumper` does not yet handle TiDB correctly ([#155](https://github.com/maxbube/mydumper/pull/155)). Using `mysqldump` is also not recommended, as it is much slower for both backup and restoration.
4545
@@ -84,7 +84,7 @@ In this command,
8484

8585
### Restore data into TiDB
8686

87-
To restore data into TiDB, use `loader` to import the previously exported data. See [Loader instructions](/tools/loader.md) for more information.
87+
To restore data into TiDB, use `loader` to import the previously exported data. See [Loader instructions](/dev/reference/tools/loader.md) for more information.
8888

8989
```bash
9090
./bin/loader -h 127.0.0.1 -u root -P 4000 -t 32 -d ./var/test

Diff for: dev/how-to/maintain/identify-slow-queries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ select * from t_slim, t_wide where t_slim.c0=t_wide.c0;
5555
* `Is_internal`: Whether the SQL statement is TiDB internal. `true` indicates that the SQL statement is executed internally in TiDB, such as Analyze, load variables, etc.; `false` indicates the SQL statement is executed by the user.
5656
* `Digest`: The fingerprint of the SQL statement.
5757
* `Memory_max`: Indicates the maximum memory space used during the execution period of this SQL statement (the unit is byte).
58-
* `Num_cop_tasks`: The number of [cop-tasks](/sql/understanding-the-query-execution-plan.md).
58+
* `Num_cop_tasks`: The number of [cop-tasks](/dev/reference/performance/understanding-the-query-execution-plan.md).
5959
* `Cop_proc_avg`: The average execution time of cop-tasks.
6060
* `Cop_proc_p90`: The P90 execution time of cop-tasks.
6161
* `Cop_proc_max`: The maximum execution time of cop-tasks.

Diff for: dev/how-to/migrate/from-mysql.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ You can use `mydumper` to export data from MySQL and `loader` to import the data
1313

1414
> **Note:**
1515
>
16-
> Although TiDB also supports the official `mysqldump` tool from MySQL for data migration, it is not recommended to use it. Its performance is much lower than `mydumper` / `loader` and it takes much time to migrate large amounts of data. It is important to use the `mydumper` provided by TiDB and not the upstream `mydumper` version. See [mydumper](/tools/mydumper.md) for more information.
16+
> Although TiDB also supports the official `mysqldump` tool from MySQL for data migration, it is not recommended to use it. Its performance is much lower than `mydumper` / `loader` and it takes much time to migrate large amounts of data. It is important to use the `mydumper` provided by TiDB and not the upstream `mydumper` version. See [mydumper](/dev/reference/tools/mydumper.md) for more information.
1717
18-
`Mydumper` and `loader` can be [downloaded as part of Enterprise Tools](/tools/download.md).
18+
`Mydumper` and `loader` can be [downloaded as part of Enterprise Tools](/dev/reference/tools/download.md).
1919

2020
### Export data from MySQL
2121

@@ -38,7 +38,7 @@ In this command,
3838
3939
### Import data to TiDB
4040

41-
Use `loader` to import the data from MySQL to TiDB. See [Loader instructions](/tools/loader.md) for more information.
41+
Use `loader` to import the data from MySQL to TiDB. See [Loader instructions](/dev/reference/tools/loader.md) for more information.
4242

4343
```bash
4444
./bin/loader -h 127.0.0.1 -u root -P 4000 -t 32 -d ./var/test

Diff for: dev/how-to/migrate/incrementally-from-mysql.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ aliases: ['/docs/op-guide/migration-incremental/']
99

1010
The [previous guide](/dev/how-to/migrate/from-mysql.md) introduces how to import a full database from MySQL to TiDB using `mydumper`/`loader`. This methodology is not recommended for large databases with frequent updates, since it can lead to a larger downtime window during migration. It is instead recommended to use syncer.
1111

12-
Syncer can be [downloaded as part of Enterprise Tools](/tools/download.md).
12+
Syncer can be [downloaded as part of Enterprise Tools](/dev/reference/tools/download.md).
1313

1414
Assuming the data from `t1` and `t2` is already imported to TiDB using `mydumper`/`loader`. Now we hope that any updates to these two tables are synchronized to TiDB in real time.
1515

Diff for: dev/how-to/migrate/overview.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ This document describes scenarios for migrating data into TiDB from either MySQL
1313

1414
Migrations will often make use of the following tools. The following is a brief overview of their usage:
1515

16-
- [`mydumper`](/tools/mydumper.md) exports data from MySQL. It is recommended over using mysqldump.
17-
- [`loader`](/tools/loader.md) imports data in mydumper format into TiDB.
18-
- [`syncer`](/tools/syncer.md) acts like a MySQL replication slave and pushes data from MySQL into TiDB.
19-
- [DM](/tools/dm/overview.md) (Data Migration) integrates the functions of mydumper, Loader and syncer to support the export and import of full-size data, as well as incremental synchronization of MySQL Binlog data, and supports data synchronization of a more complete pooled table scenario.
20-
- [TiDB-Lightning](/tools/lightning/overview-architecture.md) imports data to TiDB in an optimized way. For example, a 1TiB backup could take 24+ hours to import with loader, while it will typically complete at least 3 times faster in TiDB-Lightning.
16+
- [`mydumper`](/dev/reference/tools/mydumper.md) exports data from MySQL. It is recommended over using mysqldump.
17+
- [`loader`](/dev/reference/tools/loader.md) imports data in mydumper format into TiDB.
18+
- [`syncer`](/dev/reference/tools/syncer.md) acts like a MySQL replication slave and pushes data from MySQL into TiDB.
19+
- [DM](/dev/reference/tools/data-migration/overview.md) (Data Migration) integrates the functions of mydumper, Loader and syncer to support the export and import of full-size data, as well as incremental synchronization of MySQL Binlog data, and supports data synchronization of a more complete pooled table scenario.
20+
- [TiDB-Lightning](/dev/reference/tools/tidb-lightning/overview.md) imports data to TiDB in an optimized way. For example, a 1TiB backup could take 24+ hours to import with loader, while it will typically complete at least 3 times faster in TiDB-Lightning.
2121

2222
## Scenarios
2323

@@ -54,4 +54,4 @@ To import data from another database, it is recommended to:
5454
- Export the data as CSV format.
5555
- Import the data using TiDB-Lightning.
5656

57-
For more information, refer to [CSV support for TiDB-Lightning](/tools/lightning/csv.md).
57+
For more information, refer to [CSV support for TiDB-Lightning](/dev/reference/tools/tidb-lightning/csv.md).

Diff for: dev/how-to/scale/horizontally.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ The capacity of a TiDB cluster can be increased or reduced without affecting onl
1313

1414
> **Note:**
1515
>
16-
> If your TiDB cluster is deployed using Ansible, see [Scale the TiDB Cluster Using TiDB-Ansible](../op-guide/ansible-deployment-scale.md).
16+
> If your TiDB cluster is deployed using Ansible, see [Scale the TiDB Cluster Using TiDB-Ansible](/dev/how-to/scale/with-ansible.md).
1717
1818
The following part shows you how to add or delete PD, TiKV or TiDB nodes.
1919

20-
About `pd-ctl` usage, refer to [PD Control User Guide](../tools/pd-control.md).
20+
About `pd-ctl` usage, refer to [PD Control User Guide](/dev/reference/tools/pd-control.md).
2121

2222
## PD
2323

Diff for: dev/how-to/troubleshoot/cluster-setup.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can use this guide to help you diagnose and solve basic problems while using
1515
- The configuration and deployment topology
1616
- The TiDB component related issue in `dmesg`
1717

18-
For other information, see [Frequently Asked Questions (FAQ)](/FAQ.md).
18+
For other information, see [Frequently Asked Questions (FAQ)](/faq/tidb.md).
1919

2020
## Cannot connect to the database
2121

@@ -39,7 +39,7 @@ For other information, see [Frequently Asked Questions (FAQ)](/FAQ.md).
3939
See the following for the situations when the `tidb-server` cannot be started:
4040

4141
- Error in the startup parameters.
42-
See the [TiDB configuration and options](op-guide/configuration.md#tidb).
42+
See the [TiDB configuration and options](/dev/reference/configuration/tidb-server/configuration.md).
4343
- The port is occupied.
4444
Use the `lsof -i:port` command to show all the networking related to a given port and make sure the port to start the `tidb-server` is not occupied.
4545
+ Cannot connect to `pd-server`.
@@ -51,7 +51,7 @@ See the following for the situations when the `tidb-server` cannot be started:
5151

5252
See the following for the situations when the `tikv-server` cannot be started:
5353

54-
- Error in the startup parameters: See the [TiKV configuration and options](op-guide/configuration.md#tikv).
54+
- Error in the startup parameters: See the [TiKV configuration and options](/dev/reference/configuration/tikv-server/configuration.md).
5555
- The port is occupied: Use the `lsof -i:port` command to show all the networking related to a given port and make sure the port to start the `tikv-server` is not occupied.
5656
+ Cannot connect to `pd-server`.
5757
- Check if the network between TiDB and PD is running smoothly, including whether the network can be pinged or if there is any issue with the Firewall configuration.
@@ -64,7 +64,7 @@ See the following for the situations when the `tikv-server` cannot be started:
6464
See the following for the situations when the `pd-server` cannot be started:
6565

6666
- Error in the startup parameters.
67-
See the [PD configuration and options](op-guide/configuration.md##placement-driver-pd).
67+
See the [PD configuration and options](/dev/reference/configuration/pd-server/configuration.md).
6868
- The port is occupied.
6969
Use the `lsof -i:port` command to show all the networking related to a given port and make sure the port to start the `pd-server` is not occupied.
7070

@@ -91,7 +91,7 @@ Before starting the process, make sure the result of `ulimit -n` is large enough
9191

9292
## Database access times out and the system load is too high
9393

94-
First, check the [SLOW-QUERY](/dev/how-to/maintain/identify-slow-queries.md) log and see if it is because of some inappropriate SQL statement.
94+
First, check the [slow query log](/dev/how-to/maintain/identify-slow-queries.md) and see if it is because of some inappropriate SQL statement.
9595
If you failed to solve the problem, provide the following information:
9696

9797
+ The deployment topology

0 commit comments

Comments
 (0)