[GitHub] [apisix] yzeng25 commented on a change in pull request #4577: docs: update CN how-to-build document

[GitBox <gi...@apache.org>]

yzeng25 commented on a change in pull request #4577:
URL: https://github.com/apache/apisix/pull/4577#discussion_r667592600



##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -21,146 +21,200 @@ title: 如何构建 Apache APISIX
 #
 -->
 
-## 1. 安装依赖
+## 步骤1：安装依赖
 
-Apache APISIX 的运行环境需要 Nginx 和 etcd，
+Apache APISIX 的运行环境需要依赖 Nginx 和 etcd，所以在安装 Apache APISIX 前，请根据您使用的操作系统安装对应的依赖。我们提供了 **CentOS7** 、**Fedora 31 & 32** 、**Ubuntu 16.04 & 18.04** 、 **Debian 9 & 10** 和 **MacOS X** 的依赖安装操作步骤，详情请参考[安装依赖](install-dependencies.md)。
 
-所以在安装前，请根据不同的操作系统来[安装依赖](install-dependencies.md)。
+通过 Docker 或 Helm Chart 安装 Apache APISIX 时，已经包含了所需的 Nginx 和 etcd，请参照各自对应的文档。
 
-通过 Docker / Helm Chart 安装时可能已经包含了所需的 Nginx 和 etcd。
-请参照各自对应的文档。
+## 步骤2：安装 Apache APISIX
 
-## 2. 安装 Apache APISIX
+你可以通过源码包、RPM 包、Docker、Helm Chart 等多种方式来安装 Apache APISIX。请在以下选项中选择其中一种执行。
 
-你可以通过源码包、Docker、Helm Chart 等多种方式来安装 Apache APISIX。
+### 通过源码包安装
+
+1. 创建一个名为 `apisix-2.7` 的文件夹。
+
+  ```shell
+  mkdir apisix-2.7
+  ```
+
+2. 下载 Apache Release 源码包：
+
+  ```shell
+  wget https://downloads.apache.org/apisix/2.7/apache-apisix-2.7-src.tgz
+  ```
+
+3. 解压 Apache Release 源码包：
+
+  ```shell
+  tar zxvf apache-apisix-2.7-src.tgz -C apisix-2.7
+  ```
+
+4. 安装运行时依赖的 Lua 库：
+
+  ```shell
+  # 切换到 apisix-2.7 文件夹
+  cd apisix-2.7
+  # 创建依赖
+  make deps
+  ```
 
 ### 通过 RPM 包安装（CentOS 7）
 
+这种安装方式适用于 CentOS 7 操作系统，请运行以下命令安装 Apache APISIX。
+
 ```shell
 sudo yum install -y https://github.com/apache/apisix/releases/download/2.7/apisix-2.7-0.x86_64.rpm
 ```
 
 ### 通过 Docker 安装
 
-见 https://hub.docker.com/r/apache/apisix
+详情请参考：[使用 Docker 安装 Apache APISIX](https://hub.docker.com/r/apache/apisix)。
 
 ### 通过 Helm Chart 安装
 
-见 https://github.com/apache/apisix-helm-chart
+详情请参考：[使用 Helm Chart 安装 Apache APISIX](https://github.com/apache/apisix-helm-chart)。
 
-### 通过源码包安装
+## 步骤3：管理 APISIX 服务
 
-你需要先下载 Apache Release 源码包：
+我们可以在 APISIX 的目录下使用命令初始化依赖、启动服务和停止服务，也可以通过 `make help` 命令查看所有命令和对应的功能。
 
-```shell
-$ mkdir apisix-2.7
-$ wget https://downloads.apache.org/apisix/2.7/apache-apisix-2.7-src.tgz
-$ tar zxvf apache-apisix-2.7-src.tgz -C apisix-2.7
-```
+### 初始化依赖
 
-安装运行时依赖的 Lua 库：
+运行以下命令初始化 Nginx 配置文件和 etcd。
 
-```
-cd apisix-2.7
-make deps
+```shell
+# init nginx config file and etcd
+make init
 ```
 
-## 3. 管理（启动、关闭等）APISIX 服务
+### 启动 APISIX
 
-我们可以在 apisix 的目录下用 `make run` 命令来启动服务，或者用 `make stop` 方式关闭服务。
+运行以下命令启动 APISIX。
 
 ```shell
-# init nginx config file and etcd
-$ make init
-
 # start APISIX server
-$ make run
+make run
+```
+
+### 停止运行 APISIX
+
+优雅停机 `make quit` 和强制停机 `make stop`都可以停止运行 APISIX。建议您优先选择优雅停机的方式停止 APISIX，因为这种停止方式能够保证 APISIX 完成了已经接受到的请求之后再停止；而强制停机则是立即停止 APISIX，在这种情况下，APISIX 接收到但未完成的请求会随着强制停机一并停止。
 
+执行优雅停机的命令如下所示：
+
+```shell
 # stop APISIX server gracefully
-$ make quit
+make quit
+```
 
+执行强制停机的命令如下所示：
+
+```shell
 # stop APISIX server immediately
-$ make stop
+make stop
+```
 
+### 查看其他操作
+
+运行`make help` 命令，查看返回结果，获取其他操作的命令和描述。
+
+```shell
 # more actions find by `help`
-$ make help
+make help
 ```
 
-## 4. 运行测试案例
+## 步骤4：运行测试案例
+
+1. 安装 `perl` 的包管理器 `cpanminus`。
+
+2. 然后通过 `cpanm` 来安装 test-nginx 的依赖：
 
-1. 先安装 perl 的包管理器 cpanminus
-2. 然后通过 cpanm 来安装 test-nginx 的依赖：`sudo cpanm --notest Test::Nginx IPC::Run > build.log 2>&1 || (cat build.log && exit 1)`
-3. 然后 clone 最新的源码：`git clone https://github.com/iresty/test-nginx.git`。注意使用我们 fork 出来的版本。
-4. 通过 perl 的 `prove` 命令来加载 test-nginx 的库，并运行 `/t` 目录下的测试案例集：
+  ```shell
+  sudo cpanm --notest Test::Nginx IPC::Run > build.log 2>&1 || (cat build.log && exit 1)
+  ```
+
+3. 然后 clone 最新的源码，请使用我们 fork 出来的版本：
+
+  ```shell
+  git clone https://github.com/iresty/test-nginx.git
+  ```
+
+4. 通过 `perl` 的 `prove` 命令来加载 test-nginx 的库，并运行 `/t` 目录下的测试案例集：
     * 追加当前目录到perl模块目录： `export PERL5LIB=.:$PERL5LIB`
     * 直接运行：`make test`
-    * 指定 nginx 二进制路径：`TEST_NGINX_BINARY=/usr/local/bin/openresty prove -Itest-nginx/lib -r t`
+    * 指定 Nginx 二进制路径：`TEST_NGINX_BINARY=/usr/local/bin/openresty prove -Itest-nginx/lib -r t`

Review comment:
       Yes, these **bullet points** should be **steps**  under Step 4, right?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org