diff --git a/README.md b/README.md index 7eaee7962497f9f3a935a47257d543775b4515bd..8e37105f411eedc079c3d5099f1a0263951be746 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,51 @@ -# docs +# openGauss文档 -[English](./README.en.md) | 简体中文 +![openGauss Logo](themes\project\images\openGauss-logo.png "openGauss logo") -#### 介绍 +### 介绍 -欢迎来到openGauss官方文档的仓库。 +欢迎来到openGauss官方文档的仓库。此仓库提供[openGauss社区网站](https://opengauss.org/zh)所呈现的所有文档,包括法律声明、发行说明、产品描述、技术白皮书、编译指导书、快速入门、安装指南、管理员指南、开发者指南、工具参考等内容。 -#### 安装 +### 贡献 -1. 构建镜像 +我们非常欢迎您贡献文档!如果想要参与,请阅读[社区资料开发指导]([https://gitee.com/opengauss/docs/wikis/%E6%8B%89%E5%8F%96%E4%B8%AA%E4%BA%BA%E5%88%86%E6%94%AF?sort_id=2783599](https://gitee.com/opengauss/docs/wikis/拉取个人分支?sort_id=2783599)),务必遵守文档写作规范,并按照流程规则提交。审核通过后,修改会在文档工程和官网中呈现。 -``` -docker build -t docs:v0.0.1 . -``` +同时,如果您对文档有任何意见或建议,请在Issues中提交。 -注: ```docs``` 是镜像名称, 可任意修改. +### 查找文档 -2. 运行容器 +打开“content”文件夹,该文件夹包含了中文(“zh”文件夹)和英文(“en”文件夹)两种语言文档,以中文文档举例进行说明。 在“zh”文件夹中,“docs”文件夹包含了具体文档的内容,“menu”包含了文档的大纲内容。 +打开“docs”文件夹,各手册和文件夹对应关系如下。 -``` -docker run -p 80:80 -d docs:v0.0.1 > docs.pid -``` +| 文件夹名称 | 对应手册 | +| ---------------- | ---------- | +| Administratorguide | 管理员指南 | +| Compilationguide | 编译指导书 | +| Description | 产品描述 | +| Developerguide | 开发者指南 | +| Glossary | 术语表 | +| installation | 安装指南 | +| Quickstart | 快速入门 | +| Releasenotes | 发行说明 | +| Technicalwhitepaper | 技术白皮书 | +| Toolreference | 工具参考 | -网站默认访问路径: http://your-server-ip:80 +### 版本分支对应关系 -英文网站访问路径: http://your-server-ip/ -中文网站访问路径: http://your-server-ip/zh +Docs包含了如下2个分支: -3. 删除容器 +- master:开发分支,为默认分支。 +- 1.0.0:1.0.0版本分支,分支内容呈现在[openGauss社区网站](https://opengauss.org/zh)“文档“栏。 -``` -docker rm -f `cat docs.pid` && rm -f docs.pid -``` +### 成员 -#### 联系方式 +Maintainer 列表: +- kangyang(@ylfan96) +- gongsiyi(@gongsiyi150) + +### 联系方式 + +- 邮件列表: [docs@opengauss.org](https://mailweb.opengauss.org/postorius/lists/docs.opengauss.org/) - IRC: #opengauss-docs -- Mailling List: [docs@opengauss.org](https://mailweb.opengauss.org/postorius/lists/docs.opengauss.org/) diff --git "a/content/content - \345\277\253\346\215\267\346\226\271\345\274\217.lnk" "b/content/content - \345\277\253\346\215\267\346\226\271\345\274\217.lnk" new file mode 100644 index 0000000000000000000000000000000000000000..febb524fd46f8050e65e8194f638831b4728fcab Binary files /dev/null and "b/content/content - \345\277\253\346\215\267\346\226\271\345\274\217.lnk" differ diff --git a/themes/project/images/openGauss-logo.png b/themes/project/images/openGauss-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..3c1b625724c6184fcfbc6c11f83002bde3ad7232 Binary files /dev/null and b/themes/project/images/openGauss-logo.png differ