Add gc ttl86400

.circleci/config.yml

@@ -17,11 +17,18 @@ jobs:
             echo 'export NODE_PATH=~/.npm-global/lib/node_modules:$NODE_PATH' >> $BASH_ENV
 
       - run:
-          name: "Check git conflicts"
+          name: "Check file encoding"
           command: |
             git remote add upstream https://github.com/pingcap/docs.git
             git fetch upstream
-            python3 scripts/check-conflicts.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' '*.yml' '*.yaml')
+            wget https://raw.githubusercontent.com/CharLotteiu/pingcap-docs-checks/main/check-file-encoding.py
+            python3 check-file-encoding.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
+
+      - run:
+          name: "Check git conflicts"
+          command: |
+            wget https://raw.githubusercontent.com/CharLotteiu/pingcap-docs-checks/main/check-conflicts.py
+            python3 check-conflicts.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' '*.yml' '*.yaml')
 
       - run:
           name: "Install markdownlint"
@@ -43,10 +50,23 @@ jobs:
           command: |
             scripts/verify-link-anchors.sh
 
+      - run:
+          name: "Check control characters"
+          command: |
+            wget https://raw.githubusercontent.com/CharLotteiu/pingcap-docs-checks/main/check-control-char.py
+            python3 check-control-char.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
+
       - run:
           name: "Check unclosed tags"
           command: |
-            python3 scripts/check-tags.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
+            wget https://raw.githubusercontent.com/CharLotteiu/pingcap-docs-checks/main/check-tags.py
+            python3 check-tags.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
+
+      - run:
+          name: "Check manual line breaks"
+          command: |
+            wget https://raw.githubusercontent.com/CharLotteiu/pingcap-docs-checks/main/check-manual-line-breaks.py
+            python3 check-manual-line-breaks.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
 
   build:
     docker:

.github/ISSUE_TEMPLATE/change-request.md

@@ -5,8 +5,9 @@ about: Any suggestion? Want to add something new?
 
 ## Change Request
 
