Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into pr/17119
Browse files Browse the repository at this point in the history
  • Loading branch information
qiancai committed Jun 11, 2024
2 parents 1acd090 + c36bc84 commit a81b8b8
Show file tree
Hide file tree
Showing 413 changed files with 7,060 additions and 2,570 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ By default, **CHOOSE MASTER ONLY** so your changes will be applied to the next T
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)
- [ ] v8.2 (TiDB 8.2 versions)
- [ ] v8.1 (TiDB 8.1 versions)
- [ ] v8.0 (TiDB 8.0 versions)
- [ ] v7.6 (TiDB 7.6 versions)
- [ ] v7.5 (TiDB 7.5 versions)
- [ ] v7.4 (TiDB 7.4 versions)
- [ ] v7.1 (TiDB 7.1 versions)
- [ ] v6.5 (TiDB 6.5 versions)
- [ ] v6.1 (TiDB 6.1 versions)
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out
uses: actions/checkout@v3
- uses: actions/setup-node@v3
uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: "18"
- name: Verify duplicated file names
Expand All @@ -32,8 +32,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out
uses: actions/checkout@v3
- uses: actions/setup-node@v3
uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: "18"
- name: Check TOC-tidb-cloud.md existence
Expand All @@ -57,7 +57,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Vale Linter
uses: errata-ai/[email protected]
with:
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/cron.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
name: Download translator repo
with:
repository: "shczhen/markdown-translator"
path: "markdown-translator"
- uses: actions/checkout@v3
- uses: actions/checkout@v4
name: Download docs repo and specified branch
with:
ref: "i18n-ja-release-7.5"
path: "docs"
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
name: Setup node 18
with:
node-version: 18
Expand Down Expand Up @@ -68,17 +68,17 @@ jobs:
# runs-on: ubuntu-latest

