diff --git a/TOC-api.md b/TOC-api.md index 083bd95907645..59e9f6f32b891 100644 --- a/TOC-api.md +++ b/TOC-api.md @@ -1,13 +1,18 @@ -- TiDB Cloud API ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) - - [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) \ No newline at end of file +# Table of Contents + +## TIDB CLOUD API ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + +- [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) diff --git a/TOC-best-practices.md b/TOC-best-practices.md new file mode 100644 index 0000000000000..dfaff188c5165 --- /dev/null +++ b/TOC-best-practices.md @@ -0,0 +1,18 @@ + + + +- [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) diff --git a/TOC-tidb-cloud-releases.md b/TOC-tidb-cloud-releases.md index c79d3bd08b31c..debe7379f4679 100644 --- a/TOC-tidb-cloud-releases.md +++ b/TOC-tidb-cloud-releases.md @@ -7,10 +7,11 @@ - [2025](/tidb-cloud/releases/tidb-cloud-release-notes.md) - [2024](/tidb-cloud/releases/release-notes-2024.md) -- [2023](/tidb-cloud/releases/release-notes-2023.md) -- [2022](/tidb-cloud/releases/release-notes-2022.md) -- [2021](/tidb-cloud/releases/release-notes-2021.md) -- [2020](/tidb-cloud/releases/release-notes-2020.md) +- Earlier Releases + - [2023](/tidb-cloud/releases/release-notes-2023.md) + - [2022](/tidb-cloud/releases/release-notes-2022.md) + - [2021](/tidb-cloud/releases/release-notes-2021.md) + - [2020](/tidb-cloud/releases/release-notes-2020.md) ## MAINTENANCE NOTIFICATIONS @@ -19,6 +20,7 @@ - [[2024-04-16] TiDB Cloud Monitoring Features Maintenance Notification](/tidb-cloud/releases/notification-2024-04-16-monitoring-features-maintenance.md) - [[2024-04-11] TiDB Cloud Data Migration (DM) Feature Maintenance Notification](/tidb-cloud/releases/notification-2024-04-11-dm-feature-maintenance.md) - [[2024-04-09] TiDB Cloud Monitoring Features Maintenance Notification](/tidb-cloud/releases/notification-2024-04-09-monitoring-features-maintenance.md) -- [[2023-11-14] TiDB Cloud Dedicated Scale Feature Maintenance Notification](/tidb-cloud/releases/notification-2023-11-14-scale-feature-maintenance.md) -- [[2023-09-26] TiDB Cloud Console Maintenance Notification](/tidb-cloud/releases/notification-2023-09-26-console-maintenance.md) -- [[2023-08-31] TiDB Cloud Console Maintenance Notification](/tidb-cloud/releases/notification-2023-08-31-console-maintenance.md) +- Earlier Notifications + - [[2023-11-14] TiDB Cloud Dedicated Scale Feature Maintenance Notification](/tidb-cloud/releases/notification-2023-11-14-scale-feature-maintenance.md) + - [[2023-09-26] TiDB Cloud Console Maintenance Notification](/tidb-cloud/releases/notification-2023-09-26-console-maintenance.md) + - [[2023-08-31] TiDB Cloud Console Maintenance Notification](/tidb-cloud/releases/notification-2023-08-31-console-maintenance.md) diff --git a/TOC.md b/TOC.md index a486a52bc8521..8003f50351d3b 100644 --- a/TOC.md +++ b/TOC.md @@ -319,22 +319,6 @@ - [TSO Configuration Flags](/command-line-flags-for-tso-configuration.md) - [Scheduling Configuration File](/scheduling-configuration-file.md) - [Scheduling Configuration Flags](/command-line-flags-for-scheduling-configuration.md) -- Best Practices - - [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) - TiDB Tools - [Overview](/ecosystem-tool-user-guide.md) - [Use Cases](/ecosystem-tool-user-case.md) diff --git a/best-practices/_index.md b/best-practices/_index.md new file mode 100644 index 0000000000000..9f921609605d9 --- /dev/null +++ b/best-practices/_index.md @@ -0,0 +1,8 @@ +--- +title: TiDB Best Practices +summary: Learn the best practices for deploying, configuring, and using TiDB effectively. +--- + +# TiDB Best Practices + +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.