-
Notifications
You must be signed in to change notification settings - Fork 709
*: create best practices TOC and index #22330
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.
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
Merged
ti-chi-bot
merged 1 commit into
pingcap:feature/preview-top-navigation
from
lilin90:best-practices-toc-index
Jan 15, 2026
+50
−33
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,18 @@ | ||
| <!-- markdownlint-disable MD007 --> | ||
| <!-- markdownlint-disable MD041 --> | ||
|
|
||
| - TiDB Cloud API  | ||
| - [Overview](/api/tidb-cloud-api-overview.md) | ||
| - [v1beta1](/api/tidb-cloud-api-v1beta1.md) | ||
| - [v1beta](/api/tidb-cloud-api-v1beta.md) | ||
| - TiDB Self-Managed API | ||
| - [TiProxy API](/api/tiproxy-api-overview.md) | ||
| - [Data Migration API](/api/dm-api-overview.md) | ||
| - [Monitoring API](/api/monitoring-api-overview.md) | ||
| - [TiCDC API](/api/ticdc-api-overview.md) | ||
| - [TiDB Operator API](/api/tidb-operator-api-overview.md) | ||
| # Table of Contents | ||
|
|
||
| ## TIDB CLOUD API  | ||
|
|
||
| - [Overview](/api/tidb-cloud-api-overview.md) | ||
| - [v1beta1](/api/tidb-cloud-api-v1beta1.md) | ||
| - [v1beta](/api/tidb-cloud-api-v1beta.md) | ||
|
|
||
| ## TIDB SELF-MANAGED API | ||
|
|
||
| - [TiProxy API](/api/tiproxy-api-overview.md) | ||
| - [Data Migration API](/api/dm-api-overview.md) | ||
| - [Monitoring API](/api/monitoring-api-overview.md) | ||
| - [TiCDC API](/api/ticdc-api-overview.md) | ||
| - [TiDB Operator API](/api/tidb-operator-api-overview.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <!-- markdownlint-disable MD007 --> | ||
| <!-- markdownlint-disable MD041 --> | ||
|
|
||
| - [Use TiDB](/best-practices/tidb-best-practices.md) | ||
| - [Manage DDL](/ddl-introduction.md) | ||
| - [Optimize Multi-Column Indexes](/best-practices/multi-column-index-best-practices.md) | ||
| - [Manage Indexes and Identify Unused Indexes](/best-practices/index-management-best-practices.md) | ||
| - [Handle Millions of Tables in SaaS Multi-Tenant Scenarios](/best-practices/saas-best-practices.md) | ||
| - [Use UUIDs as Primary Keys](/best-practices/uuid.md) | ||
| - [Develop Java Applications](/best-practices/java-app-best-practices.md) | ||
| - [Handle High-Concurrency Writes](/best-practices/high-concurrency-best-practices.md) | ||
| - [Tune TiKV Performance with Massive Regions](/best-practices/massive-regions-best-practices.md) | ||
| - [Tune PD Scheduling](/best-practices/pd-scheduling-best-practices.md) | ||
| - [Use Read-Only Storage Nodes](/best-practices/readonly-nodes.md) | ||
| - [Use HAProxy for Load Balancing](/best-practices/haproxy-best-practices.md) | ||
| - [Monitor TiDB Using Grafana](/best-practices/grafana-monitor-best-practices.md) | ||
| - [Three-Node Hybrid Deployment](/best-practices/three-nodes-hybrid-deployment.md) | ||
| - [Local Reads in Three-Data-Center Deployments](/best-practices/three-dc-local-read.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| title: TiDB Best Practices | ||
| summary: Learn the best practices for deploying, configuring, and using TiDB effectively. | ||
| --- | ||
|
|
||
| # TiDB Best Practices | ||
lilin90 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| This section provides best practices for deploying, configuring, and using TiDB effectively. Following these best practices can help you optimize the performance, reliability, and scalability of your TiDB deployments. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.