From 7aae349511413045464d32bd305ea91811dbad9e Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 28 Jan 2026 11:41:40 +0800 Subject: [PATCH 1/4] new nav: categorize best practices TOC items Organized the table of contents into sections: Overview, Schema Design, Deployment, Operations, Performance Tuning, and Application Scenarios. This improves readability and helps users find relevant best practices more easily. --- TOC-best-practices.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/TOC-best-practices.md b/TOC-best-practices.md index 6dbc1096992cd..1d0bab4d59699 100644 --- a/TOC-best-practices.md +++ b/TOC-best-practices.md @@ -1,17 +1,36 @@ +# Table of Contents + +## Overview + - [Use TiDB](/best-practices/tidb-best-practices.md) + +## Schema Design + - [Manage DDL](/best-practices/ddl-introduction.md) +- [Use UUIDs as Primary Keys](/best-practices/uuid.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) -- [Handle High-Concurrency Writes](/best-practices/high-concurrency-best-practices.md) + +## Deployment + +- [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) + +## Operations + +- [Use HAProxy for Load Balancing](/best-practices/haproxy-best-practices.md) +- [Monitor TiDB Using Grafana](/best-practices/grafana-monitor-best-practices.md) + +## Performance Tuning + - [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) + +## Application Scenarios + +- [Handle Millions of Tables in SaaS Multi-Tenant Scenarios](/best-practices/saas-best-practices.md) +- [Handle High-Concurrency Writes](/best-practices/high-concurrency-best-practices.md) From 80e7bcfa2524aa2811e1ab731a7fa23d88af7373 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 28 Jan 2026 17:52:29 +0800 Subject: [PATCH 2/4] Refactor TOC to use nested list format Reorganized the Table of Contents in TOC-best-practices.md to use a nested list format for improved readability and structure. This change groups related best practices under their respective categories using indentation. --- TOC-best-practices.md | 50 ++++++++++++++++--------------------------- 1 file changed, 19 insertions(+), 31 deletions(-) diff --git a/TOC-best-practices.md b/TOC-best-practices.md index 1d0bab4d59699..1092eb2ace723 100644 --- a/TOC-best-practices.md +++ b/TOC-best-practices.md @@ -3,34 +3,22 @@ # Table of Contents -## Overview - -- [Use TiDB](/best-practices/tidb-best-practices.md) - -## Schema Design - -- [Manage DDL](/best-practices/ddl-introduction.md) -- [Use UUIDs as Primary Keys](/best-practices/uuid.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) - -## Deployment - -- [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) - -## Operations - -- [Use HAProxy for Load Balancing](/best-practices/haproxy-best-practices.md) -- [Monitor TiDB Using Grafana](/best-practices/grafana-monitor-best-practices.md) - -## Performance Tuning - -- [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) - -## Application Scenarios - -- [Handle Millions of Tables in SaaS Multi-Tenant Scenarios](/best-practices/saas-best-practices.md) -- [Handle High-Concurrency Writes](/best-practices/high-concurrency-best-practices.md) +- Overview + - [Use TiDB](/best-practices/tidb-best-practices.md) +- Schema Design + - [Manage DDL](/best-practices/ddl-introduction.md) + - [Use UUIDs as Primary Keys](/best-practices/uuid.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) +- Deployment + - [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) +- Operations + - [Use HAProxy for Load Balancing](/best-practices/haproxy-best-practices.md) + - [Use Read-Only Storage Nodes](/best-practices/readonly-nodes.md) + - [Monitor TiDB Using Grafana](/best-practices/grafana-monitor-best-practices.md) +- Performance Tuning + - [Tune TiKV Performance with Massive Regions](/best-practices/massive-regions-best-practices.md) + - [Tune PD Scheduling](/best-practices/pd-scheduling-best-practices.md) + - [Handle Millions of Tables in SaaS Multi-Tenant Scenarios](/best-practices/saas-best-practices.md) + - [Handle High-Concurrency Writes](/best-practices/high-concurrency-best-practices.md) From 040f9056314ea01b68138d3a3b12feb46898a853 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 28 Jan 2026 17:53:18 +0800 Subject: [PATCH 3/4] Update format --- TOC-best-practices.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TOC-best-practices.md b/TOC-best-practices.md index 1092eb2ace723..f9e3587ecde84 100644 --- a/TOC-best-practices.md +++ b/TOC-best-practices.md @@ -3,7 +3,7 @@ # Table of Contents -- Overview +- Overview - [Use TiDB](/best-practices/tidb-best-practices.md) - Schema Design - [Manage DDL](/best-practices/ddl-introduction.md) From f79a879d6ff322d740f3483b8696e8fe8f168611 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 28 Jan 2026 17:53:58 +0800 Subject: [PATCH 4/4] Remove an extra line --- TOC-best-practices.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/TOC-best-practices.md b/TOC-best-practices.md index f9e3587ecde84..a248b23d18886 100644 --- a/TOC-best-practices.md +++ b/TOC-best-practices.md @@ -1,8 +1,6 @@ -# Table of Contents - - Overview - [Use TiDB](/best-practices/tidb-best-practices.md) - Schema Design