Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md: remove outdated file path description #3114

Merged
merged 9 commits into from
May 15, 2020
Merged

README.md: remove outdated file path description #3114

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7b25b7e
Update README.md
May 15, 2020
1c02a79
Update README.md
yikeke May 15, 2020
7028c0d
Update README.md
May 15, 2020
842878b
Merge branch 'update-community-descrptions' of https://github.com/yik…
May 15, 2020
6e88e38
readme: add a contributor image
lilin90 May 15, 2020
d7b99b6
Merge branch 'master' into update-community-descrptions
lilin90 May 15, 2020
ea67f17
readme: add blank lines
lilin90 May 15, 2020
149ff2f
Merge branch 'update-community-descrptions' of https://github.com/yik…
lilin90 May 15, 2020
a4549fb
Merge branch 'master' into update-community-descrptions
lilin90 May 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 9 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,15 @@

## TiDB 文档结构
yikeke marked this conversation as resolved.
Show resolved Hide resolved

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

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

TiDB 的文档结构如下：
lilin90 marked this conversation as resolved.
Show resolved Hide resolved

```
├── TOC.md
├── how-to
├── get-started
├── deploy
├── orchestrated
├── tiup.md
├── docker.md
├── configure
├── maintain
├── troubleshoot
├── ...
├── reference
├── tools
├── tidb-binlog
├── ...
├── releases
├── tidb-in-kubernetes
├── faq
├── ...
...
```
目前，TiDB 的文档维护在以下 branch，对应着官网文档的不同版本：

| 文档仓库 branch | 对应 TiDB 文档版本 |
| ---------|----------|
| [`master`](https://github.com/pingcap/docs-cn/tree/master) | dev 最新开发版 |
| [`release-4.0`](https://github.com/pingcap/docs-cn/tree/release-4.0) | 4.0 RC 版 |
| [`release-3.1`](https://github.com/pingcap/docs-cn/tree/release-3.1) | 3.1 稳定版 |
| [`release-3.0`](https://github.com/pingcap/docs-cn/tree/release-3.0) | 3.0 稳定版 |
| [`release-2.1`](https://github.com/pingcap/docs-cn/tree/release-2.1) | 2.1 稳定版 |

## 贡献文档

Expand Down