# steps:
# - uses: actions/checkout@v3
# - uses: actions/checkout@v4
# name: Download translator repo
# with:
# repository: "shczhen/markdown-translator"
# path: "markdown-translator"
# - uses: actions/checkout@v3
# - uses: actions/checkout@v4
# name: Download docs repo and specified branch
# with:
# ref: "i18n-ja-release-7.1"
# path: "docs"
# - uses: actions/setup-node@v3
# - uses: actions/setup-node@v4
# name: Setup node 18
# with:
# node-version: 18
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/ja-full-translation-google.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
name: Download translator repo
with:
repository: "shczhen/markdown-translator"
path: "markdown-translator"
- uses: actions/checkout@v3
- uses: actions/checkout@v4
name: Download specified branch of docs repo
with:
ref: "release-7.5"
ref: "release-8.1"
path: "docs"
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
name: Setup node 18
with:
node-version: 18
Expand Down Expand Up @@ -45,7 +45,7 @@ jobs:
- name: Copy translated files to docs repo
run: |
cd docs
git checkout -b i18n-ja-release-7.5
git checkout -b i18n-ja-release-8.1
cd ..
cp -r markdown-translator/output/markdowns/* docs/
Expand All @@ -61,7 +61,7 @@ jobs:
else
echo "No changes detected, skipped"
fi
git push --set-upstream origin i18n-ja-release-7.5
git push --set-upstream origin i18n-ja-release-8.1
dispatch:
runs-on: ubuntu-latest
Expand All @@ -75,4 +75,4 @@ jobs:
-H "Accept: application/vnd.github+json" \
-H "Authorization: token ${{ secrets.DOCS_STAGING }}" \
https://api.github.com/repos/pingcap/docs-staging/actions/workflows/update.yml/dispatches \
-d '{"ref":"main","inputs":{"full": "false", "repo":"${{ github.repository }}","branch":"i18n-ja-release-7.5"}}'
-d '{"ref":"main","inputs":{"full": "false", "repo":"${{ github.repository }}","branch":"i18n-ja-release-8.1"}}'
2 changes: 1 addition & 1 deletion .github/workflows/link-fail-fast.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 2

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/link.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Download Exclude Path
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/media.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
name: Upload media files
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
# Must use at least depth 2!
fetch-depth: 2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/prevent-deletion.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout base
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Fetch head
run: |
git remote add head ${{ github.event.pull_request.head.repo.clone_url }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/rebase.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout the latest code
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
token: ${{ secrets.REBASE_SECRET_KEY }}
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/translation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
name: Download translator repo
with:
repository: "shczhen/markdown-translator"
ref: "openai"
path: "markdown-translator"
- uses: actions/checkout@v3
- uses: actions/checkout@v4
name: Download docs repo and specified branch
with:
ref: "i18n-ja-release-7.1"
path: "docs"
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
name: Setup node 18
with:
node-version: 18
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Please check out these templates before you submit a pull request:
We use separate branches to maintain different versions of TiDB documentation.

- The [documentation under development](https://docs.pingcap.com/tidb/dev) is maintained in the `master` branch.
- The [published documentation](https://docs.pingcap.com/tidb/stable/) is maintained in the corresponding `release-<verion>` branch. For example, TiDB v7.5 documentation is maintained in the `release-7.5` branch.
- The [published documentation](https://docs.pingcap.com/tidb/stable/) is maintained in the corresponding `release-<version>` branch. For example, TiDB v7.5 documentation is maintained in the `release-7.5` branch.
- The [archived documentation](https://docs-archive.pingcap.com/) is no longer maintained and does not receive any further updates.

### Use cherry-pick labels
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ 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-8.1`](https://github.com/pingcap/docs/tree/release-8.1) | 8.1 LTS (Long-Term Support) |
| [`release-8.0`](https://github.com/pingcap/docs/tree/release-8.0) | 8.0 Development Milestone Release |
| [`release-7.6`](https://github.com/pingcap/docs/tree/release-7.6) | 7.6 Development Milestone Release |
| [`release-7.5`](https://github.com/pingcap/docs/tree/release-7.5) | 7.5 LTS (Long-Term Support) |
| [`release-7.4`](https://github.com/pingcap/docs/tree/release-7.4) | 7.4 Development Milestone Release |
| [`release-7.4`](https://github.com/pingcap/docs/tree/release-7.4) | 7.4 Development Milestone Release (Archived documentation, no longer updated) |
| [`release-7.3`](https://github.com/pingcap/docs/tree/release-7.3) | 7.3 Development Milestone Release (Archived documentation, no longer updated) |
| [`release-7.2`](https://github.com/pingcap/docs/tree/release-7.2) | 7.2 Development Milestone Release (Archived documentation, no longer updated) |
| [`release-7.1`](https://github.com/pingcap/docs/tree/release-7.1) | 7.1 LTS (Long-Term Support) version |
Expand All @@ -47,8 +48,8 @@ Currently, we maintain the following versions of TiDB documentation in different
| [`release-5.3`](https://github.com/pingcap/docs/tree/release-5.3) | 5.3 stable 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-5.0`](https://github.com/pingcap/docs/tree/release-5.0) | 5.0 stable version (Archived documentation, no longer updated) |
| [`release-4.0`](https://github.com/pingcap/docs/tree/release-4.0) | 4.0 stable version (Archived documentation, no longer updated) |
| [`release-3.1`](https://github.com/pingcap/docs/tree/release-3.1) | 3.1 stable version (Archived documentation, no longer updated) |
| [`release-3.0`](https://github.com/pingcap/docs/tree/release-3.0) | 3.0 stable version (Archived documentation, no longer updated) |
| [`release-2.1`](https://github.com/pingcap/docs/tree/release-2.1) | 2.1 stable version (Archived documentation, no longer updated) |
Expand Down
44 changes: 30 additions & 14 deletions TOC-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
- [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md)
- [Navicat](/develop/dev-guide-gui-navicat.md)
- [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md)
- BI
- [Looker Studio](/tidb-cloud/dev-guide-bi-looker-studio.md)
- Java
- [JDBC](/develop/dev-guide-sample-application-java-jdbc.md)
- [MyBatis](/develop/dev-guide-sample-application-java-mybatis.md)
Expand Down Expand Up @@ -253,6 +255,11 @@
- [To Kafka Sink](/tidb-cloud/changefeed-sink-to-apache-kafka.md)
- [To TiDB Cloud Sink](/tidb-cloud/changefeed-sink-to-tidb-cloud.md)
- [To Cloud Storage](/tidb-cloud/changefeed-sink-to-cloud-storage.md)
- Disaster Recovery
- [Recovery Group Overview](/tidb-cloud/recovery-group-overview.md)
- [Get Started](/tidb-cloud/recovery-group-get-started.md)
- [Failover and Reprotect Databases](/tidb-cloud/recovery-group-failover.md)
- [Delete a Recovery Group](/tidb-cloud/recovery-group-delete.md)
- Security
- Identity Access Control
- [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md)
Expand Down Expand Up @@ -283,6 +290,7 @@
- [Billing from AWS or GCP Marketplace](/tidb-cloud/tidb-cloud-billing.md#billing-from-aws-marketplace-or-google-cloud-marketplace)
- [Billing for Changefeed](/tidb-cloud/tidb-cloud-billing-ticdc-rcu.md)
- [Billing for Data Migration](/tidb-cloud/tidb-cloud-billing-dm.md)
- [Billing for Recovery Groups](/tidb-cloud/tidb-cloud-billing-recovery-group.md)
- API
- API
- [API Overview](/tidb-cloud/api-overview.md)
Expand Down Expand Up @@ -348,8 +356,7 @@
- [Expression Syntax](/expression-syntax.md)
- [Comment Syntax](/comment-syntax.md)
- SQL Statements
- [`ADD COLUMN`](/sql-statements/sql-statement-add-column.md)
- [`ADD INDEX`](/sql-statements/sql-statement-add-index.md)
- [Overview](/sql-statements/sql-statement-overview.md)
- [`ADMIN`](/sql-statements/sql-statement-admin.md)
- [`ADMIN CANCEL DDL`](/sql-statements/sql-statement-admin-cancel-ddl.md)
- [`ADMIN CHECKSUM TABLE`](/sql-statements/sql-statement-admin-checksum-table.md)
Expand All @@ -360,20 +367,28 @@
- [`ADMIN RESUME DDL`](/sql-statements/sql-statement-admin-resume-ddl.md)
- [`ADMIN SHOW DDL [JOBS|JOB QUERIES]`](/sql-statements/sql-statement-admin-show-ddl.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)
- [`ALTER PLACEMENT POLICY`](/sql-statements/sql-statement-alter-placement-policy.md)
- [`ALTER RANGE`](/sql-statements/sql-statement-alter-range.md)
- [`ALTER RESOURCE GROUP`](/sql-statements/sql-statement-alter-resource-group.md)
- [`ALTER TABLE`](/sql-statements/sql-statement-alter-table.md)
- [`ALTER TABLE COMPACT`](/sql-statements/sql-statement-alter-table-compact.md)
- [`ALTER SEQUENCE`](/sql-statements/sql-statement-alter-sequence.md)
- `ALTER TABLE`
- [Overview](/sql-statements/sql-statement-alter-table.md)
- [`ADD COLUMN`](/sql-statements/sql-statement-add-column.md)
- [`ADD INDEX`](/sql-statements/sql-statement-add-index.md)
- [`ALTER INDEX`](/sql-statements/sql-statement-alter-index.md)
- [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md)
- [`COMPACT`](/sql-statements/sql-statement-alter-table-compact.md)
- [`DROP COLUMN`](/sql-statements/sql-statement-drop-column.md)
- [`DROP INDEX`](/sql-statements/sql-statement-drop-index.md)
- [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md)
- [`RENAME INDEX`](/sql-statements/sql-statement-rename-index.md)
- [`ALTER USER`](/sql-statements/sql-statement-alter-user.md)
- [`ANALYZE TABLE`](/sql-statements/sql-statement-analyze-table.md)
- [`BACKUP`](/sql-statements/sql-statement-backup.md)
- [`BATCH`](/sql-statements/sql-statement-batch.md)
- [`BEGIN`](/sql-statements/sql-statement-begin.md)
- [`CANCEL IMPORT JOB`](/sql-statements/sql-statement-cancel-import-job.md)
- [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md)
- [`COMMIT`](/sql-statements/sql-statement-commit.md)
- [`CREATE [GLOBAL|SESSION] BINDING`](/sql-statements/sql-statement-create-binding.md)
- [`CREATE DATABASE`](/sql-statements/sql-statement-create-database.md)
Expand All @@ -392,7 +407,6 @@
- [`DESCRIBE`](/sql-statements/sql-statement-describe.md)
- [`DO`](/sql-statements/sql-statement-do.md)
- [`DROP [GLOBAL|SESSION] BINDING`](/sql-statements/sql-statement-drop-binding.md)
- [`DROP COLUMN`](/sql-statements/sql-statement-drop-column.md)
- [`DROP DATABASE`](/sql-statements/sql-statement-drop-database.md)
- [`DROP INDEX`](/sql-statements/sql-statement-drop-index.md)
- [`DROP PLACEMENT POLICY`](/sql-statements/sql-statement-drop-placement-policy.md)
Expand Down Expand Up @@ -421,11 +435,9 @@
- [`LOAD STATS`](/sql-statements/sql-statement-load-stats.md)
- [`LOCK STATS`](/sql-statements/sql-statement-lock-stats.md)
- [`LOCK TABLES` and `UNLOCK TABLES`](/sql-statements/sql-statement-lock-tables-and-unlock-tables.md)
- [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md)
- [`PREPARE`](/sql-statements/sql-statement-prepare.md)
- [`QUERY WATCH`](/sql-statements/sql-statement-query-watch.md)
- [`RECOVER TABLE`](/sql-statements/sql-statement-recover-table.md)
- [`RENAME INDEX`](/sql-statements/sql-statement-rename-index.md)
- [`RENAME TABLE`](/sql-statements/sql-statement-rename-table.md)
- [`RENAME USER`](/sql-statements/sql-statement-rename-user.md)
- [`REPLACE`](/sql-statements/sql-statement-replace.md)
Expand All @@ -448,7 +460,8 @@
- [`SHOW BUILTINS`](/sql-statements/sql-statement-show-builtins.md)
- [`SHOW CHARACTER SET`](/sql-statements/sql-statement-show-character-set.md)
- [`SHOW COLLATION`](/sql-statements/sql-statement-show-collation.md)
- [`SHOW [FULL] COLUMNS FROM`](/sql-statements/sql-statement-show-columns-from.md)
- [`SHOW COLUMN_STATS_USAGE`](/sql-statements/sql-statement-show-column-stats-usage.md)
- [`SHOW COLUMNS FROM`](/sql-statements/sql-statement-show-columns-from.md)
- [`SHOW CREATE DATABASE`](/sql-statements/sql-statement-show-create-database.md)
- [`SHOW CREATE PLACEMENT POLICY`](/sql-statements/sql-statement-show-create-placement-policy.md)
- [`SHOW CREATE RESOURCE GROUP`](/sql-statements/sql-statement-show-create-resource-group.md)
Expand All @@ -458,7 +471,7 @@
- [`SHOW DATABASES`](/sql-statements/sql-statement-show-databases.md)
- [`SHOW ENGINES`](/sql-statements/sql-statement-show-engines.md)
- [`SHOW ERRORS`](/sql-statements/sql-statement-show-errors.md)
- [`SHOW [FULL] FIELDS FROM`](/sql-statements/sql-statement-show-fields-from.md)
- [`SHOW FIELDS FROM`](/sql-statements/sql-statement-show-fields-from.md)
- [`SHOW GRANTS`](/sql-statements/sql-statement-show-grants.md)
- [`SHOW IMPORT JOB`](/sql-statements/sql-statement-show-import-job.md)
- [`SHOW INDEXES [FROM|IN]`](/sql-statements/sql-statement-show-indexes.md)
Expand All @@ -468,18 +481,20 @@
- [`SHOW PLACEMENT LABELS`](/sql-statements/sql-statement-show-placement-labels.md)
- [`SHOW PLUGINS`](/sql-statements/sql-statement-show-plugins.md)
- [`SHOW PRIVILEGES`](/sql-statements/sql-statement-show-privileges.md)
- [`SHOW [FULL] PROCESSSLIST`](/sql-statements/sql-statement-show-processlist.md)
- [`SHOW PROCESSSLIST`](/sql-statements/sql-statement-show-processlist.md)
- [`SHOW PROFILES`](/sql-statements/sql-statement-show-profiles.md)
- [`SHOW SCHEMAS`](/sql-statements/sql-statement-show-schemas.md)
- [`SHOW STATS_BUCKETS`](/sql-statements/sql-statement-show-stats-buckets.md)
- [`SHOW STATS_HEALTHY`](/sql-statements/sql-statement-show-stats-healthy.md)
- [`SHOW STATS_HISTOGRAMS`](/sql-statements/sql-statement-show-histograms.md)
- [`SHOW STATS_HISTOGRAMS`](/sql-statements/sql-statement-show-stats-histograms.md)
- [`SHOW STATS_LOCKED`](/sql-statements/sql-statement-show-stats-locked.md)
- [`SHOW STATS_META`](/sql-statements/sql-statement-show-stats-meta.md)
- [`SHOW STATS_TOPN`](/sql-statements/sql-statement-show-stats-topn.md)
- [`SHOW STATUS`](/sql-statements/sql-statement-show-status.md)
- [`SHOW TABLE NEXT_ROW_ID`](/sql-statements/sql-statement-show-table-next-rowid.md)
- [`SHOW TABLE REGIONS`](/sql-statements/sql-statement-show-table-regions.md)
- [`SHOW TABLE STATUS`](/sql-statements/sql-statement-show-table-status.md)
- [`SHOW [FULL] TABLES`](/sql-statements/sql-statement-show-tables.md)
- [`SHOW TABLES`](/sql-statements/sql-statement-show-tables.md)
- [`SHOW [GLOBAL|SESSION] VARIABLES`](/sql-statements/sql-statement-show-variables.md)
- [`SHOW WARNINGS`](/sql-statements/sql-statement-show-warnings.md)
- [`SPLIT REGION`](/sql-statements/sql-statement-split-region.md)
Expand Down Expand Up @@ -518,6 +533,7 @@
- [Miscellaneous Functions](/functions-and-operators/miscellaneous-functions.md)
- [Precision Math](/functions-and-operators/precision-math.md)
- [Set Operations](/functions-and-operators/set-operators.md)
- [Sequence Functions](/functions-and-operators/sequence-functions.md)
- [List of Expressions for Pushdown](/functions-and-operators/expressions-pushed-down.md)
- [TiDB Specific Functions](/functions-and-operators/tidb-functions.md)
- [Clustered Indexes](/clustered-indexes.md)
Expand Down
Loading

0 comments on commit a81b8b8

Please sign in to comment.