Skip to content

Commit eb3faa4

Browse files
authored
Change URL structure of how-to/get-started (pingcap#1046)
Changed URL structure of how-to/get-started. Fixed s/sample/example/ bug introduced in DITA fixed categories
1 parent e395b95 commit eb3faa4

8 files changed

+34
-32
lines changed

TOC.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@
2626
+ How-to
2727
+ Get Started
2828
+ Start a Local Cluster
29-
- [From Binary](op-guide/binary-local-deployment.md)
29+
- [From Binary](dev/how-to/get-started/local-cluster/install-from-binary.md)
3030
- [From Homebrew](dev/how-to/get-started/local-cluster/install-from-homebrew.md)
3131
- [From DBdeployer](dev/how-to/get-started/local-cluster/install-from-dbdeployer.md)
32-
- [In Kubernetes](op-guide/kubernetes-local.md)
33-
- [In Docker Compose](op-guide/docker-compose.md)
34-
- [Explore SQL with TiDB](try-tidb.md)
35-
- [Import Sample Database](bikeshare-example-database.md)
36-
- [Read Historical Data](op-guide/history-read.md)
32+
- [In Kubernetes](dev/how-to/get-started/local-cluster/install-from-kubernetes.md)
33+
- [In Docker Compose](dev/how-to/get-started/local-cluster/install-from-docker-compose.md)
34+
- [Explore SQL with TiDB](dev/how-to/get-started/explore-sql.md)
35+
- [Import Example Database](dev/how-to/get-started/import-example-database.md)
36+
- [Read Historical Data](dev/how-to/get-started/read-historical-data.md)
3737
- Deploy
3838
- [Hardware Recommendations](op-guide/recommendation.md)
3939
+ From Binary Tarball

try-tidb.md dev/how-to/get-started/explore-sql.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
2-
title: Try TiDB
2+
title: Explore SQL with TiDB
33
summary: Learn about the basic SQL statements for the TiDB database.
4-
category: try tidb
4+
category: how-to
5+
aliases: ['/docs/try-tidb']
56
---
67

7-
# Try TiDB
8+
# Explore SQL with TiDB
89

9-
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](/sql/mysql-compatibility.md).
1011

1112
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/).
1213

bikeshare-example-database.md dev/how-to/get-started/import-example-database.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: Bikeshare Example Database
2+
title: Import Example Database
33
summary: Install the Bikeshare example database.
4-
category: user guide
4+
category: how-to
5+
aliases: ['/docs/bikeshare-example-database/']
56
---
67

7-
# Bikeshare Example Database
8+
# Import Example Database
89