-**This repository is ONLY used to solve issues related to DOCS.
-For other issues (related to TiDB, PD, etc), please move to [other repositories](https://github.com/pingcap/).**
+<!-- This repository is ONLY used to solve issues related to DOCS.
+To discuss technical details or report a bug, please move to [other repositories](https://github.com/pingcap/).
+If you have problems using the product and need technical support, [join our Slack channel](https://slack.tidb.io/invite?team=tidb-community&channel=everyone&ref=pingcap-docs).-->
 
 Please answer the following questions before submitting your issue. Thanks!
 

.github/ISSUE_TEMPLATE/error-report.md

@@ -5,8 +5,9 @@ about: Typos, grammatical errors, terminology misuse, ambiguity, etc.
 
 ## Error Report
 
-**This repository is ONLY used to solve issues related to DOCS.
-For other issues (related to TiDB, PD, etc), please move to [other repositories](https://github.com/pingcap/).**
+<!-- This repository is ONLY used to solve issues related to DOCS.
+To discuss technical details or report a bug, please move to [other repositories](https://github.com/pingcap/).
+If you have problems using the product and need technical support, [join our Slack channel](https://slack.tidb.io/invite?team=tidb-community&channel=everyone&ref=pingcap-docs).-->
 
 Please answer the following questions before submitting your issue. Thanks!
 

.github/ISSUE_TEMPLATE/question.md

@@ -5,8 +5,9 @@ about: Usage question that isn't answered in docs or discussion
 
 ## Question
 
-**This repository is ONLY used to solve issues related to DOCS.
-For other issues (related to TiDB, PD, etc), please move to [other repositories](https://github.com/pingcap/).**
+<!-- This repository is ONLY used to solve issues related to DOCS.
+To discuss technical details or report a bug, please move to [other repositories](https://github.com/pingcap/).
+If you have problems using the product and need technical support, [join our Slack channel](https://slack.tidb.io/invite?team=tidb-community&channel=everyone&ref=pingcap-docs).-->
 
 Before submitting your question, make sure you have:
 

.github/pull_request_template.md

@@ -13,6 +13,8 @@
 <!-- Fill in "x" in [] to tick the checkbox below.-->
 
 - [ ] master (the latest development version)
+- [ ] v5.1 (TiDB 5.1 versions)
+- [ ] v5.0 (TiDB 5.0 versions)
 - [ ] v4.0 (TiDB 4.0 versions)
 - [ ] v3.1 (TiDB 3.1 versions)
 - [ ] v3.0 (TiDB 3.0 versions)

.github/workflows/dispatch.yml

@@ -11,11 +11,19 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-
+
+    - name: Extract branch, repo and sha
+      shell: bash
+      id: extract_info
+      run: |
+        echo "::set-output name=branch::${GITHUB_REF#refs/heads/}"
+        echo "::set-output name=repo::$(cut -d'/' -f2 <<< ${{ github.repository }})"
+        echo "::set-output name=sha::$(sha=${{ github.sha }}; echo ${sha:0:6})"
+
     - name: Repository Dispatch
       uses: peter-evans/repository-dispatch@v1.1.1
       with:
           token: ${{ secrets.PR_TRIGGER_BUILD_TOKEN }}
           repository: pingcap/website-docs/
-          event-type: triggered
+          event-type: ${{ steps.extract_info.outputs.repo }}/${{ steps.extract_info.outputs.branch }}-${{ steps.extract_info.outputs.sha }}
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}", "repo": "${{ github.repository }}"}'

.github/workflows/link-check.yaml

@@ -1,31 +1,31 @@
-name: external-link-check
+# name: external-link-check
 
-on: [pull_request]
+# on: [pull_request]
 
-jobs:
-  base:
-    runs-on: ubuntu-18.04
-    steps:
-      - name: Check out code
-        uses: actions/checkout@v2
+# jobs:
+#   base:
+#     runs-on: ubuntu-18.04
+#     steps:
+#       - name: Check out code
+#         uses: actions/checkout@v2
 
-      # NOTE:
-      #  - the check process can be very fast,
-      #    but if `-c` is too large then `Too Many Requests (HTTP error 429)` may be reported from `https://github.com/*`.
-      #  - we hardcode `--document-root` to `/github/workspace` in the container now.
-      #  - we use `http://172.*` as sample addresses in some docs, so we need to exclude them.
-      - name: Check external links
-        id: lc
-        uses: peter-evans/link-checker@v1
-        with:
-          args: -c 32 -d /github/workspace -r -x "http://172.*|https://github.com/.*/pull/.*|https://github.com/.*/issues/.*|https://github.com/[^.\n]*$|http://127.0.0.1.*|http://localhost.*|http://.*:.*|https://static.googleusercontent.com/media/research.google.com/.*|https://www.crunchbase.com/organization/.*|http://www.brendangregg.com.*|https://blog.csdn.net.*|http://mysql-cocoa.sourceforge.net.*|https://tools.ietf.org.*|http://code.google.com.*|https://spark.apache.org.*|https://www.caasdata.com/|https://www.linkedin.com/company/.*|https://sea-group.org/.*|https://octave.sourceforge.io/database/index.html|https://www.teld.cn/|http://gnade.sourceforge.net/|https://en.wikipedia.org/wiki/WeBank_\(China|https://twitter.com/PingCAP|.*.md" .
+#       # NOTE:
+#       #  - the check process can be very fast,
+#       #    but if `-c` is too large then `Too Many Requests (HTTP error 429)` may be reported from `https://github.com/*`.
+#       #  - we hardcode `--document-root` to `/github/workspace` in the container now.
+#       #  - we use `http://172.*` as sample addresses in some docs, so we need to exclude them.
+#       - name: Check external links
+#         id: lc
+#         uses: peter-evans/link-checker@v1
+#         with:
+#           args: -c 32 -d /github/workspace -r -x "http://172.*|https://github.com/.*/pull/.*|https://github.com/.*/issues/.*|https://github.com/[^.\n]*$|http://127.0.0.1.*|http://localhost.*|http://.*:.*|https://static.googleusercontent.com/media/research.google.com/.*|https://www.crunchbase.com/organization/.*|http://www.brendangregg.com.*|https://blog.csdn.net.*|http://mysql-cocoa.sourceforge.net.*|https://tools.ietf.org.*|http://code.google.com.*|https://spark.apache.org.*|https://www.caasdata.com/|https://www.linkedin.com/company/.*|https://sea-group.org/.*|https://octave.sourceforge.io/database/index.html|https://www.teld.cn/|http://gnade.sourceforge.net/|https://en.wikipedia.org/wiki/WeBank_\(China|https://twitter.com/PingCAP|http://www.webgraphviz.com/|http://octave.sourceforge.net/database/index.html|http://www.ymt.com/|http://www.alhem.net/project/mysql/|https://www.reddit.com/r/TiDB|http://www.189.cn/sh/|https://dev.mysql.com/doc/refman/5.7/en/connector-odbc-info.html|https://asktug.com/_/tidb-performance-map/#/|https://commons.apache.org/proper/commons-dbcp/|https://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html|https://en.wikipedia.org/wiki/Plane_\(Unicode|.*.md" .
 
-      - name: Fail if there were external link errors
-        if: ${{ steps.lc.outputs.exit_code }}
-        run: |
-          echo "Please check the broken links reported in the previous step \"Check external links\"."
-          exit ${{ steps.lc.outputs.exit_code }}
-      # Debug via SSH if previous steps failed
-      #- name: Set up tmate session
-      #  if: ${{ failure() }}
-      #  uses: mxschmitt/action-tmate@v2
+#       - name: Fail if there were external link errors
+#         if: ${{ steps.lc.outputs.exit_code }}
+#         run: |
+#           echo "Please check the broken links reported in the previous step \"Check external links\"."
+#           exit ${{ steps.lc.outputs.exit_code }}
+#       # Debug via SSH if previous steps failed
+#       #- name: Set up tmate session
+#       #  if: ${{ failure() }}
+#       #  uses: mxschmitt/action-tmate@v2

.github/workflows/media.yml

@@ -3,10 +3,7 @@ on:
   push:
     branches:
       - master
-      - release-2.1
-      - release-3.0
-      - release-3.1
-      - release-4.0
+      - release-*
     paths:
       - media/**
 jobs:
@@ -36,4 +33,4 @@ jobs:
           pip3 install awscli
           printf "%s\n" ${{ secrets.AWS_ACCESS_KEY }} ${{ secrets.AWS_SECRET_KEY }} ${{ secrets.AWS_REGION }} "json" | aws configure
       - name: Upload
-        run: cloud-assets-utils verify-and-sync -qiniu true -qiniu-bucket ${{ secrets.QINIU_BUCKET_NAME }} -aws true -aws-bucket ${{ secrets.AWS_BUCKET_NAME }} media -replace-first-path-to images/docs
+        run: cloud-assets-utils verify-and-sync -qiniu true -qiniu-bucket ${{ secrets.QINIU_BUCKET_NAME }} -aws true -aws-bucket ${{ secrets.AWS_BUCKET_NAME }} media -replace-first-path-to images/docs -cdn-refresh https://download.pingcap.com/

.github/workflows/rebase.yml

@@ -0,0 +1,19 @@
+name: Automatic Rebase
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  rebase:
+    name: Rebase
+    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the latest code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
+      - name: Automatic Rebase
+        uses: cirrus-actions/rebase@1.4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -29,11 +29,13 @@ Before you contribute, please take a quick look at some general information abou
 
 ### Learn about docs versions
 
-Currently, we maintain four versions of TiDB documentation, each with a separate branch:
+Currently, we maintain six 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.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 |
 | `release-3.0` branch | the 3.0 stable version |
@@ -50,7 +52,8 @@ Currently, we maintain four versions of TiDB documentation, each with a separate
 - 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.
@@ -61,7 +64,7 @@ Currently, we maintain four versions of TiDB documentation, each with a separate
 
 ## How to contribute
 
-Please perform the following steps to create your Pull Request to this repository. If don't like to use command, you can also use [GitHub Desktop](https://desktop.github.com/), which is easier to get started.
+Please perform the following steps to create your Pull Request to this repository. If don't like to use commands, you can also use [GitHub Desktop](https://desktop.github.com/), which is easier to get started.
 
 > **Note:**
 >

README.md

@@ -2,7 +2,7 @@
 
 Welcome to TiDB documentation!
 
-This repository stores all the source files of [TiDB Docs at the PingCAP website](https://docs.pingcap.com/tidb/v4.0), while the [pingcap/docs-cn](https://github.com/pingcap/docs-cn) repository stores all the source files of [TiDB Documentation in Chinese](https://docs.pingcap.com/zh/tidb/v4.0).
+This repository stores all the source files of [TiDB Docs at the PingCAP website](https://docs.pingcap.com/tidb/stable), while the [pingcap/docs-cn](https://github.com/pingcap/docs-cn) repository stores all the source files of [TiDB Documentation in Chinese](https://docs.pingcap.com/zh/tidb/stable).
 
 If you find documentation issues, feel free to [create an Issue](https://github.com/pingcap/docs/issues/new/choose) to let us know or directly [create a Pull Request](/CONTRIBUTING.md#how-to-contribute) to help fix or update it.
 
@@ -24,6 +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.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 |
 | [`release-3.0`](https://github.com/pingcap/docs/tree/release-3.0) | 3.0 stable version |