Skip to content

Commit

Permalink
chores: update from master (#6594)
Browse files Browse the repository at this point in the history
* Dumping default consistency description (#5985)

* update max-replicas description (#5984)

* Remove the swappiness parameter (#5987)

* system-variables: update for consistency (#5826)

* Change tidb_memory_usage_alarm_ratio scope to instance (#5988)

* Punctuation fix: Replace 。with . (#6002)

* index page: updated the phase of TiDB Cloud from Beta to Public Preview (#6014)

* Migration FAQs: added the FAQ links of the migration related tools (#6010)

* TiUP cluster: update data_dir (#6009)

* Add kafka downstream example (#6005)

* TiKV configuration: Update description for pin-l0-filter-and-index-blocks (#6008)

* Update the default value of tidb_stmt_summary_max_stmt_count (#6021) (#6023)

* update docs related to partition table dynamic mode (#5997)

* partitioning: Corrected partition management (#5498)

* TiDB binlog: update descriptions about commit ts and passoword (#5986)

* releases: add tidb 4.0.14 release notes (#5996)

* fix a typo for sync_diff_inspector (#6041)

* Update dashboard FAQ (#5895)

* update stale read doc for ga (#6047)

* configure-time-zone: mention `system_time_zone` (#6032)

* Update Security Compatibility with MySQL (#5921)

* correct document of using br backup and restore system tables (#6057)

* Add description about telemetry of builtin functions usage (#6028)

* Add TiDB Dashboard session docs (#6058)

* update br faq (#6060)

* releases: add TiDB 5.1.1 release notes (#6030)

* grafana-overview-dashboard: update the monitoring item for CPS (#6066)

* deploy-tidb-binlog: make the expression on deployment clearer (#6073)

* Add documentation on how to modify gcttl by tiup (#6071)

* remove useless variable (#6076)

* ticdc: add mysql sink user privilege (#6072)

* deleted roadmap.md (#6079)

* TiDB Monitoring Metrics: remove a line (#6081)

* TiDB configuration: add a security option `require-secure-transport` (#6080)

* chore: lock plugin versions (#6089)

* cdc: add compatibility notes for sort-dir (#6086)

* Add gc ttl (#6102) (#6103)

* 5.1.0 release notes: Fix link to telemetry docs (#6106)

* sql-statement-select: Add '...FOR UPDATE NOWAIT' (#6085)

* TiCDC: update a golang demo link (#6055)

* br/use-br-command-line-tool: supplement br note (#6000)

* pr_template: Provides tips for cherry-pick (#6042)

* pr_template: Provides tips for cherry-pick

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* TiDB monitoring: add table storage info status api (#6110)

* update doc for Oracle translate function (#6053)

* ticdc: add explicit_defaults_for_timestamp compatibility troubleshoot (#6115)

* Add print the bad sst files and related information for tikv-ctl (#6109)

* add a missing note (#6129)

* Add docs for auto-tls setting (#6125)

* TiFlash: remove outdated tune advise (#6133)

* TiDB lightning: remove default backend setting (#6132)

* tidb-scheduling: fix typo (#6140)

* Suggest Log Redaction when using TDE (#6147)

* Add infoschema.referential_constraints (#6139)

* Add steps to get lightning goroutine (#6001)

* tiup: fix dead links (#6153)

* Deleted description about not supporting some features. (#6157)

* high-concurrency-best-practices: fix the support info of follower read (#6161)

* Update function list pushed down to tiflash (#6165)

* The `log_dir` should be the log directory (#6168)

* Make IP address of Monitoring & Grafana for Minimal Topology consistent (#6178)

* tikv: add storage flow control doc (#6173)

* TiDB configuration: update the default value of `stmt_max_count` (#6172)

* ticdc-open-api: add ticdc open api doc (#6186)

* System variables: update `broadcast_join_threshold_count` and `broadc… (#6181)

* Update tikv-configuration-file.md (#6180)

* TiFlash configuration: update `io_rate_limit` (#6176)

* Add information of hashAgg for memory control (#6171)

* Update description on rule based index selection (#6160)

* add dr auto sync (#6182)

* update doc for SPM (#6146)

* docs: update rereject leader docs (#6183)

* SQL statement, system variables: update expression indexes (#6185)

* Updated sql-plan-management.md (#6184)

* Introduced 2 new variables (#6159)

* Fix broken link in error codes doc and support doc (#6196)

* docs: fix format for TiKV and PD configuration file template invalid. (#6197)

* docs: separate query statement and result in two text boxes. (#6204) (#6205)

* adopters: add zhihu case study (#6207)

* Added descriptions about slow node detection (#6174)

* pd-control: add new config of balance-hot-region-scheduler (#6148)

* add notice about scaling in pd node (#6099)

* add example for expression index (#6215)

* adopters: remove 404 links (#6214)

* ticdc: fix wording (#6231)

* Revert "System variables: update `broadcast_join_threshold_count` and `broadc…" (#6232)

* Update documents of lock view for sprint 4 (#6179)

* ticdc-open-api: correct some error (#6239)

* best practices: add timeout options for Java best practices (#6136)

* update PR template for v5.2 (#6166)

* chore: stop building temporary (#6252)

* fix typo for sql-plan-management.md (#6248)

* alert rules: update some descriptions (#6250)

* Quick start: update version and TiUP playground supports M1 silicon (#6149)

* fix typo: relaod -> reload (#6235)

* tiny fix on index selection (#6265)

* add commands to check tikv user (#5999)

* br: add restore to systables (#6004)

* br: add restore to systables

* Apply suggestions from code review

Co-authored-by: TomShawn <[email protected]>

Co-authored-by: TomShawn <[email protected]>

* statement summary: update statement summary doc (#6084)

* Require process privilege for dumpling (#6187)

* tiflash: Remove the description about expr_blacklist in use_tiflash.md (#6188)

* Add description about table name/alias specifying for read_from_storage hint (#6164)

* complex tidb binlog.yaml: add checkpoint info (#6216)

* TiKV configuration: remove redundant instructions (#6218)

* alert rules: remove some descriptions (#6223)

* Revert "add dr auto sync" (#6294)

* TiFlash Config: Add annotation (v5.2.0) (#6296)

* sql: improve kill's description (#6233)

* Add v5.2 TPCH report (#6170)

* docs: fix expression index's document again (#6295)

* system variables.md: add a warning message (#6298)

* sql-statement: Add ADMIN SHOW TELEMETRY (#6138)

* tiup: add notice about importing cluster (#6108)

* Bump version for v5.2.0 (#6191)

* add TiDB 5.2.0 release note (#6237)

* add two HTAP documents (#6206)

* benchmark: add v5.2 benchmark results (#6319)

* Fix title typo (#6324)

* release note: update feature description (#6325)

* adopters: add xiaomi (#6303)

* chore: migrate scripts to docs (#6338)

* credits: update links to the full list of code and docs contributors (#6111)

* TiUP: add instructions for offline mirror (#6137)

* tune tikv memory performance: remove description for sync-log (#6234)

* dashboard statement list: add a note to explain the blue bar and yellow line (#6189)

* release 5.1.0: add compatibility change for `tidb_enable_noop_functions` (#6222)

* modify configuration online: remove unsupported parameters (#6300)

* modify configuration online: change a name for consistency (#6301)

* Migrate from Aurora: update Aurora MySQL dumpling command (#6335)

* PD configuration file: add log level (#6302)

* TiDB Binlog config: update "syncer.to.checkpoint" info (#6340)

* update doc on wal-recovery-mode and use-direct-io-for-flush-and-compaction (#6163)

* Fix TOC display error (#6369)

* sql: fix the correctness problem about kill (#6377)

* change expressions related to statement summary tables (#6299)

* Update grafana-pd-dashboard.md (#6388)

* system variables: update description about `tidb_opt_prefer_range_scan` (#6389)

* Update alert rule for low space (#6376)

* chore: add dispatch back (#6404)

* Add description for TiKV Ready handled panel (#6375)

* TiKV config: fix wrong description about `compaction-readahead-size` (#6371)

* update transaction doc (#6158)

* BR FAQ: add a warning about multi br importing (#6263)

* Configuration Options: remove two TiDB's command options (#6370)

* system-variables: improve noop functions warning (#6374)

* add doc links to overview.md (#6422)

* chore: fix byte encode (#6428)

* performance_schema -> information_schema (#6418)

* chore: update ci scripts (#6429)

* Enhance TiDB login descriptions - EN (#6427)

* release-notes: add 5.2.1 release notes (#6438)

* basic features: add feature matrix (#6130)

* release note: add a check item for feedback-probability (#6405)

* Update system variables for correctness (#6224)

* encryption-at-rest: Update (#6152)

* basic-features: collapse charset and collations (#6452)

* system-variables: update from generated source (#6451)

* fix-enable-compaction-filter-in-tikv-configuration-file (#6403)

* Update the related variable description for CREATE INDEX (#6434)

* TiKV config: add 7 log-related congifurations (#6372)

* Configure placement rules: fix placement doc (#6450)

* adopters: add Pinterest (#6443)

* release-5.2.0: Add info about caching_sha2 (#6344)

* faq: add info for schema is changed error (#6453)

* Update enable-tls-between-clients-and-servers.md (#6493)

* adopters: remove Pinterest (#6501)

* Fix wrong wording in mysql-compatibility.md (#6511)

* adopters: add Huya Live (#6516)

* tidb-configuration-file: correct the default value of committer-concurrency (#6526)

* Tune TiKV: change the default value of `grpc-concurrency` (#6531)

* releases: add tidb 4.0.15 release notes (#6475)

* releases: add tidb 5.0.4 release notes (#6449)

* releases: add tidb 5.1.2 release notes (#6500)

* releases: add TiDB 5.1.2-10-06-33 release notes

* releases: add TiDB 5.1.2-10-06-33 release notes
* Update releases/release-5.1.2-10-06-33.md

* toc

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <[email protected]>

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* add notes from comments

* add more tidb notes

* Update releases/release-5.1.2.md

Co-authored-by: Yuanjia Zhang <[email protected]>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: Enwei <[email protected]>
Co-authored-by: xixirangrang <[email protected]>

* Update releases/release-5.1.2.md

Co-authored-by: shichun-0415 <[email protected]>

* Update releases/release-5.1.2.md

Co-authored-by: Yuanjia Zhang <[email protected]>

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: shichun-0415 <[email protected]>

* replace pr numbers with issue numbers

* Update releases/release-5.1.2.md

Co-authored-by: Liuxiaozhen12 <[email protected]>

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: Enwei <[email protected]>

* fix

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

Co-authored-by: Enwei <[email protected]>

* Update releases/release-5.1.2.md

Co-authored-by: Grace Cai <[email protected]>

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* Apply suggestions from code review

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

Co-authored-by: Enwei <[email protected]>

* Update releases/release-5.1.2.md

Co-authored-by: shichun-0415 <[email protected]>

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* move notes

Co-authored-by: TomShawn <[email protected]>
Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Yuanjia Zhang <[email protected]>
Co-authored-by: Enwei <[email protected]>
Co-authored-by: xixirangrang <[email protected]>
Co-authored-by: shichun-0415 <[email protected]>

* remove a note about `raftstore.sync-log` (#6563)

* Add desc of "Storage Write Stall" row in the TiFlash grafana (#6524)

* system variables: update tidb_enable_noop_functions behavior (#6525)

* system variables: document last_insert_id (#6502)

* docs: update pd-configuration about upgrade (#6510)

* fix example for expression index (#6499)

* tidb: fix default value of performance.committer-concurrency (#6498)

* chore: remove circleci config (#6577)

* Document missing sysvars (#6485)

* system-variables: add skip-name-resolve (#6491)

* Document a few more system variables (#6492)

* add dr auto sync (#6592)

* Update from master

Co-authored-by: Enwei <[email protected]>
Co-authored-by: disksing <[email protected]>
Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: Morgan Tocker <[email protected]>
Co-authored-by: Daniël van Eeden <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Ti Chi Robot <[email protected]>
Co-authored-by: Mattias Jonsson <[email protected]>
Co-authored-by: ti-srebot <[email protected]>
Co-authored-by: glorv <[email protected]>
Co-authored-by: Suhaha <[email protected]>
Co-authored-by: Ian <[email protected]>
Co-authored-by: Yu Lei <[email protected]>
Co-authored-by: Wenxuan <[email protected]>
Co-authored-by: zhouqiang <[email protected]>
Co-authored-by: xixirangrang <[email protected]>
Co-authored-by: Yini Xu <[email protected]>
Co-authored-by: WangZhengru <[email protected]>
Co-authored-by: Xintao <[email protected]>
Co-authored-by: Daniël van Eeden <[email protected]>
Co-authored-by: Allen Zhong <[email protected]>
Co-authored-by: ruoxi <[email protected]>
Co-authored-by: Yasuo Honda <[email protected]>
Co-authored-by: Yasuo Honda <[email protected]>
Co-authored-by: Defined2014 <[email protected]>
Co-authored-by: Ran <[email protected]>
Co-authored-by: Chengpeng Yan <[email protected]>
Co-authored-by: Yifan Xu <[email protected]>
Co-authored-by: Weizhen Wang <[email protected]>
Co-authored-by: Ziqian Qin <[email protected]>
Co-authored-by: shichun-0415 <[email protected]>
Co-authored-by: you06 <[email protected]>
Co-authored-by: Fendy <[email protected]>
Co-authored-by: Kolbe Kegel <[email protected]>
Co-authored-by: jirongq <[email protected]>
Co-authored-by: Caitin <[email protected]>
Co-authored-by: Yuanjia Zhang <[email protected]>
Co-authored-by: JaySon <[email protected]>
Co-authored-by: unconsolable <[email protected]>
  • Loading branch information
Show file tree
Hide file tree
Showing 180 changed files with 6,548 additions and 1,440 deletions.
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

0 comments on commit 7a93371

Please sign in to comment.