You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pegasus.apache.org by wu...@apache.org on 2020/11/02 03:43:47 UTC

[incubator-pegasus-website] branch master updated: add english version of compilation

This is an automated email from the ASF dual-hosted git repository.

wutao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pegasus-website.git


The following commit(s) were added to refs/heads/master by this push:
     new d2fd4db  add english version of compilation
d2fd4db is described below

commit d2fd4db1c096871959180fb0bc34c5b0f8a4e193
Author: neverchanje <wu...@gmail.com>
AuthorDate: Mon Nov 2 11:43:30 2020 +0800

    add english version of compilation
---
 _docs/en/build/compile-by-docker.md           | 57 +++++++++++++++++++++++++++
 _docs/{zh => en}/build/compile-from-source.md | 31 +++++++++------
 _docs/en/downloads.md                         | 18 +++++++++
 _docs/en/installation.md                      |  5 ---
 _docs/zh/build/compile-from-source.md         |  6 +++
 _sass/_layout.scss                            |  4 ++
 6 files changed, 103 insertions(+), 18 deletions(-)

diff --git a/_docs/en/build/compile-by-docker.md b/_docs/en/build/compile-by-docker.md
new file mode 100755
index 0000000..fb8e2d0
--- /dev/null
+++ b/_docs/en/build/compile-by-docker.md
@@ -0,0 +1,57 @@
+---
+permalink: docs/build/compile-by-docker/
+---
+
+## Download the docker image
+
+Pegasus encapsulates the building environment into a [docker image](https://hub.docker.com/r/apachepegasus/build-env), you can build directly based on this environment.
+
+```sh
+docker pull apachepegasus/build-env:centos6
+```
+
+To build based on a formally released stable version (e.g {{ site.latest_pegasus_version }}), you can pull as follow:
+
+```sh
+docker pull apachepegasus/build-env:{{ site.latest_pegasus_version }}-centos6
+```
+
+## Compilation
+
+Please refer to [Downloads](/docs/downloads) to fetch the sources under a directory (`/your/local/apache-pegasus-source`). Then run the following command:
+
+```sh
+docker run -v /your/local/apache-pegasus-source:/root/pegasus \
+           apachepegasus/build-env:centos6 \
+           /bin/bash -c "./run.sh build -c"
+```
+
+The output of compilation will be placed under `DSN_ROOT` of the source directory. It includes `bin`, `include` and `lib`.
+
+## Packaging
+
+Package server binaries for deployment:
+
+```bash
+docker run -v /your/local/apache-pegasus-source:/root/pegasus \
+           apachepegasus/build-env:centos6 \
+           /bin/bash -c "./run.sh pack_server"
+```
+
+Package client libraries for C/C++ development:
+
+```bash
+docker run -v /your/local/apache-pegasus-source:/root/pegasus \
+           apachepegasus/build-env:centos6 \
+           /bin/bash -c "./run.sh pack_client"
+```
+
+Package toolset which includes various tools (shell, bench):
+
+```bash
+docker run -v /your/local/apache-pegasus-source:/root/pegasus \
+           apachepegasus/build-env:centos6 \
+           /bin/bash -c "./run.sh pack_tools"
+```
+
+If this is your first time compiling Pegasus, it's recommended to try [onebox](/overview/onebox).
diff --git a/_docs/zh/build/compile-from-source.md b/_docs/en/build/compile-from-source.md
similarity index 59%
copy from _docs/zh/build/compile-from-source.md
copy to _docs/en/build/compile-from-source.md
index 71be587..78d311c 100755
--- a/_docs/zh/build/compile-from-source.md
+++ b/_docs/en/build/compile-from-source.md
@@ -5,11 +5,16 @@ redirect_from:
 version: 2.1.0
 ---
 
-Pegasus目前只支持Linux平台进行源码编译。编译过程中遇到问题,可以通过[Github Issues]({{ site.pegasus_github_url }}/issues)向我们咨询。
+Pegasus supports Linux only. Please don't hesitate to contact us via [Github Issues]({{ site.pegasus_github_url }}/issues) when you encountered any problem.
 
-## Ubuntu环境配置
+## Requirements
 
-你可以参考 [pegasus-build-dev/ubuntu16.04](https://github.com/pegasus-kv/pegasus-docker/blob/master/pegasus-build-env/ubuntu16.04/Dockerfile) 的Docker镜像安装全部依赖。
+- GCC 4.9.4+
+- CMake 3.11+
+
+## Ubuntu environment
+
+You can refer to the docker image [pegasus-build-dev/ubuntu16.04](https://github.com/pegasus-kv/pegasus-docker/blob/master/pegasus-build-env/ubuntu16.04/Dockerfile) to install all dependencies.
 
 ```bash
 apt-get -y install build-essential \
@@ -34,9 +39,9 @@ apt-get -y install build-essential \
 pip3 install --no-cache-dir cmake
 ```
 
-## CentOS环境配置
+## CentOS environment
 
-你可以参考 [pegasus-build-dev/centos7](https://github.com/pegasus-kv/pegasus-docker/blob/master/pegasus-build-env/centos7/Dockerfile) 的Docker镜像安装全部依赖。
+You can refer to the docker image [pegasus-build-dev/centos7](https://github.com/pegasus-kv/pegasus-docker/blob/master/pegasus-build-env/centos7/Dockerfile) to install all dependencies.
 
 ```bash
 yum -y install centos-release-scl \
@@ -70,34 +75,34 @@ yum -y install devtoolset-7-gcc \
 pip3 install --no-cache-dir cmake
 ```
 
-## 源码编译
+## Compilation
 
-请先参考[下载文档](/docs/downloads)获取源码。
+Please refer to [Downloads](/docs/downloads) to fetch the sources。
 
 ```bash
 ./run.sh build -c
 ```
 
-编译后输出会放在当前目录的`DSN_ROOT/`文件夹下,里面包含bin、include、lib目录。
+The output of compilation will be placed under `DSN_ROOT` of the source directory. It includes `bin`, `include` and `lib`.
 
-## 编译打包
+## Packaging
 
-打包server端程序包,用于服务部署:
+Package server binaries for deployment:
 
 ```bash
 ./run.sh pack_server
 ```
 
-打包client端库,用于C/C++端客户端开发:
+Package client libraries for C/C++ development:
 
 ```bash
 ./run.sh pack_client
 ```
 
-打包tools工具集,里面包含了各种工具(shell、bench):
+Package toolset which includes various tools (shell, bench):
 
 ```bash
 ./run.sh pack_tools
 ```
 
-编译成功后,推荐先[体验onebox集群](/overview/onebox)。
+If this is your first time compiling Pegasus, it's recommended to try [onebox](/overview/onebox).
diff --git a/_docs/en/downloads.md b/_docs/en/downloads.md
new file mode 100644
index 0000000..f53af0b
--- /dev/null
+++ b/_docs/en/downloads.md
@@ -0,0 +1,18 @@
+---
+permalink: docs/downloads/
+---
+
+We recommend downloading the signed source release that follows [ASF Release Policy](http://www.apache.org/legal/release-policy.html):
+
+Package | Signature | Checksum | Release Notes |
+---|---|---|---|
+[Apache Pegasus 2.1.0](https://dist.apache.org/repos/dist/release/incubator/pegasus/2.1.0/apache-pegasus-2.1.0-source-release.zip) | [asc](https://dist.apache.org/repos/dist/release/incubator/pegasus/2.1.0/apache-pegasus-2.1.0-source-release.zip.asc) | [sha512](https://dist.apache.org/repos/dist/release/incubator/pegasus/2.1.0/apache-pegasus-2.1.0-source-release.zip.sha512) | [Apache Pegasus 2.1.0 Release Notes](https://cwiki.apache.org/confluence/display/PEGASUS/Apache+Pegasus+2.1.0+Rel [...]
+
+You can also download the sources via git clone:
+
+```bash
+git clone {{ site.pegasus_github_url }}.git --recursive
+cd pegasus
+git checkout -b v2.1.0 v2.1.0
+git submodule update
+```
diff --git a/_docs/en/installation.md b/_docs/en/installation.md
deleted file mode 100755
index 3c58337..0000000
--- a/_docs/en/installation.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-permalink: docs/installation/
----
-
-TRANSLATING
diff --git a/_docs/zh/build/compile-from-source.md b/_docs/zh/build/compile-from-source.md
index 71be587..83e4c80 100755
--- a/_docs/zh/build/compile-from-source.md
+++ b/_docs/zh/build/compile-from-source.md
@@ -2,11 +2,17 @@
 permalink: docs/build/compile-from-source/
 redirect_from:
   - 2.1.0/docs/build/compile-from-source/
+  - docs/installation
 version: 2.1.0
 ---
 
 Pegasus目前只支持Linux平台进行源码编译。编译过程中遇到问题,可以通过[Github Issues]({{ site.pegasus_github_url }}/issues)向我们咨询。
 
+## 环境要求
+
+- GCC 4.9.4+
+- CMake 3.11+
+
 ## Ubuntu环境配置
 
 你可以参考 [pegasus-build-dev/ubuntu16.04](https://github.com/pegasus-kv/pegasus-docker/blob/master/pegasus-build-env/ubuntu16.04/Dockerfile) 的Docker镜像安装全部依赖。
diff --git a/_sass/_layout.scss b/_sass/_layout.scss
index f460a2a..658ba7f 100644
--- a/_sass/_layout.scss
+++ b/_sass/_layout.scss
@@ -61,3 +61,7 @@
     outline: none;
     box-shadow: none;
 }
+
+.algolia-autocomplete {
+    width: 100%;
+}


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pegasus.apache.org
For additional commands, e-mail: commits-help@pegasus.apache.org