Skip to content

Commit

Permalink
README.md: remove outdated file path description (pingcap#3114)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* Update README.md

* readme: add a contributor image

* readme: add blank lines

Co-authored-by: lilin90 <lilin@pingcap.com>
  • Loading branch information
2 people authored and sre-bot committed May 15, 2020
1 parent c73a276 commit c72da2f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 36 deletions.
55 changes: 19 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,25 @@
# TiDB 文档

欢迎来到 [TiDB](https://github.com/pingcap/tidb) 文档库!这里存放的是 [PingCAP 官网 TiDB 中文文档](https://pingcap.com/docs-cn/stable/)的源文件。[官网英文文档](https://pingcap.com/docs/stable/)的源文件则存放于 [pingcap/docs](https://github.com/pingcap/docs)。如果你发现或遇到了 TiDB 的文档问题,可随时[提 Issue](https://github.com/pingcap/docs-cn/issues/new/choose) 来反馈,或者直接[提交 Pull Request](/CONTRIBUTING.md#pull-request-提交流程) 来进行修改。

## TiDB 文档结构

目前,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 的文档结构如下:

```
├── 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](https://github.com/pingcap/tidb) 文档仓库!

这里存放的是 [PingCAP 官网 TiDB 中文文档](https://pingcap.com/docs-cn/stable/)的源文件。[官网英文文档](https://pingcap.com/docs/stable/)的源文件则存放于 [pingcap/docs](https://github.com/pingcap/docs)

如果你发现或遇到了 TiDB 的文档问题,可随时[提 Issue](https://github.com/pingcap/docs-cn/issues/new/choose) 来反馈,或者直接[提交 Pull Request](/CONTRIBUTING.md#pull-request-提交流程) 来进行修改。

## TiDB 文档维护方式及版本说明

目前,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 稳定版 |

## 贡献文档

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

你提交的第一个 [Pull Request](https://help.github.com/en/github/getting-started-with-github/github-glossary#pull-request) (PR) 合并以后,即可成为 TiDB 文档的 Contributor。查看 [TiDB 中文文档贡献指南](/CONTRIBUTING.md),开始你的贡献吧!
Binary file added media/contribution-map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c72da2f

Please sign in to comment.