Skip to content

Commit

Permalink
*: update some guiding resources #2628 (#2629)
Browse files Browse the repository at this point in the history
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
  • Loading branch information
sre-bot and yikeke authored Apr 4, 2020
1 parent 351d502 commit 2f469dc
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
5 changes: 3 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@

<!--Tick the checkbox(es) below to choose the TiDB version(s) that your changes apply to.-->

- [ ] master (the latest development version, including v4.0 changes for now)
- [ ] 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)

**If you select two or more versions from above**, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you **must** add corresponding labels such as **needs-cherry-pick-3.1**, **needs-cherry-pick-3.0**, and **needs-cherry-pick-2.1**.
**If you select two or more versions from above**, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you **must** add corresponding labels such as **needs-cherry-pick-4.0**, **needs-cherry-pick-3.1**, **needs-cherry-pick-3.0**, and **needs-cherry-pick-2.1**.

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

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

> **注意:**
>
> 目前 TiDB 主要维护四个版本的文档:dev(最新开发版)v3.1(3.1 Beta 版),v3.0(最新稳定版),v2.1(最新 2.1 版)。提 Pull Request 前请务必考虑修改会影响的文档版本,并据此修改所有相应的版本。
> 目前 TiDB 主要维护以下几个版本的文档:dev(最新开发版)、v4.0、v3.1v3.0 以及 v2.1。提 Pull Request 前请务必考虑修改会影响的文档版本,并据此修改所有相应的版本。
### 第 1 步:Fork pingcap/docs-cn 仓库

Expand Down Expand Up @@ -136,8 +136,8 @@ git push -u origin new-branch-name

> **注意:**
>
> - 如果你的修改影响多个文档版本 (dev, *v4.0, v3.1, v3.0, v2.1),务必在 PR 描述框中勾选相应的版本,或者在页面右侧选择相应的 label (dev, *v4.0, v3.1, v3.0, v2.1) 来注明。v4.0 为尚未发布的新版本
> - 如果你的修改也同样适用于[英文版文档](https://github.com/pingcap/docs),需要在提 PR 时添加 label `pending-aligning`;也非常欢迎同时更新中文版和英文版。
> - 如果你的修改影响多个文档版本 (dev, v4.0, v3.1, v3.0, v2.1),务必在 PR 描述框中勾选相应的版本,以及在页面右侧选择相应的 cherry-pick labels
> - 如果你的修改也同样适用于[英文版文档](https://github.com/pingcap/docs),需要在提 PR 时添加 label `translation-welcome`;也非常欢迎同时更新中文版和英文版。
## 必须遵循的 Markdown 规范

Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@

## TiDB 文档结构

目前,TiDB 的文档维护以下四个版本,分别放置在相应的 branch:
目前,TiDB 的文档维护以下几个版本,分别放置在相应的 branch:

- `master`:最新开发版
- `release-3.1`:3.1 Beta 版
- `release-4.0`:4.0 Beta 版
- `release-3.1`:3.1 RC 版
- `release-3.0`:最新稳定版
- `release-2.1`:2.1 稳定版

Expand Down

0 comments on commit 2f469dc

Please sign in to comment.