910
Examples used in the TiDB manual use [System Data](https://www.capitalbikeshare.com/system-data) from Capital Bikeshare, released under the [Capital Bikeshare Data License Agreement](https://www.capitalbikeshare.com/data-license-agreement).
1011

op-guide/binary-local-deployment.md dev/how-to/get-started/local-cluster/install-from-binary.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
22
title: Local Deployment from Binary Tarball
33
summary: Use the binary to deploy a TiDB cluster.
4-
category: operations
4+
category: how-to
5+
aliases: ['/docs/op-guide/binary-local-deployment/']
56
---
67

78
# Local Deployment from Binary Tarball
89

910
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.
1011

11-
See also [testing environment](../op-guide/binary-testing-deployment.md) and [production enviroment](../op-guide/binary-deployment.md) deployment.
12+
See also [testing environment](/op-guide/binary-testing-deployment.md) and [production enviroment](/op-guide/binary-deployment.md) deployment.
1213

1314
The following local TCP ports will be used:
1415

@@ -36,7 +37,7 @@ EOF
3637
sudo cp /tmp/tidb.conf /etc/security/limits.d/
3738
sudo sysctl -w fs.file-max=1000000
3839
```
39-
See the [production deployment](../op-guide/binary-deployment.md) optional kernel tuning parameters.
40+
See the [production deployment](/op-guide/binary-deployment.md) optional kernel tuning parameters.
4041

4142
### Create a database running user account
4243

dev/how-to/get-started/local-cluster/install-from-dbdeployer.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ category: how-to
88

99
DBdeployer is designed to allow multiple versions of TiDB deployed concurrently. It is recommended for advanced users who are testing out new builds of TiDB, or testing compatibility across releases.
1010

11-
Similar to [Homebrew](install-from-homebrew.md), the DBdeployer installation method installs the tidb-server **without** the tikv-server or pd-server. This is useful for development environments, since you can test your application's compatibility with TiDB without needing to deploy a full TiDB platform.
11+
Similar to [Homebrew](./install-from-homebrew.md), the DBdeployer installation method installs the tidb-server **without** the tikv-server or pd-server. This is useful for development environments, since you can test your application's compatibility with TiDB without needing to deploy a full TiDB platform.
1212

1313
> **Note**: Internally this installation uses goleveldb as the storage engine. It is much slower than TiKV, and any benchmarks will be unreliable.
1414
@@ -25,9 +25,7 @@ Similar to [Homebrew](install-from-homebrew.md), the DBdeployer installation met
2525
</label>
2626
<section id="MacOSContent">
2727

28-
After <a href="https://github.com/datacharmer/dbdeployer">installing DBdeployer</a>:
29-
30-
Install a MySQL 5.7 client:
28+
After <a href="https://github.com/datacharmer/dbdeployer">installing DBdeployer</a>, install a MySQL 5.7 client:
3129
<pre>
3230
curl -LO https://dev.mysql.com/get/Downloads/MySQL-5.7/mysql-5.7.25-macos10.14-x86_64.tar.gz
3331
dbdeployer unpack mysql-5.7.25-macos10.14-x86_64.tar.gz
@@ -43,9 +41,7 @@ dbdeployer deploy single 3.0.0 --client-from=5.7.25
4341
</section>
4442
<section id="LinuxContent">
4543

46-
After <a href="https://github.com/datacharmer/dbdeployer">installing DBdeployer</a>:
47-
48-
Install a MySQL 5.7 client:
44+
After <a href="https://github.com/datacharmer/dbdeployer">installing DBdeployer</a>, install a MySQL 5.7 client:
4945
<pre>
5046
dbdeployer remote get mysql-5.7.25
5147
dbdeployer unpack mysql-5.7.25.tar.xz
@@ -59,4 +55,4 @@ dbdeployer deploy single 3.0.0 --client-from=5.7.25
5955
</pre>
6056

6157
</section>
62-
</main>
58+
</main>

op-guide/docker-compose.md dev/how-to/get-started/local-cluster/install-from-docker-compose.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: TiDB Docker Compose Deployment
33
summary: Use Docker Compose to quickly deploy a TiDB testing cluster.
4-
category: operations
4+
category: how-to
5+
aliases: ['/docs/op-guide/docker-compose/']
56
---
67

78
# TiDB Docker Compose Deployment
@@ -173,6 +174,6 @@ docker-compose exec tispark-master /opt/spark/bin/pyspark
173174
docker-compose exec tispark-master /opt/spark/bin/sparkR
174175
```
175176
176-
For more details about TiSpark, see [here](../tispark/tispark-quick-start-guide.md).
177+
For more details about TiSpark, see [here](/tispark/tispark-quick-start-guide.md).
177178
178-
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.
179+
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.

op-guide/kubernetes-local.md dev/how-to/get-started/local-cluster/install-from-kubernetes.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: Deploy TiDB to Kubernetes Locally
33
summary: Use TiDB Operator to quickly deploy a TiDB cluster on Kubernetes
4-
category: operations
4+
category: how-to
5+
aliases: ['/docs/op-guide/kubernetes-local/']
56
---
67

78
# Deploy TiDB to Kubernetes Locally

op-guide/history-read.md dev/how-to/get-started/read-historical-data.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: Reading Data from History Versions
2+
title: Read Historical Data
33
summary: Learn about how TiDB reads data from history versions.
4-
category: advanced
4+
category: how-to
5+
aliases: ['/docs/op-guide/history-read/']
56
---
67

7-
# Reading Data From History Versions
8+
# Read Historical Data
89

910
This document describes how TiDB reads data from the history versions, how TiDB manages the data versions, as well as an example to show how to use the feature.
1011

@@ -33,7 +34,7 @@ After reading data from history versions, you can read data from the latest vers
3334

3435
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.
3536

36-
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)
37+
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)
3738

3839
Pay special attention to the following two variables:
3940

0 commit comments

Comments
 (0)