pingcap · Joyinqin · Feb 21, 2020 · Feb 21, 2020 · Feb 21, 2020 · Feb 22, 2020
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -3,19 +3,23 @@ version: 2
 jobs:
   lint:
     docker:
-      - image: circleci/ruby:2.4.1-node
+      - image: circleci/node:lts
     working_directory: ~/pingcap/docs-cn
     steps:
       - checkout
 
       - run:
-          name: "Install markdownlint"
+          name: Setup
           command: |
-            sudo npm install -g markdownlint-cli@0.17.0
+            mkdir ~/.npm-global
+            npm config set prefix '~/.npm-global'
+            echo 'export PATH=~/.npm-global/bin:$PATH' >> $BASH_ENV
+            echo 'export NODE_PATH=~/.npm-global/lib/node_modules:$NODE_PATH' >> $BASH_ENV
 
       - run:
-          name: "Lint dev"
-          command: markdownlint dev/
+          name: "Install markdownlint"
+          command: |
+            npm install -g markdownlint-cli@0.17.0
 
       - run:
           name: "Lint README"
@@ -28,10 +32,15 @@ jobs:
             git fetch upstream
             markdownlint $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*' ':(exclude)v1.0/*' ':(exclude)v2.0/*' ':(exclude)v2.1-legacy/*')
 
-      #- run:
-      #    name: "Check links"
-      #    command: |
-      #      scripts/verify-links.sh
+      - run:
+         name: "Check links"
+         command: |
+           scripts/verify-links.sh
+
+      - run:
+         name: "Check link anchors"
+         command: |
+           scripts/verify-link-anchors.sh
 
   build:
     docker:
@@ -58,22 +67,13 @@ jobs:
           name: "Publish PDF"
           command: |
             sudo bash -c 'echo "222.222.95.49 uc.qbox.me" >> /etc/hosts';
-            if [ "${CIRCLE_BRANCH}" == "master" ]; then
-              python3 scripts/upload.py dev/output.pdf tidb-manual-cn-dev.pdf;
-              python3 scripts/upload.py v3.0/output.pdf tidb-manual-cn-v3.0.pdf;
-              python3 scripts/upload.py v2.1/output.pdf tidb-manual-cn-v2.1.pdf;
-              python3 scripts/upload.py v3.1/output.pdf tidb-manual-cn-v3.1.pdf;
-            fi
-            if [ "${CIRCLE_BRANCH}" == "website-preview" ]; then
-              python3 scripts/upload.py dev/output.pdf tidb-manual-cn-preview-dev.pdf;
-              python3 scripts/upload.py v3.0/output.pdf tidb-manual-cn-preview-v3.0.pdf;
-              python3 scripts/upload.py v2.1/output.pdf tidb-manual-cn-preview-v2.1.pdf;
-              python3 scripts/upload.py v3.1/output.pdf tidb-manual-cn-preview-v3.1.pdf;
+            if [ "${CIRCLE_BRANCH}" == "release-3.1" ]; then
+              python3 scripts/upload.py output.pdf tidb-v3.1-zh-manual.pdf;
             fi
 
       - run:
           name: "Copy Generated PDF"
-          command: mkdir /tmp/artifacts && cp dev/output.pdf dev/doc.md /tmp/artifacts && cp v3.0/output.pdf v3.0/doc.md /tmp/artifacts && cp v2.1/output.pdf v2.1/doc.md /tmp/artifacts
+          command: mkdir /tmp/artifacts && cp output.pdf doc.md /tmp/artifacts
 
       - store_artifacts:
           path: /tmp/artifacts
@@ -89,5 +89,4 @@ workflows:
           filters:
             branches:
               only:
-                - master
-                - website-preview
+                - release-3.1
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
diff --git a/.github/ISSUE_TEMPLATE/change-request.md b/.github/ISSUE_TEMPLATE/change-request.md
@@ -0,0 +1,27 @@
+---
+name: "\U0001F680 Change Request"
+about: Any suggestion? Want to add something new?
+---
+
+## Change Request
+
+**This repository is ONLY used to solve problems related to DOCS-CN.
+For other issues (TiDB, TiKV, etc), please move to [other repositories](https://github.com/pingcap/).**
+<!-- 本仓库仅用于解决与中文文档相关的问题，
+其他方面问题（如 TiDB、TiKV 等），请移步其他[相关仓库](https://github.com/pingcap/)。 -->
+
+Please answer the following questions before submitting your issue. Thanks!
+<!-- 非常感谢你提出相关问题，在提交你的 issue 之前，请回答下面几个问题：-->
+
+1. Describe what you find is inappropriate or missing in the existing docs.
+<!-- 1. 描述在现有文档中，你发现不恰当或缺失的内容。-->
+
+
+2. Describe your suggestion or addition.
+<!-- 2. 描述你想要扩充的方面或你的建议。-->
+
+
+3. Provide some reference materials (documents, websites, etc) if you could.
+<!-- 3. 如果方便的话，请提供一些参考资料（比如你发现的文档、网站等）。-->
+
+
diff --git a/.github/ISSUE_TEMPLATE/error-report.md b/.github/ISSUE_TEMPLATE/error-report.md
@@ -0,0 +1,23 @@
+---
+name: "\U0001F41B Error Report"
+about: Typos, grammatical errors, terminology misuse, ambiguity, etc.
+---
+
+## Error 报告
+
+**This repository is ONLY used to solve problems related to DOCS-CN.
+For other issues (TiDB, TiKV, etc), please move to [other repositories](https://github.com/pingcap/).**
+<!-- 本仓库仅用于解决与中文文档相关的问题，
+其他方面的问题（如 TiDB、TiKV 等），请移步其他[相关仓库](https://github.com/pingcap/)。 -->
+
+Please answer the following questions before submitting your issue. Thanks!
+<!-- 非常感谢你提出相关问题，在提交你的 issue 之前，请回答下面几个问题：-->
+
+1. What is the document directory for the problem?
+<!-- 1. 该问题出现的文档路径是什么？-->
+
+
+2. How would you like to improve it?
+<!-- 2. 你希望如何改正它? -->
+
+
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -22,3 +22,5 @@ Before asking a question, make sure you have:
     - [TiDB Docs](https://github.com/pingcap/docs)
     - [TiDB Docs-cn](https://github.com/pingcap/docs-cn)
 <!-- - 阅读了相关文档。 -->
+
+Now, please describe your question here:
diff --git a/.github/auto-label.json b/.github/auto-label.json
@@ -0,0 +1,6 @@
+{
+  "rules": {
+    "translation/welcome": ["*.md", "*.yml", "*.yaml", "*.json", "media/", "scripts/"],
+    "status/PTAL": ["*.md", "*.yml", "*.yaml", "*.json", "media/", "scripts/"]
+  }
+}
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,30 +1,25 @@
-<!--Thanks for your contribution to TiDB documentation. See [CONTRIBUTING](https://github.com/pingcap/community/blob/master/CONTRIBUTING.md) before filing this pull request (PR).-->
+<!--Thanks for your contribution to TiDB documentation. Please answer the following questions.-->
 
-### What is changed, added or deleted? <!--Required-->
+### What is changed, added or deleted? (Required)
 
-<!--Tell us what you did and why. This is important to help reviewers and community members understand your PR.-->
+<!--Tell us what you did and why.-->
 
-### What is the related PR or file link(s)? <!--Required-->
+### Which TiDB version(s) do your changes apply to? (Required)
 
-<!--Give us some reference link(s) that might help quickly review and merge your PR, for example, a file link that supports why you changed the document.-->
+<!-- You **must** choose the TiDB version(s) that your changes apply to. Fill in "x" in [] to tick the checkbox below.-->
 
-- [ ] Reference link(s):<!--Give links here-->
-- [ ] This PR is to align with:<!--Give links here-->
-- [ ] N/A (not applicable)
-
-### Which TiDB version(s) does your changes apply to? <!--Required-->
-
-<!--Tick the checkbox(es) below to choose the TiDB version(s) that your changes apply to.-->
-
-- [ ] All active versions: dev, v3.0, v2.1, v3.1
-- [ ] dev (the latest development version)
+- [ ] master (the latest development version)
+- [ ] v4.0 (TiDB 4.0 versions)
+- [ ] v3.1 (TiDB 3.1 versions)
 - [ ] v3.0 (TiDB 3.0 versions)
 - [ ] v2.1 (TiDB 2.1 versions)
-- [ ] v3.1 (TiDB 3.1 versions)
-- [ ] v4.0 (TiDB 4.0 versions)
-- [ ] All active and inactive versions
-- [ ] N/A (not applicable)
 
-**Note:** If your changes apply to multiple TiDB versions, make sure you update the documents in the **corresponding** version folders such as "dev", "v3.0", "v2.1" and "v3.1" in this PR.
+<!-- For contributors with **WRITE ACCESS** in this repo:
+If you select **two or more** versions from above, to trigger the bot to cherry-pick this PR to your desired release branch(es), you **must** add labels such as "needs-cherry-pick-4.0", "needs-cherry-pick-3.1", "needs-cherry-pick-3.0", or "needs-cherry-pick-2.1" on the right side of this PR page.-->
+
+### What is the related PR or file link(s)?
+
+<!--Give us some reference link(s) that might help quickly review and merge your PR.-->
 
-- [ ] Updated one version first. Will update other versions after I get two LGTMs.
+- This PR is translated from:
+- Other reference link(s):
diff --git a/.github/workflows/auto-label.yml b/.github/workflows/auto-label.yml
@@ -0,0 +1,16 @@
+name: Auto Label
+on:
+  pull_request:
+    branches:
+      - master
+    types: [opened]
+
+jobs:
+  auto-label:
+    name: Auto Label
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: banyan/auto-label@1.2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/media.yml b/.github/workflows/media.yml
@@ -0,0 +1,39 @@
+name: Upload media files to Qiniu and Aws when they change
+on:
+  push:
+    branches:
+      - master
+      - release-2.1
+      - release-3.0
+      - release-3.1
+      - release-4.0
+    paths:
+      - media/**
+jobs:
+  run:
+    name: Upload media files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+        with:
+          # Must use at least depth 2!
+          fetch-depth: 2
+
+      - name: Download cloud_assets_utils
+        run: |
+          curl -L https://github.com/pingcap/cloud-assets-utils/releases/download/v0.2.0/cloud_assets_utils-ubuntu-latest -o cloud_assets_utils
+          chmod +x cloud_assets_utils
+          sudo mv cloud_assets_utils /usr/local/bin/cloud-assets-utils
+      - name: Configure qshell
+        run: |
+          curl http://devtools.qiniu.com/qshell-linux-x64-v2.4.1.zip -o qshell.zip
+          unzip qshell.zip
+          sudo mv qshell-linux-x64-v2.4.1 /usr/local/bin/qshell
+          qshell account ${{ secrets.QINIU_ACCESS_KEY }} ${{ secrets.QINIU_SECRET_KEY }} test
+      - name: Configure awscli
+        run: |
+          pip3 install --upgrade setuptools
+          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-cn
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -1,4 +1,4 @@
-comment: 'Rules for PingCAP docs-cn'
+comment: 'Markdownlint Rules for PingCAP docs-cn'
 
 # disable all by default
 default: false
@@ -11,7 +11,7 @@ heading-style:
   style: atx
 
 # MD009
-no-trailing-spaces: true
+# no-trailing-spaces: true
 
 # MD010
 no-hard-tabs: true