pingcap/docs

View on GitHub

TiDB database documentation. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics.

Stars: 617
Forks: 724
Open beginner issues: 12
Indexed issues: 153
Avg merge: 2d 10h
Merged PRs (30d): 223

Dominant language: Python
License: No license data
Last GitHub push: Sep 16, 2026
Latest indexed: Sep 19, 2026
Contributing guide: Contributing guide
Code of conduct: No code of conduct
Beginner labels: help wanted good first issue hacktoberfest

Beginner friendly Everything

Open All

153 open issues indexed

Consider to document the maximum number of `show analyze status` is 30 records Open

pingcap/docs#14482 · 3 comments · 1 assignee · Opened Aug 10, 2023
example does't find/match for “In the example of the previous section:” Open

pingcap/docs#13838 · 1 assignee · Opened Jun 12, 2023
Not clear that some configurations such as [raftstore] raftdb-path are ignored when raft engine is on (default) Open

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

pingcap/docs#13231 · 2 comments · Opened Apr 12, 2023
Let's not mention `RAFT` here Open

Difficulty 1/5 Under an hour Newbie friendliness 55/100

pingcap/docs#13072 · 1 comment · Opened Mar 30, 2023
Implement SQL formatter into the docs pipeline Open

2024-tidb-docs-dash type/enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

pingcap/docs#13031 · 6 comments · 1 reaction · Opened Mar 27, 2023
Partition pruning page does only list HASH and RANGE Open

2024-tidb-docs-dash

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

pingcap/docs#12992 · 1 reaction · Opened Mar 22, 2023
Should we mention Online Schema Change in the docs? Open

feature-request tracked

pingcap/docs#12303 · 1 assignee · Opened Jan 30, 2023
What is the privilege requirement for `SET SESSION variable;`? Open

tracked

pingcap/docs#12235 · 2 comments · 1 assignee · Opened Jan 27, 2023
Request for updating the comment of TiDB's root user password Open

area/diagnosis tracked

pingcap/docs#12233 · 3 comments · 1 assignee · Opened Jan 27, 2023
Add `Cloud-Only` and `OP-Only` notation or comment for some document Open

area/tidb-cloud tracked

Difficulty 4/5 3-5 days Newbie friendliness 25/100

pingcap/docs#12232 · 3 comments · Opened Jan 25, 2023
Add missing information for the customized files importing doc Open

area/tidb-lightning

pingcap/docs#11943 · 1 comment · 1 assignee · Opened Jan 9, 2023
Inaccurate description on limitations on a single column Open

area/transaction tracked

pingcap/docs#11890 · 1 assignee · Opened Jan 4, 2023
The title and content of this doc is mismatched Open

area/ticdc tracked

pingcap/docs#11590 · 1 comment · 1 assignee · Opened Dec 13, 2022
manual line break check should skip multi-line html comments Open

2024-tidb-docs-dash help wanted

Difficulty 2/5 1-3 hours Newbie friendliness 52/100

pingcap/docs#11482 · 2 reactions · Opened Dec 1, 2022
Clarify scattered regions Open

area/sql-infra tracked

pingcap/docs#10923 · 1 comment · 1 assignee · Opened Oct 19, 2022
Discussion on the rich metrics info of TiCDC documents Open

area/ticdc tracked type/enhancement

pingcap/docs#10781 · 3 comments · 1 assignee · Opened Oct 11, 2022
Alert name should be PD_cluster_down_tikv_nums rather than PD_cluster_down_store_nums Open

area/scheduling

Difficulty 1/5 Under an hour Newbie friendliness 45/100

pingcap/docs#10626 · 1 comment · Opened Oct 6, 2022
Integrate TiDB Cloud API docs into TiDB Cloud docs Open

feature-request lifecycle/frozen

Difficulty 5/5 Over a week Newbie friendliness 25/100

pingcap/docs#10387 · Opened Sep 9, 2022
lag of steps to do pd recover on tiup Open

area/scheduling tracked

Difficulty 1/5 Under an hour Newbie friendliness 35/100

pingcap/docs#10244 · 2 comments · Opened Aug 26, 2022
pd-configuration-file: Docs for `max-request-bytes` is missing. Open

add-missing-docs area/scheduling tracked

Difficulty 1/5 Under an hour Newbie friendliness 35/100

pingcap/docs#8817 · 4 comments · Opened Jun 7, 2022
TiDB on kind failing to start if following the docs Open

area/tidb-in-k8s-v1.0

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

pingcap/docs#8750 · Opened May 28, 2022
"DDL algorithm assertions" is not clear Open

area/sql-infra tracked

pingcap/docs#8615 · 5 comments · 1 assignee · Opened May 13, 2022
Auto-inc docs should describe behavior as InnoDB-like Open

2024-tidb-docs-dash area/sql-infra tracked type/bugfix

Difficulty 1/5 1-3 hours Newbie friendliness 35/100

