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.

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

chores: update from master #6594

Merged
merged 186 commits into from
Oct 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
186 commits
Select commit Hold shift + click to select a range
4214b0d
Dumping default consistency description (#5985)
en-jin19 Jul 15, 2021
5ab45ae
update max-replicas description (#5984)
disksing Jul 16, 2021
928eddf
Remove the swappiness parameter (#5987)
Liuxiaozhen12 Jul 16, 2021
36cc119
system-variables: update for consistency (#5826)
morgo Jul 16, 2021
9300917
Change tidb_memory_usage_alarm_ratio scope to instance (#5988)
Liuxiaozhen12 Jul 16, 2021
8b0e1e6
Punctuation fix: Replace 。with . (#6002)
dveeden Jul 20, 2021
fa4a8f2
index page: updated the phase of TiDB Cloud from Beta to Public Previ…
qiancai Jul 23, 2021
10e060b
Migration FAQs: added the FAQ links of the migration related tools (#…
en-jin19 Jul 23, 2021
b30afa5
TiUP cluster: update data_dir (#6009)
en-jin19 Jul 23, 2021
5971959
Add kafka downstream example (#6005)
Liuxiaozhen12 Jul 23, 2021
b2a944e
TiKV configuration: Update description for pin-l0-filter-and-index-bl…
en-jin19 Jul 23, 2021
21af361
Update the default value of tidb_stmt_summary_max_stmt_count (#6021) …
ti-chi-bot Jul 23, 2021
205734b
update docs related to partition table dynamic mode (#5997)
Liuxiaozhen12 Jul 23, 2021
20dc083
partitioning: Corrected partition management (#5498)
mjonss Jul 23, 2021
14c2621
TiDB binlog: update descriptions about commit ts and passoword (#5986)
en-jin19 Jul 27, 2021
528a249
releases: add tidb 4.0.14 release notes (#5996)
ti-srebot Jul 27, 2021
2fb5fda
fix a typo for sync_diff_inspector (#6041)
glorv Jul 28, 2021
d99cd21
Update dashboard FAQ (#5895)
shhdgit Jul 29, 2021
4fad44d
update stale read doc for ga (#6047)
TomShawn Jul 29, 2021
0b56ea9
configure-time-zone: mention `system_time_zone` (#6032)
dveeden Jul 29, 2021
9c47224
Update Security Compatibility with MySQL (#5921)
dveeden Jul 29, 2021
d773585
correct document of using br backup and restore system tables (#6057)
IANTHEREAL Jul 30, 2021
b4d52ca
Add description about telemetry of builtin functions usage (#6028)
leiysky Jul 30, 2021
c9f6472
Add TiDB Dashboard session docs (#6058)
breezewish Jul 30, 2021
a3fb2d1
update br faq (#6060)
IANTHEREAL Jul 30, 2021
233bd4d
releases: add TiDB 5.1.1 release notes (#6030)
zhouqiang-cl Jul 30, 2021
43d3291
grafana-overview-dashboard: update the monitoring item for CPS (#6066)
qiancai Jul 30, 2021
397f7fd
deploy-tidb-binlog: make the expression on deployment clearer (#6073)
Liuxiaozhen12 Aug 2, 2021
071b947
Add documentation on how to modify gcttl by tiup (#6071)
Liuxiaozhen12 Aug 2, 2021
6a8d059
remove useless variable (#6076)
Liuxiaozhen12 Aug 2, 2021
f46ce8a
ticdc: add mysql sink user privilege (#6072)
Liuxiaozhen12 Aug 2, 2021
150bd8b
deleted roadmap.md (#6079)
hfxsd Aug 2, 2021
1eb3a1f
TiDB Monitoring Metrics: remove a line (#6081)
en-jin19 Aug 2, 2021
25526c6
TiDB configuration: add a security option `require-secure-transport` …
en-jin19 Aug 2, 2021
a622da6
chore: lock plugin versions (#6089)
YiniXu9506 Aug 4, 2021
88e7724
cdc: add compatibility notes for sort-dir (#6086)
TomShawn Aug 4, 2021
5190193
Add gc ttl (#6102) (#6103)
ti-chi-bot Aug 5, 2021
bd6cb19
5.1.0 release notes: Fix link to telemetry docs (#6106)
dveeden Aug 5, 2021
2c0d006
sql-statement-select: Add '...FOR UPDATE NOWAIT' (#6085)
dveeden Aug 5, 2021
c92e1a2
TiCDC: update a golang demo link (#6055)
en-jin19 Aug 5, 2021
8635a98
br/use-br-command-line-tool: supplement br note (#6000)
Liuxiaozhen12 Aug 5, 2021
bdf93d1
pr_template: Provides tips for cherry-pick (#6042)
TomShawn Aug 5, 2021
26a0722
TiDB monitoring: add table storage info status api (#6110)
en-jin19 Aug 6, 2021
d6e2355
update doc for Oracle translate function (#6053)
wzru Aug 6, 2021
3c5352b
ticdc: add explicit_defaults_for_timestamp compatibility troubleshoot…
TomShawn Aug 6, 2021
849e93e
Add print the bad sst files and related information for tikv-ctl (#6109)
hunterlxt Aug 9, 2021
f2a2a27
add a missing note (#6129)
TomShawn Aug 9, 2021
25cbc45
Add docs for auto-tls setting (#6125)
dveeden Aug 10, 2021
e0e792f
TiFlash: remove outdated tune advise (#6133)
en-jin19 Aug 10, 2021
166eb53
TiDB lightning: remove default backend setting (#6132)
en-jin19 Aug 10, 2021
aed94a2
tidb-scheduling: fix typo (#6140)
Liuxiaozhen12 Aug 11, 2021
1a3e0d1
Suggest Log Redaction when using TDE (#6147)
dveeden Aug 12, 2021
622d3b0
Add infoschema.referential_constraints (#6139)
morgo Aug 12, 2021
f9d97e9
Add steps to get lightning goroutine (#6001)
Liuxiaozhen12 Aug 12, 2021
21a8ec2
tiup: fix dead links (#6153)
AstroProfundis Aug 12, 2021
ade93f7
Deleted description about not supporting some features. (#6157)
hfxsd Aug 13, 2021
13820be
high-concurrency-best-practices: fix the support info of follower rea…
Liuxiaozhen12 Aug 13, 2021
c1440f1
Update function list pushed down to tiflash (#6165)
zanmato1984 Aug 16, 2021
fc8169b
The `log_dir` should be the log directory (#6168)
yahonda Aug 16, 2021
22c6b21
Make IP address of Monitoring & Grafana for Minimal Topology consiste…
yahonda Aug 18, 2021
b78946a
tikv: add storage flow control doc (#6173)
TomShawn Aug 18, 2021
2e680f5
TiDB configuration: update the default value of `stmt_max_count` (#6172)
en-jin19 Aug 19, 2021
336c02f
ticdc-open-api: add ticdc open api doc (#6186)
TomShawn Aug 19, 2021
77251d7
System variables: update `broadcast_join_threshold_count` and `broadc…
en-jin19 Aug 20, 2021
4e7a27b
Update tikv-configuration-file.md (#6180)
hfxsd Aug 20, 2021
fdbc54d
TiFlash configuration: update `io_rate_limit` (#6176)
en-jin19 Aug 20, 2021
ea00fff
Add information of hashAgg for memory control (#6171)
Liuxiaozhen12 Aug 20, 2021
26f5741
Update description on rule based index selection (#6160)
Liuxiaozhen12 Aug 20, 2021
4790fa8
add dr auto sync (#6182)
Liuxiaozhen12 Aug 20, 2021
bef486f
update doc for SPM (#6146)
Liuxiaozhen12 Aug 20, 2021
8e8d905
docs: update rereject leader docs (#6183)
en-jin19 Aug 20, 2021
d9a5c1e
SQL statement, system variables: update expression indexes (#6185)
en-jin19 Aug 20, 2021
b0e92f1
Updated sql-plan-management.md (#6184)
hfxsd Aug 20, 2021
e2de2a5
Introduced 2 new variables (#6159)
hfxsd Aug 20, 2021
fc85321
Fix broken link in error codes doc and support doc (#6196)
dveeden Aug 20, 2021
65eef63
docs: fix format for TiKV and PD configuration file template invalid.…
Defined2014 Aug 20, 2021
7a1b15f
docs: separate query statement and result in two text boxes. (#6204) …
Defined2014 Aug 23, 2021
8cef23f
adopters: add zhihu case study (#6207)
ran-huang Aug 23, 2021
0527b7d
Added descriptions about slow node detection (#6174)
hfxsd Aug 23, 2021
b5a1d9e
pd-control: add new config of balance-hot-region-scheduler (#6148)
Liuxiaozhen12 Aug 23, 2021
003e6c8
add notice about scaling in pd node (#6099)
Liuxiaozhen12 Aug 23, 2021
7f990f8
add example for expression index (#6215)
TomShawn Aug 24, 2021
50d7426
adopters: remove 404 links (#6214)
ran-huang Aug 24, 2021
c59888c
ticdc: fix wording (#6231)
TomShawn Aug 24, 2021
bd3500a
Revert "System variables: update `broadcast_join_threshold_count` and…
TomShawn Aug 24, 2021
902eeef
Update documents of lock view for sprint 4 (#6179)
TomShawn Aug 25, 2021
d42828d
ticdc-open-api: correct some error (#6239)
TomShawn Aug 25, 2021
3fcb824
best practices: add timeout options for Java best practices (#6136)
en-jin19 Aug 25, 2021
fe0fef1
update PR template for v5.2 (#6166)
TomShawn Aug 25, 2021
fca05ae
chore: stop building temporary (#6252)
YiniXu9506 Aug 25, 2021
b070538
fix typo for sql-plan-management.md (#6248)
Reminiscent Aug 25, 2021
8a63841
alert rules: update some descriptions (#6250)
en-jin19 Aug 25, 2021
f02fc89
Quick start: update version and TiUP playground supports M1 silicon (…
en-jin19 Aug 25, 2021
cdffc70
fix typo: relaod -> reload (#6235)
en-jin19 Aug 25, 2021
0556902
tiny fix on index selection (#6265)
xuyifangreeneyes Aug 26, 2021
74dd11c
add commands to check tikv user (#5999)
Liuxiaozhen12 Aug 26, 2021
293df6e
br: add restore to systables (#6004)
Liuxiaozhen12 Aug 26, 2021
c7f9874
statement summary: update statement summary doc (#6084)
TomShawn Aug 26, 2021
9339af2
Require process privilege for dumpling (#6187)
Liuxiaozhen12 Aug 26, 2021
36ef0f5
tiflash: Remove the description about expr_blacklist in use_tiflash.m…
Liuxiaozhen12 Aug 26, 2021
bb2fce3
Add description about table name/alias specifying for read_from_stora…
zanmato1984 Aug 26, 2021
389c317
complex tidb binlog.yaml: add checkpoint info (#6216)
en-jin19 Aug 26, 2021
229a070
TiKV configuration: remove redundant instructions (#6218)
en-jin19 Aug 26, 2021
e5873bb
alert rules: remove some descriptions (#6223)
en-jin19 Aug 26, 2021
6d3cb5c
Revert "add dr auto sync" (#6294)
Liuxiaozhen12 Aug 26, 2021
207194e
TiFlash Config: Add annotation (v5.2.0) (#6296)
en-jin19 Aug 27, 2021
280f543
sql: improve kill's description (#6233)
hawkingrei Aug 27, 2021
454a5b8
Add v5.2 TPCH report (#6170)
TomShawn Aug 27, 2021
4bb52fb
docs: fix expression index's document again (#6295)
en-jin19 Aug 27, 2021
810499e
system variables.md: add a warning message (#6298)
Liuxiaozhen12 Aug 27, 2021
76fa71d
sql-statement: Add ADMIN SHOW TELEMETRY (#6138)
morgo Aug 27, 2021
cda9e7b
tiup: add notice about importing cluster (#6108)
Liuxiaozhen12 Aug 27, 2021
1a1b933
Bump version for v5.2.0 (#6191)
TomShawn Aug 27, 2021
db55105
add TiDB 5.2.0 release note (#6237)
qiancai Aug 27, 2021
b589312
add two HTAP documents (#6206)
en-jin19 Aug 27, 2021
5d51e44
benchmark: add v5.2 benchmark results (#6319)
TomShawn Aug 27, 2021
58dca97
Fix title typo (#6324)
TomShawn Aug 28, 2021
cb83958
release note: update feature description (#6325)
qiancai Aug 28, 2021
788ce63
adopters: add xiaomi (#6303)
ran-huang Aug 30, 2021
81b9c46
chore: migrate scripts to docs (#6338)
TomShawn Aug 30, 2021
3657c38
credits: update links to the full list of code and docs contributors …
en-jin19 Aug 30, 2021
c3b41ce
TiUP: add instructions for offline mirror (#6137)
en-jin19 Aug 31, 2021
04cb34a
tune tikv memory performance: remove description for sync-log (#6234)
en-jin19 Aug 31, 2021
6287eb6
dashboard statement list: add a note to explain the blue bar and yell…
en-jin19 Aug 31, 2021
04d6392
release 5.1.0: add compatibility change for `tidb_enable_noop_functio…
en-jin19 Aug 31, 2021
1a9dc7b
modify configuration online: remove unsupported parameters (#6300)
en-jin19 Aug 31, 2021
b1cfdc8
modify configuration online: change a name for consistency (#6301)
en-jin19 Aug 31, 2021
2475ad9
Migrate from Aurora: update Aurora MySQL dumpling command (#6335)
en-jin19 Aug 31, 2021
0acc446
PD configuration file: add log level (#6302)
en-jin19 Aug 31, 2021
2297e8c
TiDB Binlog config: update "syncer.to.checkpoint" info (#6340)
en-jin19 Aug 31, 2021
cd4fc92
update doc on wal-recovery-mode and use-direct-io-for-flush-and-compa…
ekexium Aug 31, 2021
7cf0a70
Fix TOC display error (#6369)
TomShawn Sep 1, 2021
4e9077b
sql: fix the correctness problem about kill (#6377)
hawkingrei Sep 3, 2021
7f8909a
change expressions related to statement summary tables (#6299)
Liuxiaozhen12 Sep 3, 2021
8a821c5
Update grafana-pd-dashboard.md (#6388)
shichun-0415 Sep 6, 2021
4654805
system variables: update description about `tidb_opt_prefer_range_sca…
en-jin19 Sep 6, 2021
9240af4
Update alert rule for low space (#6376)
Liuxiaozhen12 Sep 8, 2021
e57a95f
chore: add dispatch back (#6404)
YiniXu9506 Sep 8, 2021
5f16115
Add description for TiKV Ready handled panel (#6375)
Liuxiaozhen12 Sep 8, 2021
7c6c1de
TiKV config: fix wrong description about `compaction-readahead-size` …
en-jin19 Sep 8, 2021
391e4bb
update transaction doc (#6158)
you06 Sep 8, 2021
9e53b40
BR FAQ: add a warning about multi br importing (#6263)
en-jin19 Sep 8, 2021
5a56bcc
Configuration Options: remove two TiDB's command options (#6370)
en-jin19 Sep 8, 2021
efd371e
system-variables: improve noop functions warning (#6374)
morgo Sep 9, 2021
7db1f25
add doc links to overview.md (#6422)
septemberfd Sep 9, 2021
b8d3b32
chore: fix byte encode (#6428)
YiniXu9506 Sep 9, 2021
c666f05
performance_schema -> information_schema (#6418)
Sep 9, 2021
815ed6f
chore: update ci scripts (#6429)
YiniXu9506 Sep 9, 2021
bea12de
Enhance TiDB login descriptions - EN (#6427)
septemberfd Sep 9, 2021
055dbf2
release-notes: add 5.2.1 release notes (#6438)
Liuxiaozhen12 Sep 9, 2021
b2e70ce
basic features: add feature matrix (#6130)
morgo Sep 9, 2021
380d0df
release note: add a check item for feedback-probability (#6405)
shichun-0415 Sep 10, 2021
f42e8fd
Update system variables for correctness (#6224)
morgo Sep 10, 2021
c05d1be
encryption-at-rest: Update (#6152)
dveeden Sep 10, 2021
db2cf9f
basic-features: collapse charset and collations (#6452)
morgo Sep 14, 2021
978ab09
system-variables: update from generated source (#6451)
morgo Sep 14, 2021
c432539
fix-enable-compaction-filter-in-tikv-configuration-file (#6403)
yiduoyunQ Sep 14, 2021
4167cb4
Update the related variable description for CREATE INDEX (#6434)
shichun-0415 Sep 14, 2021
f4df9ba
TiKV config: add 7 log-related congifurations (#6372)
en-jin19 Sep 14, 2021
0c0f0df
Configure placement rules: fix placement doc (#6450)
en-jin19 Sep 14, 2021
127cf5e
adopters: add Pinterest (#6443)
CaitinChen Sep 14, 2021
65da1a2
release-5.2.0: Add info about caching_sha2 (#6344)
dveeden Sep 15, 2021
0ffaffd
faq: add info for schema is changed error (#6453)
Liuxiaozhen12 Sep 15, 2021
ca96473
Update enable-tls-between-clients-and-servers.md (#6493)
mjonss Sep 17, 2021
3d57559
adopters: remove Pinterest (#6501)
CaitinChen Sep 22, 2021
1677eb8
Fix wrong wording in mysql-compatibility.md (#6511)
TomShawn Sep 23, 2021
351d1eb
adopters: add Huya Live (#6516)
CaitinChen Sep 23, 2021
b3bd7db
tidb-configuration-file: correct the default value of committer-concu…
shichun-0415 Sep 24, 2021
3c2e0ff
Tune TiKV: change the default value of `grpc-concurrency` (#6531)
en-jin19 Sep 26, 2021
0490cd1
releases: add tidb 4.0.15 release notes (#6475)
ti-srebot Sep 27, 2021
89b51be
releases: add tidb 5.0.4 release notes (#6449)
ti-srebot Sep 27, 2021
31723b8
releases: add tidb 5.1.2 release notes (#6500)
ti-srebot Sep 27, 2021
05b0dbe
remove a note about `raftstore.sync-log` (#6563)
en-jin19 Sep 29, 2021
0529abe
Add desc of "Storage Write Stall" row in the TiFlash grafana (#6524)
JaySon-Huang Sep 29, 2021
cf1325b
system variables: update tidb_enable_noop_functions behavior (#6525)
unconsolable Sep 29, 2021
602e062
system variables: document last_insert_id (#6502)
morgo Sep 29, 2021
ca169c4
docs: update pd-configuration about upgrade (#6510)
Liuxiaozhen12 Sep 29, 2021
f88e91d
fix example for expression index (#6499)
shichun-0415 Sep 29, 2021
8d2c1ab
tidb: fix default value of performance.committer-concurrency (#6498)
shichun-0415 Sep 29, 2021
8cbbb2c
chore: remove circleci config (#6577)
YiniXu9506 Sep 30, 2021
29d0d47
Document missing sysvars (#6485)
dveeden Sep 30, 2021
13dc9a4
system-variables: add skip-name-resolve (#6491)
morgo Sep 30, 2021
4d728aa
Document a few more system variables (#6492)
dveeden Sep 30, 2021
8efd451
add dr auto sync (#6592)
Liuxiaozhen12 Oct 8, 2021
d1ea458
Merge remote-tracking branch 'upstream/master' into refactor-migratio…
TomShawn Oct 8, 2021
464bf4b
Update from master
TomShawn Oct 8, 2021
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
126 changes: 0 additions & 126 deletions .circleci/config.yml

This file was deleted.

7 changes: 7 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,14 @@

<!-- Fill in "x" in [] to tick the checkbox below.-->

**Tips for choosing the affected version(s):**

By default, **CHOOSE MASTER ONLY** so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, **CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER**.

For details, see [tips for choosing the affected versions](https://github.com/pingcap/docs/blob/master/CONTRIBUTING.md#guideline-for-choosing-the-affected-versions).

- [ ] master (the latest development version)
- [ ] v5.2 (TiDB 5.2 versions)
- [ ] v5.1 (TiDB 5.1 versions)
- [ ] v5.0 (TiDB 5.0 versions)
- [ ] v4.0 (TiDB 4.0 versions)
Expand Down
45 changes: 33 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,13 @@ Before you contribute, please take a quick look at some general information abou

### Learn about docs versions

Currently, we maintain six versions of TiDB documentation, each with a separate branch:
Currently, we maintain the following versions of TiDB documentation, each with a separate branch:

| Docs branch name | Version description |
| :--- | :--- |
| `master` branch | the latest development version |
| `release-5.1` branch | the 5.1 version |
| `release-5.2` branch | the 5.2 stable version |
| `release-5.1` branch | the 5.1 stable version |
| `release-5.0` branch | the 5.0 stable version |
| `release-4.0` branch | the 4.0 stable version |
| `release-3.1` branch | the 3.1 stable version |
Expand All @@ -45,22 +46,25 @@ Currently, we maintain six versions of TiDB documentation, each with a separate
>
> Previously, we maintain all versions in the `master` branch, with directories like `dev` (the latest development version), `v3.0` and so on. Each docs version is updated very frequently and changes to one version often apply to another version or other versions as well.
>
> Since February 21, 2020, to reduce manual editing and updating work among versions, we have started to maintain each version in a separate branch and introduce sre-bot to automatically file PRs to other versions as long as you add corresponding cherry-pick labels to your PR.
> Since February 21, 2020, to reduce manual editing and updating work among versions, we have started to maintain each version in a separate branch and introduced sre-bot (now ti-chi-bot) to automatically file PRs to other versions as long as you add corresponding cherry-pick labels to your PR.

### Use cherry-pick labels

- If your changes apply to only one docs version, just submit a PR to the corresponding version branch.

- If your changes apply to multiple docs versions, you don't have to submit a PR to each branch. Instead, after you submit your PR, trigger the sre-bot to submit a PR to other version branches by adding one or several of the following labels as needed. Once the current PR is merged, sre-bot will start to work.
- `needs-cherry-pick-5.1` label: sre-bot will submit a PR to the `release-5.1` branch.
- `needs-cherry-pick-5.0` label: sre-bot will submit a PR to the `release-5.0` branch.
- `needs-cherry-pick-4.0` label: sre-bot will submit a PR to the `release-4.0` branch.
- `needs-cherry-pick-3.1` label: sre-bot will submit a PR to the `release-3.1` branch.
- `needs-cherry-pick-3.0` label: sre-bot will submit a PR to the `release-3.0` branch.
- `needs-cherry-pick-2.1` label: sre-bot will submit a PR to the `release-2.1` branch.
- `needs-cherry-pick-master` label: sre-bot will submit a PR to the `master` branch.
- If your changes apply to multiple docs versions, you don't have to submit a PR to each branch. Instead, after you submit your PR, trigger the ti-chi-bot to submit a PR to other version branches by adding one or several of the following labels as needed. Once the current PR is merged, ti-chi-bot will start to work.
- `needs-cherry-pick-5.2` label: ti-chi-bot will submit a PR to the `release-5.2` branch.
- `needs-cherry-pick-5.1` label: ti-chi-bot will submit a PR to the `release-5.1` branch.
- `needs-cherry-pick-5.0` label: ti-chi-bot will submit a PR to the `release-5.0` branch.
- `needs-cherry-pick-4.0` label: ti-chi-bot will submit a PR to the `release-4.0` branch.
- `needs-cherry-pick-3.1` label: ti-chi-bot will submit a PR to the `release-3.1` branch.
- `needs-cherry-pick-3.0` label: ti-chi-bot will submit a PR to the `release-3.0` branch.
- `needs-cherry-pick-2.1` label: ti-chi-bot will submit a PR to the `release-2.1` branch.
- `needs-cherry-pick-master` label: ti-chi-bot will submit a PR to the `master` branch.

- If most of your changes apply to multiple docs versions but some differences exist among versions, you still can use cherry-pick labels to let sre-bot create PRs to other versions. After the PR to another version is successfully submitted by sre-bot, you can make changes to that PR.
For how to choose the docs versions, refer to [Guideline for choosing the affected version(s)](#guideline-for-choosing-the-affected-versions).

- If most of your changes apply to multiple docs versions but some differences exist among versions, you still can use cherry-pick labels to let ti-chi-bot create PRs to other versions. After the PR to another version is successfully submitted by ti-chi-bot, you can make changes to that PR.

## How to contribute

Expand Down Expand Up @@ -142,6 +146,23 @@ git push -u origin new-branch-name # "-u" is used to track the remote branch fro

Now, your PR is successfully submitted! After this PR is merged, you will automatically become a contributor to TiDB documentation.

## Guideline for choosing the affected version(s)

When you create a Pull Request, you need to choose the release version to which your document change applies in the description template on your Pull Request page.

If your change fits one of the following situations, it is recommended to **CHOOSE THE MASTER BRANCH ONLY**. After the PR is merged, the change will be soon displayed on the [Dev page of the PingCAP documentation website](https://docs.pingcap.com/tidb/dev/). After the next major or minor version of TiDB is released, the change will also be displayed on the website page for the new version.

- Relates to a documentation enhancement, such as supplementing missing or incomplete document contents.
- Fixes inaccurate or incorrect document contents, including values, descriptions, examples, or typos.
- Involves a documentation refactor in a specific topic module.

If your change fits one of the following situations, **CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER**:

- Involves a feature behavior change that relates to a specific version.
- Involves a compatibility change, including changing the default value of a configuration item or a system variable.
- Fixes format to resolve a display error
- Fixes broken links

## Contact

Join the Slack channel: [#sig-docs](https://slack.tidb.io/invite?team=tidb-community&channel=sig-docs&ref=pingcap-docs)
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Currently, we maintain the following versions of TiDB documentation in different
| Branch name | TiDB docs version |
| :---------|:----------|
| [`master`](https://github.com/pingcap/docs/tree/master) | The latest development version |
| [`release-5.1`](https://github.com/pingcap/docs/tree/release-5.1) | 5.1 version |
| [`release-5.2`](https://github.com/pingcap/docs/tree/release-5.2) | 5.2 stable version |
| [`release-5.1`](https://github.com/pingcap/docs/tree/release-5.1) | 5.1 stable version |
| [`release-5.0`](https://github.com/pingcap/docs/tree/release-5.0) | 5.0 stable version |
| [`release-4.0`](https://github.com/pingcap/docs/tree/release-4.0) | 4.0 stable version |
| [`release-3.1`](https://github.com/pingcap/docs/tree/release-3.1) | 3.1 stable version |
Expand Down
26 changes: 21 additions & 5 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,22 @@

+ About TiDB
+ [TiDB Introduction](/overview.md)
+ [TiDB 5.1 Release Notes](/releases/release-5.1.0.md)
+ [TiDB 5.2 Release Notes](/releases/release-5.2.0.md)
+ [Basic Features](/basic-features.md)
+ [Experimental Features](/experimental-features.md)
+ Benchmarks
+ [v5.1 Sysbench Performance Test Report](/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md)
+ [v5.1 TPC-C Performance Test Report](/benchmark/v5.1-performance-benchmarking-with-tpcc.md)
+ [v5.1 MPP mode TPC-H 100GB Performance Test](/benchmark/v5.1-performance-benchmarking-with-tpch.md)
+ [v5.2 Sysbench Performance Test Report](/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md)
+ [v5.2 TPC-C Performance Test Report](/benchmark/v5.2-performance-benchmarking-with-tpcc.md)
+ [v5.2 MPP mode TPC-H 100GB Performance Test](/benchmark/v5.2-performance-benchmarking-with-tpch.md)
+ [MySQL Compatibility](/mysql-compatibility.md)
+ [TiDB Limitations](/tidb-limitations.md)
+ [TiDB Adopters](/adopters.md)
+ [Credits](/credits.md)
+ Quick Start
+ [Try Out TiDB](/quick-start-with-tidb.md)
+ [Try Out HTAP](/quick-start-with-htap.md)
+ [Learn TiDB SQL](/basic-sql-operations.md)
+ [Learn HTAP](/explore-htap.md)
+ [Import Example Database](/import-example-data.md)
+ Deploy
+ [Software and Hardware Requirements](/hardware-and-software-requirements.md)
Expand Down Expand Up @@ -158,6 +160,7 @@
+ Tutorials
+ [Multiple Data Centers in One City Deployment](/multi-data-centers-in-one-city-deployment.md)
+ [Three Data Centers in Two Cities Deployment](/three-data-centers-in-two-cities-deployment.md)
+ [Two Data Centers in One City Deployment](/two-data-centers-in-one-city-deployment.md)
+ Read Historical Data
+ Use Stale Read (Recommended)
+ [Usage Scenarios of Stale Read](/stale-read.md)
Expand Down Expand Up @@ -226,6 +229,7 @@
+ [Maintain](/ticdc/manage-ticdc.md)
+ [Troubleshoot](/ticdc/troubleshoot-ticdc.md)
+ [Monitor](/ticdc/monitor-ticdc.md)
+ [TiCDC OpenAPI](/ticdc/ticdc-open-api.md)
+ [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md)
+ [Integrate TiDB with Confluent Platform](/ticdc/integrate-confluent-using-ticdc.md)
+ [Glossary](/ticdc/ticdc-glossary.md)
Expand Down Expand Up @@ -284,6 +288,7 @@
+ [`ADMIN CHECKSUM TABLE`](/sql-statements/sql-statement-admin-checksum-table.md)
+ [`ADMIN CHECK [TABLE|INDEX]`](/sql-statements/sql-statement-admin-check-table-index.md)
+ [`ADMIN SHOW DDL [JOBS|QUERIES]`](/sql-statements/sql-statement-admin-show-ddl.md)
+ [`ADMIN SHOW TELEMETRY`](/sql-statements/sql-statement-admin-show-telemetry.md)
+ [`ALTER DATABASE`](/sql-statements/sql-statement-alter-database.md)
+ [`ALTER INDEX`](/sql-statements/sql-statement-alter-index.md)
+ [`ALTER INSTANCE`](/sql-statements/sql-statement-alter-instance.md)
Expand Down Expand Up @@ -468,6 +473,7 @@
+ [`METRICS_TABLES`](/information-schema/information-schema-metrics-tables.md)
+ [`PARTITIONS`](/information-schema/information-schema-partitions.md)
+ [`PROCESSLIST`](/information-schema/information-schema-processlist.md)
+ [`REFERENTIAL_CONSTRAINTS`](/information-schema/information-schema-referential-constraints.md)
+ [`SCHEMATA`](/information-schema/information-schema-schemata.md)
+ [`SEQUENCES`](/information-schema/information-schema-sequences.md)
+ [`SESSION_VARIABLES`](/information-schema/information-schema-session-variables.md)
Expand Down Expand Up @@ -509,6 +515,9 @@
+ [Use Diagnostics](/dashboard/dashboard-diagnostics-usage.md)
+ [Search Logs Page](/dashboard/dashboard-log-search.md)
+ [Profile Instances Page](/dashboard/dashboard-profiling.md)
+ Session Management and Configuration
+ [Share Session](/dashboard/dashboard-session-share.md)
+ [Configure SSO](/dashboard/dashboard-session-sso.md)
+ [FAQ](/dashboard/dashboard-faq.md)
+ CLI
+ [tikv-ctl](/tikv-control.md)
Expand Down Expand Up @@ -565,16 +574,23 @@
+ [Glossary](/glossary.md)
+ Release Notes
+ [All Releases](/releases/release-notes.md)
+ [TiDB Roadmap](/roadmap.md)
+ v5.2
+ [5.2.1](/releases/release-5.2.1.md)
+ [5.2.0](/releases/release-5.2.0.md)
+ v5.1
+ [5.1.2](/releases/release-5.1.2.md)
+ [5.1.1](/releases/release-5.1.1.md)
+ [5.1.0](/releases/release-5.1.0.md)
+ v5.0
+ [5.0.4](/releases/release-5.0.4.md)
+ [5.0.3](/releases/release-5.0.3.md)
+ [5.0.2](/releases/release-5.0.2.md)
+ [5.0.1](/releases/release-5.0.1.md)
+ [5.0 GA](/releases/release-5.0.0.md)
+ [5.0.0-rc](/releases/release-5.0.0-rc.md)
+ v4.0
+ [4.0.15](/releases/release-4.0.15.md)
+ [4.0.14](/releases/release-4.0.14.md)
+ [4.0.13](/releases/release-4.0.13.md)
+ [4.0.12](/releases/release-4.0.12.md)
+ [4.0.11](/releases/release-4.0.11.md)
Expand Down
8 changes: 5 additions & 3 deletions _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ aliases: ['/docs/dev/']

[TiDB](https://github.com/pingcap/tidb) (/’taɪdiːbi:/, "Ti" stands for Titanium) is an open-source, distributed, NewSQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability. TiDB can be deployed on-premise or in-cloud.

Designed for the cloud, TiDB provides flexible scalability, reliability and security on the cloud platform. Users can elastically scale TiDB to meet the requirements of their changing workloads. [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/tidb-operator-overview) helps manage TiDB on Kubernetes and automates operating tasks, which makes TiDB easier to deploy on any cloud that provides managed Kubernetes. [TiDB Cloud](https://pingcap.com/products/tidbcloud) (Beta), the fully-managed TiDB service, is the easiest, most economical, and most resilient way to unlock the full power of [TiDB in the cloud](https://docs.pingcap.com/tidbcloud/beta), allowing you to deploy and run TiDB clusters with just a few clicks.
Designed for the cloud, TiDB provides flexible scalability, reliability and security on the cloud platform. Users can elastically scale TiDB to meet the requirements of their changing workloads. [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/tidb-operator-overview) helps manage TiDB on Kubernetes and automates operating tasks, which makes TiDB easier to deploy on any cloud that provides managed Kubernetes. [TiDB Cloud](https://pingcap.com/products/tidbcloud) (Public Preview), the fully-managed TiDB service, is the easiest, most economical, and most resilient way to unlock the full power of [TiDB in the cloud](https://docs.pingcap.com/tidbcloud/beta), allowing you to deploy and run TiDB clusters with just a few clicks.

<NavColumns>
<NavColumn>
<ColumnTitle>About TiDB</ColumnTitle>

- [TiDB Introduction](/overview.md)
- [Basic Features](/basic-features.md)
- [TiDB 5.1 Release Notes](/releases/release-5.1.0.md)
- [TiDB 5.2 Release Notes](/releases/release-5.2.0.md)
- [Compatibility with MySQL](/mysql-compatibility.md)
- [Usage Limitations](/tidb-limitations.md)
- [TiDB Adopters](/adopters.md)
Expand All @@ -26,8 +26,10 @@ Designed for the cloud, TiDB provides flexible scalability, reliability and secu
<NavColumn>
<ColumnTitle>Quick Start</ColumnTitle>

- [Quick Start Guide](/quick-start-with-tidb.md)
- [Quick Start with TiDB](/quick-start-with-tidb.md)
- [Quick Start with HTAP](/quick-start-with-htap.md)
- [Explore SQL with TiDB](/basic-sql-operations.md)
- [Explore HTAP](/explore-htap.md)

</NavColumn>

Expand Down
Loading