From 6d04699775e22d488817520f6f307284675573b5 Mon Sep 17 00:00:00 2001 From: gomico Date: Wed, 27 Oct 2021 07:48:37 +0000 Subject: [PATCH 1/3] update README.md. improved overall writing --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1040033..fa4b014 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,31 @@ ### Brief Introduction -Website is openEuler community contents management system base on [Hugo](https://gohugo.io/) framework, [Universal Theme for Hugo](https://github.com/devcows/hugo-universal-theme) theme and [Hugo Book](https://github.com/alex-shpak/hugo-book) theme, maintained by this project [maintainers](#Maintainers), which publish on https://openeuler.org. Now we are under developing. you are welcome to join us. +website is the openEuler community content management system base on [Hugo](https://gohugo.io/) framework, [Universal Theme for Hugo](https://github.com/devcows/hugo-universal-theme) and [Hugo Book](https://github.com/alex-shpak/hugo-book) theme. website is maintained by our [maintainers](#Maintainers), and will be published on https://openeuler.org. website is currently under development. You are welcomed to join us. ### Installation -1. Build Image +1. Build the image ``` docker build -t website:v0.0.1 ``` -2. Running in container +2. Run the container ``` docker run -p 80:80 -d website:v0.0.1 > web.pid ``` -The website will serving on http://your-server-ip:80 +The website will be served on http://your-server-ip:80. -3. Stopping the container +3. Stop the container ``` docker rm -f `cat web.pid` && rm -f web.pid ``` -### Debug +### Debugging 1. Install Hugo @@ -41,7 +41,7 @@ chmod +x hugo && mv hugo /usr/local/bin/ hugo serve --bind 0.0.0.0 --port 80 --baseUrl / ``` -The website will serving on http://your-server-ip:80, any change will take effect here. +The website will be served on http://your-server-ip:80. Any changes will take effect here. ### Maintainers @@ -56,9 +56,9 @@ The website will serving on http://your-server-ip:80, any change will take effec 3. Commit your code 4. Create Pull Request -Please refer to [CONTRIBUTING](./CONTRIBUTING.md) for more guide. +Please refer to [CONTRIBUTING](./CONTRIBUTING.md) for more detailed guides. -### Get Help +### Getting Help -- IRC： #openeuler-infra -- Mail: infra@openeuler.org +- IRC: #openeuler-infra +- Mail: infra@openeuler.org \ No newline at end of file -- Gitee From 93ffd382e3fd9fb4de7b22c2f6bac66a6b78800e Mon Sep 17 00:00:00 2001 From: gomico Date: Thu, 28 Oct 2021 00:58:40 +0000 Subject: [PATCH 2/3] update README.md. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fa4b014..7063760 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ### Brief Introduction -website is the openEuler community content management system base on [Hugo](https://gohugo.io/) framework, [Universal Theme for Hugo](https://github.com/devcows/hugo-universal-theme) and [Hugo Book](https://github.com/alex-shpak/hugo-book) theme. website is maintained by our [maintainers](#Maintainers), and will be published on https://openeuler.org. website is currently under development. You are welcomed to join us. +website is the openEuler community content management system base on [Hugo](https://gohugo.io/) framework, [Universal Theme for Hugo](https://github.com/devcows/hugo-universal-theme) and [Hugo Book](https://github.com/alex-shpak/hugo-book) theme. website is maintained by our project [maintainers](#Maintainers), and will be published on https://openeuler.org. website is currently under development. You are welcomed to join us. ### Installation @@ -18,7 +18,7 @@ docker build -t website:v0.0.1 docker run -p 80:80 -d website:v0.0.1 > web.pid ``` -The website will be served on http://your-server-ip:80. +The website will be served at http://your-server-ip:80. 3. Stop the container @@ -41,7 +41,7 @@ chmod +x hugo && mv hugo /usr/local/bin/ hugo serve --bind 0.0.0.0 --port 80 --baseUrl / ``` -The website will be served on http://your-server-ip:80. Any changes will take effect here. +The website will be served at http://your-server-ip:80. Any changes will take effect here. ### Maintainers -- Gitee From e77667bc43527b0eed691021b8ff5e1da2175f0e Mon Sep 17 00:00:00 2001 From: gomico Date: Thu, 28 Oct 2021 01:00:05 +0000 Subject: [PATCH 3/3] add README.zh.md. translated README.md into Chinese --- README.zh.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 README.zh.md diff --git a/README.zh.md b/README.zh.md new file mode 100644 index 0000000..90d5892 --- /dev/null +++ b/README.zh.md @@ -0,0 +1,64 @@ +# website + +### 简介 + +website 是基于 [Hugo](https://gohugo.io/) 框架、[Universal Theme for Hugo](https://github.com/devcows/hugo-universal-theme) 和 [Hugo Book](https://github.com/alex-shpak/hugo-book) 主题开发的 openEuler 社区内容管理系统。website 由我们的项目[维护人员](#维护人员)进行维护并且会发布在 https://openeuler.org。website 目前处在开发阶段，欢迎加入我们，参与贡献。 + +### 安装 + +1. 构建镜像 + +``` +docker build -t website:v0.0.1 +``` + +2. 运行容器 + +``` +docker run -p 80:80 -d website:v0.0.1 > web.pid +``` + +website 将会显示在 http://your-server-ip:80。 + +3. 停止容器 + +``` +docker rm -f `cat web.pid` && rm -f web.pid +``` + +### 调试 + +1. 安装 Hugo + +``` +curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_0.56.3_Linux-64bit.tar.gz | tar -xz && \ +chmod +x hugo && mv hugo /usr/local/bin/ +``` + +2. 运行 Hugo + +``` +hugo serve --bind 0.0.0.0 --port 80 --baseUrl / +``` + +website 将会显示在 http://your-server-ip:80。任何改动均会在此生效。 + +### 维护人员 + +1. freesky-edward +2. edisonxiang +3. TommyLike + +### 参与贡献 + +1. Fork 本仓库 +2. 新建 Feat_xxx 分支 +3. 提交代码 +4. 新建 Pull Request + +请参阅 [CONTRIBUTING](./CONTRIBUTING.md) 查看详细的贡献指南。 + +### 获取帮助 + +- IRC 频道：#openeuler-infra +- 邮件：infra@openeuler.org \ No newline at end of file -- Gitee