pingcap/docs#7515 · 1 comment · Opened Feb 7, 2022
sync-diff-inspector-overview: Incomplete info about docker and tidb-operatator Open

area/sync-diff-inspector tracked

pingcap/docs#7366 · 3 comments · 1 assignee · Opened Jan 4, 2022
PARTITION BY RANGE vs PARTITION BY RANGE COLUMNS are not clear Open

2024-tidb-docs-dash area/sql-infra tracked type/enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

pingcap/docs#7165 · Opened Dec 9, 2021
Use tidb-dev-guide as contribution guide? Open

area/general tracked

pingcap/docs#6884 · 1 assignee · Opened Nov 19, 2021
Glossary is missing key items Open

area/general tracked type/enhancement

pingcap/docs#6811 · 1 comment · 1 assignee · Opened Nov 15, 2021
TiKV Control User Guide should be extended with k8s info Open

area/engine tracked

pingcap/docs#6738 · 1 comment · 1 assignee · Opened Nov 5, 2021
The doc doesn't exhaust all the items Open

area/sql-infra tracked

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

pingcap/docs#6722 · 1 comment · Opened Nov 3, 2021
FAQ: "Does TiDB support XA?" has a weird answer Open

tracked

pingcap/docs#6532 · 1 comment · 1 assignee · Opened Sep 24, 2021
Missing definition of several options like AlterTableSpecListOpt Open

area/sql-infra tracked

pingcap/docs#6530 · 1 assignee · Opened Sep 24, 2021
tidb-lightning: users need to remove both checkpoint and lightning meta when they try to rerun with v5.1 Open

area/tidb-lightning type/enhancement

pingcap/docs#6003 · 2 assignees · Opened Jul 20, 2021
A bit of confusion terminolgoy about `TiKV` `TiKV store` `TiKV peer` `peer: replica of Region` in tidb-scheduling.md Open

area/engine tracked

Difficulty 2/5 1-3 hours Newbie friendliness 30/100

pingcap/docs#5929 · Opened Jul 6, 2021
Add migration of accounts to MySQL migration docs Open

area/migrate tracked

pingcap/docs#5848 · 2 assignees · Opened Jun 24, 2021
Linux OS version requirements Incomplete Open

tracked

pingcap/docs#5812 · 5 comments · 1 assignee · Opened Jun 21, 2021
PDF generation uses obsoleted options Open

tracked

pingcap/docs#5634 · 8 comments · 1 assignee · Opened May 17, 2021
English grammar issues Open

pingcap/docs#5626 · 1 comment · 1 assignee · Opened May 17, 2021
Provide dark theme for docs Open

pingcap/docs#5601 · 4 comments · 1 assignee · Opened May 11, 2021
Document "unistore" Open

tracked

pingcap/docs#5159 · 10 comments · 2 assignees · Opened Mar 29, 2021
varchar value should use quotation marks Open

pingcap/docs#4951 · 5 comments · 1 assignee · Opened Mar 2, 2021
revise supported platforms Open

lifecycle/frozen

pingcap/docs#4943 · 3 comments · 1 reaction · 1 assignee · Opened Mar 2, 2021
remove excessive clarifications as they apply to earlier GA releases Open

lifecycle/frozen

pingcap/docs#4549 · 5 comments · 1 reaction · 1 assignee · Opened Dec 30, 2020
Improve documentation of tidb-server oom behavior Open

lifecycle/frozen

Difficulty 4/5 3-5 days Newbie friendliness 35/100

pingcap/docs#4477 · 2 comments · Opened Dec 22, 2020
Add documentation for data type storage requirements Open

lifecycle/frozen

pingcap/docs#4390 · 1 comment · 1 assignee · Opened Dec 10, 2020
Consider shorter X.509 certificate lifetimes Open

lifecycle/frozen

pingcap/docs#4299 · 5 comments · 2 reactions · 1 assignee · Opened Nov 30, 2020
Add time unit for slow query log document Open

lifecycle/frozen

pingcap/docs#3999 · 4 comments · 1 assignee · Opened Oct 2, 2020
Add more context on what do we expect for users in Step 1: Prerequisites and precheck Open

lifecycle/frozen

pingcap/docs#3407 · 6 comments · 1 assignee · Opened Jul 23, 2020
Improve sysvar documentation Open

tracked

Difficulty 4/5 3-5 days Newbie friendliness 35/100

pingcap/docs#3260 · 5 comments · Opened Jul 13, 2020
Document TiDB float to int cast behavior Open

2024-tidb-docs-dash help wanted status/TODO tracked

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

pingcap/docs#1002 · Opened Apr 1, 2019
Add TiDB package to Download page Open

lifecycle/frozen type/enhancement

pingcap/docs#920 · 4 comments · 1 assignee · Opened Feb 26, 2019

pingcap/docs

Get new issues in your inbox