docs

简体中文 | English

介绍

欢迎来到openGauss官方文档的仓库。此仓库提供openGauss社区网站所呈现的所有文档，包括法律声明、发行说明、产品描述、技术白皮书、编译指导书、简易教程、安装指南、管理员指南、应用开发指南、工具参考等内容。

贡献

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

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

查找文档

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

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

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

文件夹名称	对应手册
AIFeatureGuide	AI特性指南
DatabaseAdministrationGuide	数据库管理指南
DatabaseOMGuide	数据库运维指南
Appendix	附录
BriefTutorial	简易教程
CompilationGuide	编译指南
DatabaseReference	数据库参考
DataMigrationGuide	数据迁移指南
AboutopenGauss	关于openGauss
DeveloperGuide	应用开发指南
ExtensionReference	插件参考
GettingStarted	快速入门
PerformanceTuningGuide	性能调优指南
InstallationGuide	安装指南
ReleaseNotes	发行说明
SecHarden	安全加固指南
SQLReference	SQL参考
TechnicalWhitePaper	技术白皮书
ToolandCommandReference	工具与命令参考

版本分支对应关系

Docs包含了如下7个分支：

• master：开发分支，为默认分支。
• 6.0.0：6.0.0版本分支，分支内容呈现在openGauss社区网站"文档 > 6.0.0"。
• 6.0.0-RC1：6.0.0-RC1版本分支，分支内容呈现在openGauss社区网站"文档 > 6.0.0-RC1"。
• 5.1.0：5.1.0版本分支，分支内容呈现在openGauss社区网站"文档 > 5.1.0"。
• 5.0.0：5.0.0版本分支，分支内容呈现在openGauss社区网站"文档 > 5.0.0"。
• 3.1.1：3.1.1版本分支，分支内容呈现在openGauss社区网站"文档 > 3.1.1"。
• 3.1.0：3.1.0版本分支，分支内容呈现在openGauss社区网站"文档 > 3.1.0"。
• 3.0.0：3.0.0版本分支，分支内容呈现在openGauss社区网站"文档 > 3.0.0"。
• 2.1.0：2.1.0版本分支，分支内容呈现在openGauss社区网站"文档 > 2.1.0"。
• 2.0.0：2.0.0版本分支，分支内容呈现在openGauss社区网站"文档 > 2.0.0"。
• 1.1.0：1.1.0版本分支，分支内容呈现在openGauss社区网站"文档 > 1.1.0"。
• 1.0.1：1.0.1版本分支，分支内容呈现在openGauss社区网站"文档 > 1.0.1"。
• 1.0.0：1.0.0版本分支，分支内容呈现在openGauss社区网站"文档 > 1.0.0"。

成员

当前openGauss Docs SIG已有170+成员，详情信息请参见Docs-SIG组成员。

联系方式

• 邮件列表: docs@opengauss.org
• IRC: #opengauss-docs