Skip to content

Commit 01c9833

Browse files
dveedendveeden
authored
CI: Update LinkChecker URL excludes (#20287)
1 parent 257ae3d commit 01c9833

File tree

6 files changed

+49
-192
lines changed

6 files changed

+49
-192
lines changed

‎.github/workflows/link-fail-fast.yaml

+2-6
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,11 @@ jobs:
1717
CHANGED_FILES=$(git diff-tree --name-only --diff-filter 'AM' -r HEAD^1 HEAD -- "*.md" | sed -z "s/\n$//;s/\n/' '/g")
1818
echo "all_changed_files=${CHANGED_FILES}" >> $GITHUB_OUTPUT
1919
20-
- name: Download Exclude Path
21-
run: |
22-
curl https://raw.githubusercontent.com/pingcap/docs/master/.lycheeignore -O
23-
2420
- name: Link Checker
2521
if: ${{ steps.changed-files.outputs.all_changed_files }}
26-
uses: lycheeverse/lychee-action@v1.6.1
22+
uses: lycheeverse/lychee-action@v2.3.0
2723
with:
2824
fail: true
29-
args: -E --exclude-mail -i -n -t 45 -- '${{ steps.changed-files.outputs.all_changed_files }}'
25+
args: --root-dir $(pwd) -E -i -n -t 45 -- '${{ steps.changed-files.outputs.all_changed_files }}'
3026
env:
3127
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

‎.lycheeignore

+17-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,20 @@ file://.*?http:/\$%7BPD_IP%7D:\$%7BPD_PORT%7D/dashboard.*
1414
http://\{grafana-ip\}:3000
1515
http://\{pd-ip\}:2379/dashboard
1616
http://localhost:\d+/
17-
https://github\.com/\$user/(docs|docs-cn)
17+
https://github\.com/\$user/(docs|docs-cn)
18+
https://linux\.die\.net/man.*
19+
https://dev\.mysql\.com/doc/.+/5.7/en/.*
20+
https://dev\.mysql\.com/doc/.+/8\.0/en/.*
21+
https://dev\.mysql\.com/doc/.+/8\.4/en/.*
22+
https://dev\.mysql\.com/doc/[a-z\-]+/en/.*
23+
https://dev\.mysql\.com/doc/relnotes/[a-z\-]+/en/.*
24+
https://dev\.mysql\.com/doc/dev/mysql-server/.*
25+
https://dev\.mysql\.com/downloads/.*
26+
https://bugs\.mysql\.com/bug\.php.*
27+
https://www\.mysql\.com/products/.*
28+
https://platform\.openai\.com/docs/.*
29+
https://openai\.com/.*
30+
https://jwt\.io/
31+
https://typeorm\.io/.*
32+
https://dash\.cloudflare\.com/.*
33+
https://centminmod\.com/mydumper\.html

‎develop/dev-guide-overview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ In addition to these guides, PingCAP works with the community to [support the th
145145

146146
## Use MySQL client software
147147

148-
As TiDB is a MySQL-compatible database, you can use many client software tools to connect to TiDB Cloud and manage the databases just like you did before. Or, use our <a href="/tidbcloud/get-started-with-cli">command line tool</a> to connect and manage your databases.
148+
As TiDB is a MySQL-compatible database, you can use many client software tools to connect to TiDB Cloud and manage the databases just like you did before. Or, use our [command line tool](https://docs.pingcap.com/tidbcloud/get-started-with-cli) to connect and manage your databases.
149149

150150
<DevToolGroup>
151151
<DevToolCard title="MySQL Workbench" logo="mysql-1" docLink="/tidbcloud/dev-guide-gui-mysql-workbench">
@@ -174,8 +174,8 @@ Connect and manage TiDB Cloud databases with DataGrip by JetBrains.
174174

175175
Learn other topics about developing with TiDB Cloud.
176176

177-
- Use <a href="/tidbcloud/get-started-with-cli">TiDB Cloud CLI</a> to develop, manage and deploy your applications.
178-
- Explore popular <a href="/tidbcloud/integrate-tidbcloud-with-airbyte">services integrations</a> with TiDB Cloud.
177+
- Use [TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli) to develop, manage and deploy your applications.
178+
- Explore popular [services integrations](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-airbyte) with TiDB Cloud.
179179
- Use [TiDB database development reference](/develop/dev-guide-schema-design-overview.md) to design, interact, optimize and troubleshoot with your data and schema.
180180
- Follow the free online course [Introduction to TiDB](https://eng.edu.pingcap.com/catalog/info/id:203/?utm_source=docs-dev-guide).
181181

‎develop/dev-guide-third-party-support.md

+20-152
Original file line numberDiff line numberDiff line change
@@ -26,161 +26,29 @@ If you encounter problems when connecting to TiDB using the tools listed in this
2626

2727
## Driver
2828

29-
<table>
30-
<thead>
31-
<tr>
32-
<th>Language</th>
33-
<th>Driver</th>
34-
<th>Latest tested version</th>
35-
<th>Support level</th>
36-
<th>TiDB adapter</th>
37-
<th>Tutorial</th>
38-
</tr>
39-
</thead>
40-
<tbody>
41-
<tr>
42-
<td>Go</td>
43-
<td><a href="https://github.com/go-sql-driver/mysql" target="_blank" referrerpolicy="no-referrer-when-downgrade">Go-MySQL-Driver</a></td>
44-
<td>v1.6.0</td>
45-
<td>Full</td>
46-
<td>N/A</td>
47-
<td><a href="/tidb/dev/dev-guide-sample-application-golang-sql-driver">Connect to TiDB with Go-MySQL-Driver</a></td>
48-
</tr>
49-
<tr>
50-
<td>Java</td>
51-
<td><a href="https://dev.mysql.com/downloads/connector/j/" target="_blank" referrerpolicy="no-referrer-when-downgrade">JDBC</a></td>
52-
<td>8.0</td>
53-
<td>Full</td>
54-
<td>
55-
<ul>
56-
<li><a href="/tidb/dev/dev-guide-choose-driver-or-orm#java-drivers" data-href="/tidb/dev/dev-guide-choose-driver-or-orm#java-drivers">pingcap/mysql-connector-j</a></li>
57-
<li><a href="/tidb/dev/dev-guide-choose-driver-or-orm#tidb-loadbalance" data-href="/tidb/dev/dev-guide-choose-driver-or-orm#tidb-loadbalance">pingcap/tidb-loadbalance</a></li>
58-
</ul>
59-
</td>
60-
<td><a href="/tidb/dev/dev-guide-sample-application-java-jdbc">Connect to TiDB with JDBC</a></td>
61-
</tr>
62-
</tbody>
63-
</table>
29+
| Language | Driver | Latest tested version | Support level | TiDB adapter | Tutorial |
30+
|----------|--------|-----------------------|---------------|--------------|----------|
31+
| Go | [go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) | v1.6.0 | Full | N/A | [Connect to TiDB with Go-MySQL-Driver](/develop/dev-guide-sample-application-golang-sql-driver.md) |
32+
| Java | [MySQL Connector/J](https://dev.mysql.com/downloads/connector/j/) | 8.0 | Full | [pingcap/mysql-connector-j](/develop/dev-guide-choose-driver-or-orm.md#java-drivers) <br/> [pingcap/tidb-loadbalance](/develop/dev-guide-choose-driver-or-orm.md#java-client-load-balancing) | [Connect to TiDB with JDBC](/develop/dev-guide-sample-application-java-jdbc.md) |
6433

6534
## ORM
6635

67-
<table>
68-
<thead>
69-
<tr>
70-
<th>Language</th>
71-
<th>ORM framework</th>
72-
<th>Latest tested version</th>
73-
<th>Support level</th>
74-
<th>TiDB adapter</th>
75-
<th>Tutorial</th>
76-
</tr>
77-
</thead>
78-
<tbody>
79-
<tr>
80-
<td rowspan="4">Go</td>
81-
<td><a href="https://github.com/go-gorm/gorm" target="_blank" referrerpolicy="no-referrer-when-downgrade">gorm</a></td>
82-
<td>v1.23.5</td>
83-
<td>Full</td>
84-
<td>N/A</td>
85-
<td><a href="/tidb/dev/dev-guide-sample-application-golang-gorm">Connect to TiDB with GORM</a></td>
86-
</tr>
87-
<tr>
88-
<td><a href="https://github.com/beego/beego" target="_blank" referrerpolicy="no-referrer-when-downgrade">beego</a></td>
89-
<td>v2.0.3</td>
90-
<td>Full</td>
91-
<td>N/A</td>
92-
<td>N/A</td>
93-
</tr>
94-
<tr>
95-
<td><a href="https://github.com/upper/db" target="_blank" referrerpolicy="no-referrer-when-downgrade">upper/db</a></td>
96-
<td>v4.5.2</td>
97-
<td>Full</td>
98-
<td>N/A</td>
99-
<td>N/A</td>
100-
</tr>
101-
<tr>
102-
<td><a href="https://gitea.com/xorm/xorm" target="_blank" referrerpolicy="no-referrer-when-downgrade">xorm</a></td>
103-
<td>v1.3.1</td>
104-
<td>Full</td>
105-
<td>N/A</td>
106-
<td>N/A</td>
107-
</tr>
108-
<tr>
109-
<td rowspan="4">Java</td>
110-
<td><a href="https://hibernate.org/orm/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Hibernate</a></td>
111-
<td>6.1.0.Final</td>
112-
<td>Full</td>
113-
<td>N/A</td>
114-
<td><a href="/tidb/dev/dev-guide-sample-application-java-hibernate">Connect to TiDB with Hibernate</a></td>
115-
</tr>
116-
<tr>
117-
<td><a href="https://mybatis.org/mybatis-3/" target="_blank" referrerpolicy="no-referrer-when-downgrade">MyBatis</a></td>
118-
<td>v3.5.10</td>
119-
<td>Full</td>
120-
<td>N/A</td>
121-
<td><a href="/tidb/dev/dev-guide-sample-application-java-mybatis">Connect to TiDB with MyBatis</a></td>
122-
</tr>
123-
<tr>
124-
<td><a href="https://spring.io/projects/spring-data-jpa/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Spring Data JPA</a></td>
125-
<td>2.7.2</td>
126-
<td>Full</td>
127-
<td>N/A</td>
128-
<td><a href="/tidb/dev/dev-guide-sample-application-java-spring-boot">Connect to TiDB with Spring Boot</a></td>
129-
</tr>
130-
<tr>
131-
<td><a href="https://github.com/jOOQ/jOOQ" target="_blank" referrerpolicy="no-referrer-when-downgrade">jOOQ</a></td>
132-
<td>v3.16.7 (Open Source)</td>
133-
<td>Full</td>
134-
<td>N/A</td>
135-
<td>N/A</td>
136-
</tr>
137-
<tr>
138-
<td>Ruby</td>
139-
<td><a href="https://guides.rubyonrails.org/active_record_basics.html" target="_blank" referrerpolicy="no-referrer-when-downgrade">Active Record</a></td>
140-
<td>v7.0</td>
141-
<td>Full</td>
142-
<td>N/A</td>
143-
<td><a href="/tidb/dev/dev-guide-sample-application-ruby-rails">Connect to TiDB with Rails Framework and ActiveRecord ORM</a></td>
144-
</tr>
145-
<tr>
146-
<td rowspan="3">JavaScript / TypeScript</td>
147-
<td><a href="https://sequelize.org/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Sequelize</a></td>
148-
<td>v6.20.1</td>
149-
<td>Full</td>
150-
<td>N/A</td>
151-
<td><a href="/tidb/dev/dev-guide-sample-application-nodejs-sequelize">Connect to TiDB with Sequelize</a></td>
152-
</tr>
153-
<tr>
154-
<td><a href="https://www.prisma.io/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Prisma</a></td>
155-
<td>4.16.2</td>
156-
<td>Full</td>
157-
<td>N/A</td>
158-
<td><a href="/tidb/dev/dev-guide-sample-application-nodejs-prisma">Connect to TiDB with Prisma</a></td>
159-
</tr>
160-
<tr>
161-
<td><a href="https://typeorm.io/" target="_blank" referrerpolicy="no-referrer-when-downgrade">TypeORM</a></td>
162-
<td>v0.3.17</td>
163-
<td>Full</td>
164-
<td>N/A</td>
165-
<td><a href="/tidb/dev/dev-guide-sample-application-nodejs-typeorm">Connect to TiDB with TypeORM</a></td>
166-
</tr>
167-
<tr>
168-
<td rowspan="2">Python</td>
169-
<td><a href="https://pypi.org/project/Django/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Django</a></td>
170-
<td>v4.2</td>
171-
<td>Full</td>
172-
<td><a href="https://github.com/pingcap/django-tidb" target="_blank" referrerpolicy="no-referrer-when-downgrade">django-tidb</a></td>
173-
<td><a href="/tidb/dev/dev-guide-sample-application-python-django">Connect to TiDB with Django</a></td>
174-
</tr>
175-
<tr>
176-
<td><a href="https://www.sqlalchemy.org/" target="_blank" referrerpolicy="no-referrer-when-downgrade">SQLAlchemy</a></td>
177-
<td>v1.4.37</td>
178-
<td>Full</td>
179-
<td>N/A</td>
180-
<td><a href="/tidb/dev/dev-guide-sample-application-python-sqlalchemy">Connect to TiDB with SQLAlchemy</a></td>
181-
</tr>
182-
</tbody>
183-
</table>
36+
| Language | ORM framework | Latest tested version | Support level | TiDB adapter | Tutorial |
37+
|-------------------------|-------------------------------------------|-----------------------|-------------|--------------|----------|
38+
| Go | [gorm](https://github.com/go-gorm/gorm) | v1.23.5 | Full | N/A | [Connect to TiDB with GORM](/develop/dev-guide-sample-application-golang-gorm.md) |
39+
| Go | [beego](https://github.com/beego/beego) | v2.0.3 | Full | N/A | N/A |
40+
| Go | [upper/db](https://github.com/upper/db) | v4.5.2 | Full | N/A | N/A |
41+
| Go | [xorm](https://gitea.com/xorm/xorm) | v1.3.1 | Full | N/A | N/A |
42+
| Java | [Hibernate](https://hibernate.org/orm/) | 6.1.0.Final | Full | N/A | [Connect to TiDB with Hibernate](/develop/dev-guide-sample-application-java-hibernate.md) |
43+
| Java | [MyBatis](https://mybatis.org/mybatis-3/) | v3.5.10 | Full | N/A | [Connect to TiDB with MyBatis](/develop/dev-guide-sample-application-java-mybatis.md) |
44+
| Java | [Spring Data JPA](https://spring.io/projects/spring-data-jpa/) | 2.7.2 | Full | N/A | [Connect to TiDB with Spring Boot](/develop/dev-guide-sample-application-java-spring-boot.md) |
45+
| Java | [jOOQ](https://github.com/jOOQ/jOOQ) | v3.16.7 (Open Source) | Full | N/A | N/A |
46+
| Ruby | [Active Record](https://guides.rubyonrails.org/active_record_basics.html) | v7.0 | Full | N/A | [Connect to TiDB with Rails Framework and ActiveRecord ORM](/develop/dev-guide-sample-application-ruby-rails.md) |
47+
| JavaScript / TypeScript | [Sequelize](https://sequelize.org/) | v6.20.1 | Full | N/A | [Connect to TiDB with Sequelize](/develop/dev-guide-sample-application-nodejs-sequelize.md) |
48+
| JavaScript / Typescript | [Prisma](https://www.prisma.io/) | 4.16.2 | Full | N/A | [Connect to TiDB with Prisma](/develop/dev-guide-sample-application-nodejs-prisma.md) |
49+
| JavaScript / Typescript | [TypeORM](https://typeorm.io/) | v0.3.17 | Full | N/A | [Connect to TiDB with TypeORM](/develop/dev-guide-sample-application-nodejs-typeorm.md) |
50+
| Python | [Django](https://www.djangoproject.com/) | v4.2 | Full | [django-tidb](https://github.com/pingcap/django-tidb) | [Connect to TiDB with Django](/develop/dev-guide-sample-application-python-django.md) |
51+
| Python | [SQLAlchemy](https://www.sqlalchemy.org/) | v1.4.37 | Full | N/A | [Connect to TiDB with SQLAlchemy](/develop/dev-guide-sample-application-python-sqlalchemy.md) |
18452

18553
## GUI
18654

‎tidb-cloud/release-notes-2023.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c
132132

133133
- Introduce a TiDB Cloud Billing API endpoint to retrieve the bill for the given month of a specific organization.
134134

135-
This Billing API endpoint is released in TiDB Cloud API v1beta1, which is the latest API version of TiDB Cloud. For more information, refer to the [API documentation (v1beta1)](https://docs.pingcap.com/tidbcloud/api/v1beta1#tag/Billing).
135+
This Billing API endpoint is released in TiDB Cloud API v1beta1, which is the latest API version of TiDB Cloud. For more information, refer to the [API documentation (v1beta1)](https://docs.pingcap.com/tidbcloud/api/v1beta1/billing).
136136

137137
## September 19, 2023
138138

‎vector-search/vector-search-integration-overview.md

+6-29
Original file line numberDiff line numberDiff line change
@@ -48,32 +48,9 @@ You can integrate TiDB Vector Search with your ORM library to interact with the
4848

4949
The following table lists the supported ORM libraries and the corresponding integration tutorials:
5050

51-
<table>
52-
<tr>
53-
<th>Language</th>
54-
<th>ORM/Client</th>
55-
<th>How to install</th>
56-
<th>Tutorial</th>
57-
</tr>
58-
<tr>
59-
<td rowspan="4">Python</td>
60-
<td>TiDB Vector Client</td>
61-
<td><code>pip install tidb-vector[client]</code></td>
62-
<td><a href="/tidb/dev/vector-search-get-started-using-python">Get Started with Vector Search Using Python</a></td>
63-
</tr>
64-
<tr>
65-
<td>SQLAlchemy</td>
66-
<td><code>pip install tidb-vector</code></td>
67-
<td><a href="/tidb/dev/vector-search-integrate-with-sqlalchemy">Integrate TiDB Vector Search with SQLAlchemy</a></td>
68-
</tr>
69-
<tr>
70-
<td>peewee</td>
71-
<td><code>pip install tidb-vector</code></td>
72-
<td><a href="/tidb/dev/vector-search-integrate-with-peewee">Integrate TiDB Vector Search with peewee</a></td>
73-
</tr>
74-
<tr>
75-
<td>Django</td>
76-
<td><code>pip install django-tidb[vector]</code></td>
77-
<td><a href="/tidb/dev/vector-search-integrate-with-django-orm">Integrate TiDB Vector Search with Django</a></td>
78-
</tr>
79-
</table>
51+
| Language | ORM/Client | How to install | Tutorial |
52+
|----------|--------------------|-----------------------------------|----------|
53+
| Python | TiDB Vector Client | `pip install tidb-vector[client]` | [Get Started with Vector Search Using Python](/vector-search/vector-search-get-started-using-python.md) |
54+
| Python | SQLAlchemy | `pip install tidb-vector` | [Integrate TiDB Vector Search with SQLAlchemy](/vector-search/vector-search-integrate-with-sqlalchemy.md)
55+
| Python | peewee | `pip install tidb-vector` | [Integrate TiDB Vector Search with peewee](/vector-search/vector-search-integrate-with-peewee.md) |
56+
| Python | Django | `pip install django-tidb[vector]` | [Integrate TiDB Vector Search with Django](/vector-search/vector-search-integrate-with-django-orm.md)

0 commit comments

Comments
 (0)