Skip to content

Commit

Permalink
Merge branch 'master' into dm-sync
Browse files Browse the repository at this point in the history
  • Loading branch information
ran-huang authored Jun 20, 2022
2 parents 4f1c49d + 90b6bab commit 825682b
Show file tree
Hide file tree
Showing 451 changed files with 24,019 additions and 3,535 deletions.
19 changes: 0 additions & 19 deletions .github/exclude-links.txt

This file was deleted.

6 changes: 1 addition & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,13 @@ By default, **CHOOSE MASTER ONLY** so your changes will be applied to the next T
For details, see [tips for choosing the affected versions (in Chinese)](https://github.com/pingcap/docs-cn/blob/master/CONTRIBUTING.md#版本选择指南).

- [ ] master (the latest development version)
- [ ] v6.2 (TiDB 6.2 versions)
- [ ] v6.1 (TiDB 6.1 versions)
- [ ] v6.0 (TiDB 6.0 versions)
- [ ] v5.4 (TiDB 5.4 versions)
- [ ] v5.3 (TiDB 5.3 versions)
- [ ] v5.2 (TiDB 5.2 versions)
- [ ] 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)
- [ ] v2.1 (TiDB 2.1 versions)

### What is the related PR or file link(s)?

Expand Down
21 changes: 11 additions & 10 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,17 @@ name: ci
on: [pull_request]

jobs:

pull:
runs-on: ubuntu-latest
steps:
- name: Check out
uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: '12'
- name: Verify internal links
run: ./scripts/verify-links.sh
- name: Verify internal link anchors
run: ./scripts/verify-link-anchors.sh
- name: Check out
uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: "16"
- name: Verify duplicated file names
run: ./scripts/verify-duplicated-file-name.sh
- name: Verify internal links
run: ./scripts/verify-links.sh
- name: Verify internal link anchors
run: ./scripts/verify-link-anchors.sh
15 changes: 10 additions & 5 deletions .github/workflows/link.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,26 @@ jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Link Checker
uses: lycheeverse/lychee-action@v1.1.1
- name: Download Exclude Path
run: |
curl https://raw.githubusercontent.com/pingcap/docs/master/.lycheeignore --output .lycheeignore
- name: Check Links
uses: lycheeverse/lychee-action@v1.5.0
with:
# For parameter description, see https://github.com/lycheeverse/lychee#commandline-parameters
args: -E --exclude-mail -v -i -n -a 429 -t 45 --exclude-file ./.github/exclude-links.txt -- **/*.md *.md
args: -E --exclude-mail -v -i -n -t 45 -- **/*.md
output: out.md
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

- name: Create Issue From File
uses: peter-evans/create-issue-from-file@v3
with:
title: Broken Link Detected
content-filepath: ./lychee/out.md
content-filepath: out.md
assignees: TomShawn

# - name: Fail if there were link errors
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/rebase.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ jobs:
token: ${{ secrets.REBASE_SECRET_KEY }}
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
- name: Automatic Rebase
uses: cirrus-actions/rebase@1.4
uses: cirrus-actions/rebase@1.6
env:
GITHUB_TOKEN: ${{ secrets.REBASE_SECRET_KEY }}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ gen
.DS_Store

/node_modules/
package.json
yarn.lock
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ TiDB 文档的修改需要遵循一定的流程,具体如下。考虑到有些

> **注意:**
>
> 目前 TiDB 主要维护以下几个版本的文档:dev(最新开发版,对应文档仓库的 master 分支)、v5.2、v5.1、v5.0、v4.0、v3.1、v3.0 以及 v2.1。提 Pull Request 前请务必考虑修改会影响的文档版本,并据此修改所有相应的版本。选择版本时,请参考[版本选择指南](#版本选择指南)
> 目前 TiDB 主要维护以下几个版本的文档:dev(最新开发版,对应文档仓库的 master 分支)、v6.1、v6.0、v5.4、v5.3、v5.2、v5.1、v5.0、v4.0、v3.1、v3.0 以及 v2.1。提 Pull Request 前请务必考虑修改会影响的文档版本,并据此修改所有相应的版本。选择版本时,请参考[版本选择指南](#版本选择指南)
### 第 0 步:签署 Contributor License Agreement

Expand Down Expand Up @@ -202,7 +202,7 @@ TiDB 中文文档使用 Markdown 语言进行编写,为了保证文档质量

- 完善和优化文档内容,例如补充缺失或不完整的信息。
- 修正不准确或错误的文档内容,例如默认值错误、描述不准确、示例错误、拼写错误等。
- 重新组织现有文档的某个局部,例如“部署标准集群”、“数据迁移”、“TiDB 生态工具”等。
- 重新组织现有文档的某个局部,例如“部署标准集群”、“数据迁移”、“TiDB 数据迁移工具”等。

如果你的 PR 改动符合以下任一情况,请**选择 master 分支以及受影响的 release 分支**

Expand All @@ -213,4 +213,4 @@ TiDB 中文文档使用 Markdown 语言进行编写,为了保证文档质量

## 联系我们

加入 Slack channel:[#sig-docs](https://slack.tidb.io/invite?team=tidb-community&channel=sig-docs&ref=pingcap-docs-cn)
欢迎来 [TiDB Internals](https://internals.tidb.io/) 参与讨论。
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
| 文档仓库 branch | 对应 TiDB 文档版本 |
|:---------|:----------|
| [`master`](https://github.com/pingcap/docs-cn/tree/master) | dev 最新开发版 |
| [`release-6.0`](https://github.com/pingcap/docs-cn/tree/release-6.0) | 6.0 开发里程碑版 |
| [`release-6.1`](https://github.com/pingcap/docs-cn/tree/release-6.1) | 6.1 长期支持版 (LTS) |
| [`release-6.0`](https://github.com/pingcap/docs-cn/tree/release-6.0) | 6.0 开发里程碑版 (DMR) |
| [`release-5.4`](https://github.com/pingcap/docs-cn/tree/release-5.4) | 5.4 稳定版 |
| [`release-5.3`](https://github.com/pingcap/docs-cn/tree/release-5.3) | 5.3 稳定版 |
| [`release-5.2`](https://github.com/pingcap/docs-cn/tree/release-5.2) | 5.2 稳定版 |
Expand All @@ -26,7 +27,7 @@

## 贡献文档

[<img src="media/contribution-map.png" alt="contribution-map" width="180"></img>](https://github.com/pingcap/community/tree/master/special-interest-groups/sig-docs)
[<img src="media/contribution-map.png" alt="contribution-map" width="180"></img>](https://github.com/pingcap/docs-cn/blob/master/credits.md)

你提交的第一个 [Pull Request](https://help.github.com/en/github/getting-started-with-github/github-glossary#pull-request) (PR) 合并以后,即可成为 TiDB 文档的 Contributor。查看 [TiDB 中文文档贡献指南](/CONTRIBUTING.md),开始你的贡献吧!

Expand Down
Loading

0 comments on commit 825682b

Please sign in to comment.