# docs

**Repository Path**: dreamalloc/docs

## Basic Information

- **Project Name**: docs
- **Description**: openGauss documentation
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1341
- **Created**: 2022-09-23
- **Last Updated**: 2022-09-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# docs  

简体中文 | [English](./README.en.md)

### 介绍

欢迎来到openGauss官方文档的仓库。此仓库提供[openGauss社区网站](https://opengauss.org/zh)所呈现的所有文档，包括法律声明、发行说明、产品描述、技术白皮书、编译指导书、简易教程、安装指南、管理员指南、开发者指南、工具参考等内容。
### 贡献

我们非常欢迎您贡献文档！如果想要参与，请阅读[贡献范围](contribute/贡献范围.md)，务必遵守文档写作规范，并按照流程规则提交。审核通过后，修改会在文档工程和官网中呈现。

同时，如果您对文档有任何意见或建议，请在Issues中提交。

### 查找文档

打开“content”文件夹，该文件夹包含了openGauss轻量版和企业版两个版本的文档。

- "content/docs-lite"对应的文件夹表示openGuass轻量版文档，里面包含中文（“zh”文件夹）和英文（“en”文件夹）两种语言文档。
- "content/zh"和"content/en"对应的文件夹表示openGauss企业版中文和英文两种语言文档。

以中文文档举例进行说明。 在“zh”文件夹中，“docs”文件夹包含了具体文档的内容，“menu”包含了文档的大纲内容。
打开“docs”文件夹，各手册和文件夹对应关系如下。

| 文件夹名称                       | 对应手册   |
| --------------------------------| ---------- |
| Administratorguide              | 管理员指南 |
| Compilationguide                | 编译指导书 |
| Description                     | 产品描述   |
| Developerguide                  | 开发者指南 |
| Glossary                        | 术语表     |
| installation                    | 安装指南   |
| Quickstart                      | 快速入门 |
| BriefTutorial | 简易教程 |
| Releasenotes                    | 发行说明   |
| Technicalwhitepaper             | 技术白皮书 |
| Toolreference                   | 工具参考   |
| CharacteristicDescription       | 特性描述   |
| FAQ                             | FAQ        |


### 版本分支对应关系

Docs包含了如下7个分支：

- master：开发分支，为默认分支。
- 3.0.0：3.0.0版本分支，分支内容呈现在[openGauss社区网站](https://opengauss.org/zh)"文档 > 3.0.0"。
- 2.1.0：2.1.0版本分支，分支内容呈现在[openGauss社区网站](https://opengauss.org/zh)"文档 > 2.1.0"。
- 2.0.0：2.0.0版本分支，分支内容呈现在[openGauss社区网站](https://opengauss.org/zh)"文档 > 2.0.0"。
- 1.1.0：1.1.0版本分支，分支内容呈现在[openGauss社区网站](https://opengauss.org/zh)"文档 > 1.1.0"。
- 1.0.1：1.0.1版本分支，分支内容呈现在[openGauss社区网站](https://opengauss.org/zh)"文档 > 1.0.1"。
- 1.0.0：1.0.0版本分支，分支内容呈现在[openGauss社区网站](https://opengauss.org/zh)"文档 > 1.0.0"。

### 成员

当前openGauss Docs SIG已有170+成员，详情信息请参见[Docs-SIG组成员](contribute/Docs-SIG组成员.md)。

### 联系方式

- 邮件列表: [docs@opengauss.org](https://mailweb.opengauss.org/postorius/lists/docs.opengauss.org/)
- IRC: #opengauss-docs