Skip to content

Commit

Permalink
repository: add information about the DM doc master branch changes (#879
Browse files Browse the repository at this point in the history
)
  • Loading branch information
qiancai authored Dec 30, 2021
1 parent a4b8ef9 commit cc6e23d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
3 changes: 2 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@

<!-- You **must** choose the DM version(s) that your changes apply to. Fill in "x" in [] to tick the checkbox below.-->

- [ ] master (the latest development version)
Since December 23, 2021, the TiDB DM documentation in the master branch has been merged to TiDB documentation by [#8042](https://github.com/pingcap/docs-cn/pull/8042) and [#7317](https://github.com/pingcap/docs/pull/7317). To create a PR for TiDB DM versions later than v5.3, either go to TiDB [English documentation repository](https://github.com/pingcap/docs) or [Chinese documentation repository](https://github.com/pingcap/docs-cn).

- [ ] v5.3 (TiDB DM 5.3 versions)
- [ ] v2.0 (TiDB DM 2.0 versions)
- [ ] v1.0 (TiDB DM 1.0 versions)
Expand Down
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,25 @@ Before you contribute, please take a quick look at some general information abou

### Learn about docs versions

Currently, we maintain three versions of TiDB Data Migration documentation, each with a separate branch:
Currently, we maintain the following versions of TiDB Data Migration documentation, each with a separate branch:

| Branch name | Version description |
| :--- | :-- |
| `master` | the latest development version |
| `master` | **no updates are allowed since December 23, 2021** |
| `release-5.3` | the latest 5.3 stable version |
| `release-2.0` | the latest 2.0 stable version |
| `release-1.0` | the latest 1.0 stable version |

> **Note:**
>
> Since December 23, 2021, the TiDB DM documentation in the master branch has been merged to TiDB documentation by [#8042](https://github.com/pingcap/docs-cn/pull/8042) and [#7317](https://github.com/pingcap/docs/pull/7317). To create a PR for TiDB DM versions later than v5.3, either go to TiDB [English documentation repository](https://github.com/pingcap/docs) or [Chinese documentation repository](https://github.com/pingcap/docs-cn).
### Use cherry-pick labels

- 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 ti-chi-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, ti-chi-bot will start to work.
- `needs-cherry-pick-master` label: ti-chi-bot will submit a PR to the `master` branch.

- `needs-cherry-pick-release-5.3` label: ti-chi-bot will submit a PR to the `release-5.3` branch.
- `needs-cherry-pick-release-2.0` label: ti-chi-bot will submit a PR to the `release-2.0` branch.
- `needs-cherry-pick-release-1.0` label: ti-chi-bot will submit a PR to the `release-1.0` branch.
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,14 @@ Currently, we maintain the following versions for TiDB DM documentation, each wi

| Branch name | Version description |
| :--- | :-- |
| `master` | the latest development version |
| `master` | **no updates are allowed since December 23, 2021** |
| `release-5.3` | the latest 5.3 stable version |
| `release-2.0` | the latest 2.0 stable version |
| `release-1.0` | the latest 1.0 stable version |

> **Note:**
>
> - Previously, we maintain the TiDB DM documentation in the [docs](https://github.com/pingcap/docs) and [docs-cn](https://github.com/pingcap/docs-cn) repository.
> - Since March 31, 2020, all the DM documentation has been moved to this repository, and maintained based on versions in the branches above.
> Since December 23, 2021, the TiDB DM documentation in the master branch has been merged to TiDB documentation by [#8042](https://github.com/pingcap/docs-cn/pull/8042) and [#7317](https://github.com/pingcap/docs/pull/7317). To create a PR for TiDB DM versions later than v5.3, either go to TiDB [English documentation repository](https://github.com/pingcap/docs) or [Chinese documentation repository](https://github.com/pingcap/docs-cn).
## Contributing

Expand Down

0 comments on commit cc6e23d

Please sign in to comment.