From 47501782f61e4baf503c5ea26358042fac3aa1e6 Mon Sep 17 00:00:00 2001 From: zhongjun2 Date: Tue, 30 Jun 2020 12:30:52 +0800 Subject: [PATCH] Fix Readme --- README.en.md | 15 ++------------- README.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 13 deletions(-) diff --git a/README.en.md b/README.en.md index 3a6c3b48c..3dae6e51d 100644 --- a/README.en.md +++ b/README.en.md @@ -2,8 +2,7 @@ ### Brief Introduction -docs maintains openGauss documentations which is integrated by online website. Now we are under developing. -you are welcome to join us. +docs maintains openGauss documentations which is integrated by online website. Welcome to join us. ### Installation @@ -32,17 +31,7 @@ Other language(zh) will serving on http://your-server-ip/zh docker rm -f `cat docs.pid` && rm -f docs.pid ``` - -### Contribution - -1. Fork the repository -2. Create Feature_xxx branch -3. Commit your code -4. Create Pull Request - -Please refer to [CONTRIBUTING](./CONTRIBUTING.md) for more guide. - ### Get Help - IRC: #opengauss-docs -- Mail: dev@opengauss.org +- Mailling List: [docs@opengauss.org](https://mailweb.opengauss.org/postorius/lists/docs.opengauss.org/) diff --git a/README.md b/README.md index 5f7075b36..bb6e53c0e 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,36 @@ #### 介绍 欢迎来到openGauss官方文档的仓库。 + +#### 安装 + +1. 构建镜像 + +``` +docker build -t docs:v0.0.1 . +``` + +注: ```docs``` 是镜像名称, 可任意修改. + +2. 运行容器 + +``` +docker run -p 80:80 -d docs:v0.0.1 > docs.pid +``` + +网站默认访问路径： http://your-server-ip:80 + +英文网站访问路径： http://your-server-ip/ +中文网站访问路径： http://your-server-ip/zh + +3. 删除容器 + +``` +docker rm -f `cat docs.pid` && rm -f docs.pid +``` + +#### 联系方式 + +- IRC: #opengauss-docs +- Mailling List: [docs@opengauss.org](https://mailweb.opengauss.org/postorius/lists/docs.opengauss.org/) + -- Gitee