Skip to content

Commit 04f3717

Browse files
authored
Add dev guide prefix (pingcap#9412)
1 parent acf1c7f commit 04f3717

File tree

48 files changed

+171
-156
lines changed

Some content is hidden

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

48 files changed

+171
-156
lines changed

.github/workflows/ci.yaml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,17 @@ name: ci
33
on: [pull_request]
44

55
jobs:
6-
76
pull:
87
runs-on: ubuntu-latest
98
steps:
10-
- name: Check out
11-
uses: actions/checkout@v3
12-
- uses: actions/setup-node@v3
13-
with:
14-
node-version: '14'
15-
- name: Verify internal links
16-
run: ./scripts/verify-links.sh
17-
- name: Verify internal link anchors
18-
run: ./scripts/verify-link-anchors.sh
9+
- name: Check out
10+
uses: actions/checkout@v3
11+
- uses: actions/setup-node@v3
12+
with:
13+
node-version: "14"
14+
- name: Verify duplicated file names
15+
run: ./scripts/verify-duplicated-file-name.sh
16+
- name: Verify internal links
17+
run: ./scripts/verify-links.sh
18+
- name: Verify internal link anchors
19+
run: ./scripts/verify-link-anchors.sh

TOC.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -19,63 +19,63 @@
1919
- [SQL 基本操作](/basic-sql-operations.md)
2020
- [深入探索 HTAP](/explore-htap.md)
2121
- 应用开发
22-
- [概览](/develop/developer-guide-overview.md)
22+
- [概览](/develop/dev-guide-overview.md)
2323
- 快速开始
24-
- [使用 TiDB Cloud (DevTier) 构建 TiDB 集群](/develop/build-cluster-in-cloud.md)
25-
- [使用 TiDB 的增删改查 SQL](/develop/tidb-crud-sql.md)
24+
- [使用 TiDB Cloud (DevTier) 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
25+
- [使用 TiDB 的增删改查 SQL](/develop/dev-guide-tidb-crud-sql.md)
2626
- TiDB 的简单 CRUD 应用程序
27-
- [Java](/develop/sample-application-java.md)
27+
- [Java](/develop/dev-guide-sample-application-java.md)
2828
- 示例程序
29-
- [使用 Spring Boot 构建 TiDB 应用程序](/develop/sample-application-spring-boot.md)
29+
- [使用 Spring Boot 构建 TiDB 应用程序](/develop/dev-guide-sample-application-spring-boot.md)
3030
- 连接到 TiDB
31-
- [选择驱动或 ORM 框架](/develop/choose-driver-or-orm.md)
32-
- [连接到 TiDB](/develop/connect-to-tidb.md)
33-
- [连接池与连接参数](/develop/connection-parameters.md)
31+
- [选择驱动或 ORM 框架](/develop/dev-guide-choose-driver-or-orm.md)
32+
- [连接到 TiDB](/develop/dev-guide-connect-to-tidb.md)
33+
- [连接池与连接参数](/develop/dev-guide-connection-parameters.md)
3434
- 数据库模式设计
35-
- [概览](/develop/schema-design-overview.md)
36-
- [创建数据库](/develop/create-database.md)
37-
- [创建表](/develop/create-table.md)
38-
- [创建二级索引](/develop/create-secondary-indexes.md)
35+
- [概览](/develop/dev-guide-schema-design-overview.md)
36+
- [创建数据库](/develop/dev-guide-create-database.md)
37+
- [创建表](/develop/dev-guide-create-table.md)
38+
- [创建二级索引](/develop/dev-guide-create-secondary-indexes.md)
3939
- 数据写入
40-
- [插入数据](/develop/insert-data.md)
41-
- [更新数据](/develop/update-data.md)
42-
- [删除数据](/develop/delete-data.md)
43-
- [预处理语句](/develop/prepared-statement.md)
40+
- [插入数据](/develop/dev-guide-insert-data.md)
41+
- [更新数据](/develop/dev-guide-update-data.md)
42+
- [删除数据](/develop/dev-guide-delete-data.md)
43+
- [预处理语句](/develop/dev-guide-prepared-statement.md)
4444
- 数据读取
45-
- [单表读取](/develop/get-data-from-single-table.md)
46-
- [多表连接查询](/develop/join-tables.md)
47-
- [子查询](/develop/use-subqueries.md)
48-
- [查询结果分页](/develop/paginate-results.md)
49-
- [视图](/develop/use-views.md)
50-
- [临时表](/develop/use-temporary-tables.md)
51-
- [公共表表达式](/develop/use-common-table-expression.md)
45+
- [单表读取](/develop/dev-guide-get-data-from-single-table.md)
46+
- [多表连接查询](/develop/dev-guide-join-tables.md)
47+
- [子查询](/develop/dev-guide-use-subqueries.md)
48+
- [查询结果分页](/develop/dev-guide-paginate-results.md)
49+
- [视图](/develop/dev-guide-use-views.md)
50+
- [临时表](/develop/dev-guide-use-temporary-tables.md)
51+
- [公共表表达式](/develop/dev-guide-use-common-table-expression.md)
5252
- 读取副本数据
53-
- [Follower Read](/develop/use-follower-read.md)
54-
- [Stale Read](/develop/use-stale-read.md)
55-
- [HTAP 查询](/develop/hybrid-oltp-and-olap-queries.md)
53+
- [Follower Read](/develop/dev-guide-use-follower-read.md)
54+
- [Stale Read](/develop/dev-guide-use-stale-read.md)
55+
- [HTAP 查询](/develop/dev-guide-hybrid-oltp-and-olap-queries.md)
5656
- 事务
57-
- [概览](/develop/transaction-overview.md)
58-
- [乐观事务和悲观事务](/develop/optimistic-and-pessimistic-transaction.md)
59-
- [事务限制](/develop/transaction-restraints.md)
60-
- [事务错误处理](/develop/transaction-troubleshoot.md)
57+
- [概览](/develop/dev-guide-transaction-overview.md)
58+
- [乐观事务和悲观事务](/develop/dev-guide-optimistic-and-pessimistic-transaction.md)
59+
- [事务限制](/develop/dev-guide-transaction-restraints.md)
60+
- [事务错误处理](/develop/dev-guide-transaction-troubleshoot.md)
6161
- 优化 SQL 性能
62-
- [概览](/develop/optimize-sql-overview.md)
63-
- [SQL 性能调优](/develop/optimize-sql.md)
64-
- [性能调优最佳实践](/develop/optimize-sql-best-practices.md)
62+
- [概览](/develop/dev-guide-optimize-sql-overview.md)
63+
- [SQL 性能调优](/develop/dev-guide-optimize-sql.md)
64+
- [性能调优最佳实践](/develop/dev-guide-optimize-sql-best-practices.md)
6565
- 其他优化
66-
- [避免隐式类型转换](/develop/implicit-type-conversion.md)
67-
- [唯一序列号生成方案](/develop/unique-serial-number-generation.md)
66+
- [避免隐式类型转换](/develop/dev-guide-implicit-type-conversion.md)
67+
- [唯一序列号生成方案](/develop/dev-guide-unique-serial-number-generation.md)
6868
- 故障诊断
69-
- [概览](/develop/troubleshoot-overview.md)
69+
- [概览](/develop/dev-guide-troubleshoot-overview.md)
7070
- 其他故障或限制
71-
- [结果集不稳定](/develop/unstable-result-set.md)
72-
- [超时](/develop/timeouts-in-tidb.md)
71+
- [结果集不稳定](/develop/dev-guide-unstable-result-set.md)
72+
- [超时](/develop/dev-guide-timeouts-in-tidb.md)
7373
- 引用文档
7474
- SQL
75-
- [Bookshop 示例应用](/develop/bookshop-schema-design.md)
75+
- [Bookshop 示例应用](/develop/dev-guide-bookshop-schema-design.md)
7676
- 规范
77-
- [命名规范](/develop/object-naming-guidelines.md)
78-
- [SQL 开发规范](/develop/sql-development-specification.md)
77+
- [命名规范](/develop/dev-guide-object-naming-guidelines.md)
78+
- [SQL 开发规范](/develop/dev-guide-sql-development-specification.md)
7979
- 部署标准集群
8080
- [软硬件环境需求](/hardware-and-software-requirements.md)
8181
- [环境与系统配置检查](/check-before-deployment.md)
File renamed without changes.
File renamed without changes.

develop/choose-driver-or-orm.md renamed to develop/dev-guide-choose-driver-or-orm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ TiDB 与 MySQL 有差异:
4141
> - CVE-2019-2692 直接引入
4242
> - CVE-2021-22569 间接引入
4343
44-
有关一个完整的实例应用程序,可参阅使用 [TiDB 和 JDBC 构建一个 Java 应用](/develop/sample-application-java.md#第-2-步获取代码)
44+
有关一个完整的实例应用程序,可参阅使用 [TiDB 和 JDBC 构建一个 Java 应用](/develop/dev-guide-sample-application-java.md#第-2-步获取代码)
4545

4646
### Java ORM Framework
4747

@@ -100,7 +100,7 @@ implementation 'org.hibernate:hibernate-core:6.0.0.CR2'
100100
implementation 'mysql:mysql-connector-java:8.0.28'
101101
```
102102

103-
- 有关原生 Java 使用 Hibernate 进行 TiDB 应用程序构建的例子,可参阅 [TiDB 和 Java 的简单 CRUD 应用程序 - 使用 Hibernate](/develop/sample-application-java.md#第-2-步获取代码)
104-
- 有关 Spring 使用 Spring Data JPA、Hibernate 进行 TiDB 应用程序构建的例子,可参阅[使用 Spring Boot 构建 TiDB 应用程序](/develop/sample-application-spring-boot.md)
103+
- 有关原生 Java 使用 Hibernate 进行 TiDB 应用程序构建的例子,可参阅 [TiDB 和 Java 的简单 CRUD 应用程序 - 使用 Hibernate](/develop/dev-guide-sample-application-java.md#第-2-步获取代码)
104+
- 有关 Spring 使用 Spring Data JPA、Hibernate 进行 TiDB 应用程序构建的例子,可参阅[使用 Spring Boot 构建 TiDB 应用程序](/develop/dev-guide-sample-application-spring-boot.md)
105105

106106
额外的,你需要在 [Hibernate 配置文件](https://www.tutorialspoint.com/hibernate/hibernate_configuration.htm)中指定 TiDB 方言: `org.hibernate.dialect.TiDBDialect`,此方言在 Hibernate `6.0.0.Beta2` 以上才可支持。若你无法升级 Hibernate 版本,那么请你直接使用 MySQL 5.7 的方言 `org.hibernate.dialect.MySQL57Dialect`。但这可能造成不可预料的使用结果,及部分 TiDB 特有特性的缺失,如:[序列](/sql-statements/sql-statement-create-sequence.md)等。
File renamed without changes.
File renamed without changes.
File renamed without changes.

develop/create-database.md renamed to develop/dev-guide-create-database.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: 创建数据库的方法、最佳实践及例子。
55

66
# 创建数据库
77

8-
此页面提供了一个创建数据库的最佳实践指南,并提供了一个基于 TiDB 的 [bookshop](/develop/bookshop-schema-design.md) 数据库的示例。
8+
此页面提供了一个创建数据库的最佳实践指南,并提供了一个基于 TiDB 的 [bookshop](/develop/dev-guide-bookshop-schema-design.md) 数据库的示例。
99

1010
> **注意:**
1111
>
@@ -15,12 +15,12 @@ summary: 创建数据库的方法、最佳实践及例子。
1515

1616
在阅读本页面之前,你需要准备以下事项:
1717

18-
- [使用 TiDB Cloud (DevTier) 构建 TiDB 集群](/develop/build-cluster-in-cloud.md)
19-
- 阅读[数据库模式概览](/develop/schema-design-overview.md)
18+
- [使用 TiDB Cloud (DevTier) 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
19+
- 阅读[数据库模式概览](/develop/dev-guide-schema-design-overview.md)
2020

2121
## 创建数据库
2222

23-
[数据库](/develop/schema-design-overview.md#数据库-database)对象是 TiDB ******视图****序列**等对象的集合。
23+
[数据库](/develop/dev-guide-schema-design-overview.md#数据库-database)对象是 TiDB ******视图****序列**等对象的集合。
2424

2525
若需创建数据库,请使用 `CREATE DATABASE` 语句,并遵循[数据库最佳实践](#数据库最佳实践)
2626

@@ -31,7 +31,7 @@ summary: 创建数据库的方法、最佳实践及例子。
3131
- 尽量不要使用已存在的 `test` 数据库。而是应该使用 `CREATE DATABASE` 语句来创建数据库,并且在 SQL 会话中使用 `USE {databasename};` 语句来[更改当前数据库](/sql-statements/sql-statement-use.md)
3232
- 使用 root 用户创建数据库、角色、用户等。并只赋予必要的权限。
3333
- 作为通用的最佳实践,我们不推荐使用 Driver、ORM 进行数据库模式的定义与更改。相反,请使用 **MySQL 命令行客户端**或其他你喜欢的 **MySQL GUI 客户端**来进行操作。
34-
- 遵循[数据库命名规范](/develop/object-naming-guidelines.md#数据库命名规范)
34+
- 遵循[数据库命名规范](/develop/dev-guide-object-naming-guidelines.md#数据库命名规范)
3535

3636
### 示例
3737

@@ -97,4 +97,4 @@ mysql
9797

9898
至此,你已经准备完毕 `bookshop` 数据库,可以将****添加到该数据库中。
9999

100-
你可继续阅读[创建表](/develop/create-table.md)文档获得相关指引。
100+
你可继续阅读[创建表](/develop/dev-guide-create-table.md)文档获得相关指引。

develop/create-secondary-indexes.md renamed to develop/dev-guide-create-secondary-indexes.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ summary: 创建二级索引的方法、最佳实践及例子。
77

88
索引是集群中的逻辑对象,可以帮助 TiDB 集群更有效地查找数据。当你创建二级索引时,TiDB 会创建一个表中各行的引用,并按选择的列进行排序。而并非对表本身的数据进行排序。可在[二级索引](/best-practices/tidb-best-practices.md#二级索引)中查看更多信息。
99

10-
此页面提供了一个创建二级索引的最佳实践指南,并提供了一个基于 TiDB 的 [bookshop](/develop/bookshop-schema-design.md) 数据库的示例。
10+
此页面提供了一个创建二级索引的最佳实践指南,并提供了一个基于 TiDB 的 [bookshop](/develop/dev-guide-bookshop-schema-design.md) 数据库的示例。
1111

1212
## 在开始之前
1313

1414
在阅读本页面之前,你需要准备以下事项:
1515

16-
- [使用 TiDB Cloud (DevTier) 构建 TiDB 集群](/develop/build-cluster-in-cloud.md)
17-
- 阅读[数据库模式概览](/develop/schema-design-overview.md)
18-
- [创建一个数据库](/develop/create-database.md)
19-
- [创建表](/develop/create-table.md)
16+
- [使用 TiDB Cloud (DevTier) 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
17+
- 阅读[数据库模式概览](/develop/dev-guide-schema-design-overview.md)
18+
- [创建一个数据库](/develop/dev-guide-create-database.md)
19+
- [创建表](/develop/dev-guide-create-table.md)
2020

2121
## 创建二级索引
2222

@@ -53,7 +53,7 @@ KEY `{index_name}` (`{column_names}`)
5353

5454
## 最佳实践
5555

56-
[索引的最佳实践](/develop/index-best-practice.md)
56+
[索引的最佳实践](/develop/dev-guide-index-best-practice.md)
5757

5858
## 例子
5959

@@ -164,4 +164,4 @@ SHOW INDEXES FROM `bookshop`.`books`;
164164
2 rows in set (1.63 sec)
165165
```
166166

167-
至此,你已经完成数据库、表及二级索引的创建,接下来,数据库模式已经准备好给你的应用程序提供 [写入](/develop/insert-data.md)[读取](/develop/get-data-from-single-table.md) 读取的能力了。
167+
至此,你已经完成数据库、表及二级索引的创建,接下来,数据库模式已经准备好给你的应用程序提供 [写入](/develop/dev-guide-insert-data.md)[读取](/develop/dev-guide-get-data-from-single-table.md) 读取的能力了。

0 commit comments

Comments
 (0)