You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/07/06 08:53:20 UTC

[GitHub] [apisix] yzeng25 opened a new pull request #4546: docs: update CN getting-started

yzeng25 opened a new pull request #4546:
URL: https://github.com/apache/apisix/pull/4546


   ### What this PR does / why we need it:
   <!--- Why is this change required? What problem does it solve? -->
   This change fixes the problems on 'getting-started' page:
   
   - removed '$'
   
   <!--- If it fixes an open issue, please link to the issue here. -->
   
   ### Pre-submission checklist:
   
   * [x] Did you explain what problem does this PR solve? Or what new features have been added?
   * [x] Have you added corresponding test cases?
   * [x] Have you modified the corresponding document?
   * [x] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
   


-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r665045706



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,33 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
 
-**Request**
+1. 通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
+1. 创建路由并绑定后端服务。
+1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议。
+- Port：即端口，这里使用的 `80` 端口。
+- Host：即宿主机，这里的主机是 `httpbin.org`。

Review comment:
       fixed




-- 
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

[GitHub] [apisix] tao12345666333 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
tao12345666333 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664387732



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -243,27 +256,31 @@ $ curl "http://127.0.0.1:9080/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f03433
 现在您可以使用以下命令来调用路由：
 
 ```bash
-$ curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H "apikey: key-of-john"
+curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H "apikey: key-of-john"
 ```
 
-### APISIX Dashboard（控制台）
+### APISIX Dashboard
 
 Apache APISIX 提供了一个 [Dashboard](https://github.com/apache/apisix-dashboard)，让我们的操作更直观更轻松。
 
 ![Dashboard](../../assets/images/dashboard.jpeg)
 
-### 故障排查
+:::note 注意
+APISIX Dashboard 目前仍然是一个实验性功能。
+:::
+
+### 常见问题排查
 
 - 确保所需的所有端口（**默认的 9080/9443/2379**）未被其他系统/进程使用。
 
     下面是终止正在侦听特定端口（基于 unix 的系统）的进程的命令。
 
     ```bash
-    $ sudo fuser -k 9443/tcp
+    sudo fuser -k 9443/tcp
     ```
 
-- 如果 Docker 容器持续不断地重启/失败，请登录容器并观察日志以诊断问题。
+- 如果 Docker 容器持续不断地重启失败，请登录容器并观察日志以诊断问题。

Review comment:
       ```suggestion
   - 如果 Docker 容器持续不断地重启或失败，请登录容器并观察日志以诊断问题。
   ```




-- 
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

[GitHub] [apisix] Yiyiyimu commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
Yiyiyimu commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664738499



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,33 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
 
-**Request**
+1. 通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
+1. 创建路由并绑定后端服务。
+1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议。
+- Port：即端口，这里使用的 `80` 端口。
+- Host：即宿主机，这里的主机是 `httpbin.org`。
+- Path：`/get`。

Review comment:
       ```suggestion
   - Path：即路径，这里是`/get`。
   ```

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -50,39 +66,39 @@ $ curl --location --request GET "http://httpbin.org/get?foo1=bar1&foo2=bar2"
 }
 ```
 
-让我们来分析一下上面的请求 URL：
-
-- Protocol: HTTP
-- Port: 80
-- Host: `httpbin.org`
-- URI/Path: `/get`
-- Query Parameters: foo1, foo2
+## 前提条件
 
-## 前提
+- 已安装[Docker](https://www.docker.com/) 和 [Docker Compose 组件](https://docs.docker.com/compose/)。
 
-> 如果您已经安装了 Apache APISIX，请直接阅读 [第二步](getting-started.md#第二步:-创建一个-Route)
+- 熟悉`curl`命令。本文使用 [curl](https://curl.se/docs/manpage.html) 命令行进行 API 测试。您也可以使用其他工具例如 [Postman](https://www.postman.com/)等，进行测试。

Review comment:
       seems we don't need to be familiar with `curl`, run the command is enough

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -50,39 +66,39 @@ $ curl --location --request GET "http://httpbin.org/get?foo1=bar1&foo2=bar2"
 }
 ```
 
-让我们来分析一下上面的请求 URL：
-
-- Protocol: HTTP
-- Port: 80
-- Host: `httpbin.org`
-- URI/Path: `/get`
-- Query Parameters: foo1, foo2
+## 前提条件
 
-## 前提
+- 已安装[Docker](https://www.docker.com/) 和 [Docker Compose 组件](https://docs.docker.com/compose/)。

Review comment:
       ditto

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,33 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
 
-**Request**
+1. 通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。

Review comment:
       Maybe `docker compose` is enough here, since it seems impossible to only install docker-compose but not docker

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,33 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
 
-**Request**
+1. 通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
+1. 创建路由并绑定后端服务。
+1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议。
+- Port：即端口，这里使用的 `80` 端口。
+- Host：即宿主机，这里的主机是 `httpbin.org`。

Review comment:
       ```suggestion
   - Host：即宿主机，这里是 `httpbin.org`。
   ```




-- 
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

[GitHub] [apisix] Yiyiyimu commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
Yiyiyimu commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875725712


   > Hi, AFAIK, Upstream is used in Apache APISIX (as an Entity) and Kong (as an Upstream Object), it's more technical but not easy to understand
   
   Hi I think the reason we call it "upstream" is mainly because [nginx is calling it this way](http://nginx.org/en/docs/http/ngx_http_upstream_module.html)


-- 
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

[GitHub] [apisix] spacewander merged pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #4546:
URL: https://github.com/apache/apisix/pull/4546


   


-- 
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

[GitHub] [apisix] yzeng25 commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875523190


   @Yiyiyimu @spacewander @juzhiyuan @tao12345666333  guys, please kindly give me some review opinions/comments on English 'Getting Started' document when you are available, thanks!


-- 
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

[GitHub] [apisix] iamayushdas commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
iamayushdas commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875601330


   Table is a good option but what do you think , where will you be placing that table, IMO we could place them in "general" 


-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r665045655



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -50,39 +66,39 @@ $ curl --location --request GET "http://httpbin.org/get?foo1=bar1&foo2=bar2"
 }
 ```
 
-让我们来分析一下上面的请求 URL：
-
-- Protocol: HTTP
-- Port: 80
-- Host: `httpbin.org`
-- URI/Path: `/get`
-- Query Parameters: foo1, foo2
+## 前提条件
 
-## 前提
+- 已安装[Docker](https://www.docker.com/) 和 [Docker Compose 组件](https://docs.docker.com/compose/)。
 
-> 如果您已经安装了 Apache APISIX，请直接阅读 [第二步](getting-started.md#第二步:-创建一个-Route)
+- 熟悉`curl`命令。本文使用 [curl](https://curl.se/docs/manpage.html) 命令行进行 API 测试。您也可以使用其他工具例如 [Postman](https://www.postman.com/)等，进行测试。

Review comment:
       fixed




-- 
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

[GitHub] [apisix] yzeng25 commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875732303


   > > Hi, AFAIK, Upstream is used in Apache APISIX (as an Entity) and Kong (as an Upstream Object), it's more technical but not easy to understand
   > 
   > 
   > 
   > Hi I think the reason we call it "upstream" is mainly because [nginx is calling it this way](http://nginx.org/en/docs/http/ngx_http_upstream_module.html)
   
   Cool, good to know that. It seems like a good choice to follow their pattern.


-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664407312



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。

Review comment:
       > How about using a numbered list? e.g
   > 
   > 1. xx
   > 2. xx
   > 3. xx
   
   Good point, will do




-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664394905



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -243,27 +256,31 @@ $ curl "http://127.0.0.1:9080/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f03433
 现在您可以使用以下命令来调用路由：
 
 ```bash
-$ curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H "apikey: key-of-john"
+curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H "apikey: key-of-john"
 ```
 
-### APISIX Dashboard（控制台）
+### APISIX Dashboard
 
 Apache APISIX 提供了一个 [Dashboard](https://github.com/apache/apisix-dashboard)，让我们的操作更直观更轻松。
 
 ![Dashboard](../../assets/images/dashboard.jpeg)
 
-### 故障排查
+:::note 注意
+APISIX Dashboard 目前仍然是一个实验性功能。
+:::
+
+### 常见问题排查
 
 - 确保所需的所有端口（**默认的 9080/9443/2379**）未被其他系统/进程使用。
 
     下面是终止正在侦听特定端口（基于 unix 的系统）的进程的命令。
 
     ```bash
-    $ sudo fuser -k 9443/tcp
+    sudo fuser -k 9443/tcp
     ```
 
-- 如果 Docker 容器持续不断地重启/失败，请登录容器并观察日志以诊断问题。
+- 如果 Docker 容器持续不断地重启失败，请登录容器并观察日志以诊断问题。

Review comment:
       fixed

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。

Review comment:
       > How about using a numbered list? e.g
   > 
   > 1. xx
   > 2. xx
   > 3. xx
   
   Good point, will do

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议
+- Port：即端口，这里使用的`80`端口。
+- Host：即宿主机，这里的主机是`httpbin.org`
+- URI/Path：`/get`

Review comment:
       Is it a path or a URI? It is written this way before the change. Please clarify.

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议
+- Port：即端口，这里使用的`80`端口。
+- Host：即宿主机，这里的主机是`httpbin.org`
+- URI/Path：`/get`

Review comment:
       Fixed, Path.




-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664394905



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -243,27 +256,31 @@ $ curl "http://127.0.0.1:9080/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f03433
 现在您可以使用以下命令来调用路由：
 
 ```bash
-$ curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H "apikey: key-of-john"
+curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H "apikey: key-of-john"
 ```
 
-### APISIX Dashboard（控制台）
+### APISIX Dashboard
 
 Apache APISIX 提供了一个 [Dashboard](https://github.com/apache/apisix-dashboard)，让我们的操作更直观更轻松。
 
 ![Dashboard](../../assets/images/dashboard.jpeg)
 
-### 故障排查
+:::note 注意
+APISIX Dashboard 目前仍然是一个实验性功能。
+:::
+
+### 常见问题排查
 
 - 确保所需的所有端口（**默认的 9080/9443/2379**）未被其他系统/进程使用。
 
     下面是终止正在侦听特定端口（基于 unix 的系统）的进程的命令。
 
     ```bash
-    $ sudo fuser -k 9443/tcp
+    sudo fuser -k 9443/tcp
     ```
 
-- 如果 Docker 容器持续不断地重启/失败，请登录容器并观察日志以诊断问题。
+- 如果 Docker 容器持续不断地重启失败，请登录容器并观察日志以诊断问题。

Review comment:
       fixed




-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r665045505



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,33 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
 
-**Request**
+1. 通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。

Review comment:
       fixed




-- 
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

[GitHub] [apisix] juzhiyuan commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875591854


   what do you think? @KishaniKandasamy @iamayushdas 


-- 
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

[GitHub] [apisix] juzhiyuan commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664402875



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。

Review comment:
       ```suggestion
   除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
   ```

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。

Review comment:
       How about using a numbered list? e.g
   
   1. xx
   2. xx
   3. xx

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议
+- Port：即端口，这里使用的`80`端口。
+- Host：即宿主机，这里的主机是`httpbin.org`
+- URI/Path：`/get`

Review comment:
       path? uri?

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。

Review comment:
       added spaces around `curl`
   
   ```suggestion
   本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
   ```

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议
+- Port：即端口，这里使用的`80`端口。

Review comment:
       Please add spaces around `number` and `URL`




-- 
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

[GitHub] [apisix] spacewander commented on pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
spacewander commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-874672005


   Yes, change EN doc at the same time can avoid content mismatch.


-- 
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

[GitHub] [apisix] tao12345666333 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
tao12345666333 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664387732



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -243,27 +256,31 @@ $ curl "http://127.0.0.1:9080/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f03433
 现在您可以使用以下命令来调用路由：
 
 ```bash
-$ curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H "apikey: key-of-john"
+curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H "apikey: key-of-john"
 ```
 
-### APISIX Dashboard（控制台）
+### APISIX Dashboard
 
 Apache APISIX 提供了一个 [Dashboard](https://github.com/apache/apisix-dashboard)，让我们的操作更直观更轻松。
 
 ![Dashboard](../../assets/images/dashboard.jpeg)
 
-### 故障排查
+:::note 注意
+APISIX Dashboard 目前仍然是一个实验性功能。
+:::
+
+### 常见问题排查
 
 - 确保所需的所有端口（**默认的 9080/9443/2379**）未被其他系统/进程使用。
 
     下面是终止正在侦听特定端口（基于 unix 的系统）的进程的命令。
 
     ```bash
-    $ sudo fuser -k 9443/tcp
+    sudo fuser -k 9443/tcp
     ```
 
-- 如果 Docker 容器持续不断地重启/失败，请登录容器并观察日志以诊断问题。
+- 如果 Docker 容器持续不断地重启失败，请登录容器并观察日志以诊断问题。

Review comment:
       ```suggestion
   - 如果 Docker 容器持续不断地重启或失败，请登录容器并观察日志以诊断问题。
   ```




-- 
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

[GitHub] [apisix] yzeng25 commented on pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-874718475


   > Yes, change EN doc at the same time can avoid content mismatch.
   
   OK, will deliver.


-- 
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

[GitHub] [apisix] yzeng25 commented on pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875261826


   > I think it's not appropriate to call it "后端服务" since there is no "前端". Maybe call it "上游" is more accurate
   
   Ok, I will fix them in both languages.


-- 
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

[GitHub] [apisix] juzhiyuan commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664402875



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。

Review comment:
       ```suggestion
   除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
   ```

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。

Review comment:
       How about using a numbered list? e.g
   
   1. xx
   2. xx
   3. xx

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议
+- Port：即端口，这里使用的`80`端口。
+- Host：即宿主机，这里的主机是`httpbin.org`
+- URI/Path：`/get`

Review comment:
       path? uri?

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。

Review comment:
       added spaces around `curl`
   
   ```suggestion
   本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
   ```

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议
+- Port：即端口，这里使用的`80`端口。

Review comment:
       Please add spaces around `number` and `URL`




-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r665045575



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,33 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
 
-**Request**
+1. 通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
+1. 创建路由并绑定后端服务。
+1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议。
+- Port：即端口，这里使用的 `80` 端口。
+- Host：即宿主机，这里的主机是 `httpbin.org`。
+- Path：`/get`。

Review comment:
       fixed

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -50,39 +66,39 @@ $ curl --location --request GET "http://httpbin.org/get?foo1=bar1&foo2=bar2"
 }
 ```
 
-让我们来分析一下上面的请求 URL：
-
-- Protocol: HTTP
-- Port: 80
-- Host: `httpbin.org`
-- URI/Path: `/get`
-- Query Parameters: foo1, foo2
+## 前提条件
 
-## 前提
+- 已安装[Docker](https://www.docker.com/) 和 [Docker Compose 组件](https://docs.docker.com/compose/)。

Review comment:
       fixed




-- 
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

[GitHub] [apisix] Yiyiyimu commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
Yiyiyimu commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664743894



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,33 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
 
-**Request**
+1. 通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
+1. 创建路由并绑定后端服务。

Review comment:
       ```suggestion
   2. 创建路由并绑定后端服务。
   ```




-- 
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

[GitHub] [apisix] KishaniKandasamy commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
KishaniKandasamy commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875743610


   > what do you think? @KishaniKandasamy @iamayushdas
   
   
   Yes It is a much better way  to understand internal words 
   
   


-- 
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

[GitHub] [apisix] yzeng25 commented on pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-874642555


   > Chinese LGTM, and do we need to update the English version in the same PR?
   > 
   > cc @spacewander
   
   Yeah sure. 


-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664419147



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议
+- Port：即端口，这里使用的`80`端口。
+- Host：即宿主机，这里的主机是`httpbin.org`
+- URI/Path：`/get`

Review comment:
       Fixed, Path.




-- 
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

[GitHub] [apisix] yzeng25 commented on pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-874642555


   > Chinese LGTM, and do we need to update the English version in the same PR?
   > 
   > cc @spacewander
   
   Yeah sure. 


-- 
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

[GitHub] [apisix] tokers commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
tokers commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875540288


   > I think it's not appropriate to call it "后端服务" since there is no "前端". Maybe call it "上游" is more accurate
   
   If we decide to use the term "上游"，then we may use it everywhere of our documentations.
   
   By the way, a glossary might be required.


-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r664413302



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,29 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。
 
-**Request**
+除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。
+
+我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+
+**请求内容**
+
+请求 URL 由以下这些参数构成：
+
+- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议
+- Port：即端口，这里使用的`80`端口。
+- Host：即宿主机，这里的主机是`httpbin.org`
+- URI/Path：`/get`

Review comment:
       Is it a path or a URI? It is written this way before the change. Please clarify.




-- 
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

[GitHub] [apisix] yzeng25 commented on a change in pull request #4546: docs: update CN getting-started

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#discussion_r665046890



##########
File path: docs/zh/latest/getting-started.md
##########
@@ -21,17 +21,33 @@ title: 快速入门指南
 #
 -->
 
-本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。
+## 概述
 
-另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
 
-**Request**
+1. 通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
+1. 创建路由并绑定后端服务。

Review comment:
       Doucusarus will automatically change this '111....1'to a '123...n' order. I prefer leave it as it is. 
   
   In case we have to add some more steps to it, then I would need to only add a '1. step description' to the document, rather than change all orders one by one.




-- 
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

[GitHub] [apisix] yzeng25 commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875582063


   > > I think it's not appropriate to call it "后端服务" since there is no "前端". Maybe call it "上游" is more accurate
   > 
   > If we decide to use the term "上游"，then we may use it everywhere of our documentations.
   > 
   > By the way, a glossary might be required.
   
   Yes, this PR uses "Upstream" **everywhere in 'Getting-Started' document**, except 2-3ish places where it needs to explain what is an "Upstream", or give a synonym of "Upstream". 
   
   The current situation is that "Upstream", "后端服务" and other words are referencing to the same thing with different names (Maybe they do have some tiny differences after all). Thus, it creates confusion for me to read, identify and understand this document.
   
   This then brings up more abstracted problems: 
   
   1.  Similarly, here is what I would ask: is there an "upstream" since there  is no "downstream"? which of the following is more broadly accepted, "后端服务", or "上游"?
   2. Where is the glossary? Yes, we definitely need a glossary to explain and define frequently used words and phrases. But it is not my top priority task yet. 
   2. How many other places are referencing the same thing with different names? I don't know, it is just a matter of time to find out and fix them.
   3. Why this change is only made in 'Getting-Started' document'?  Well, it is the very first document page or the 'entry' of all Apache APISIX documents. I want this page to be somewhat helpful and impressing.
   4. Are we missing other sorts of documents? Along with Q1 and Q3, my answer is yes. We definitely need a product overview, product architecture, glossary, etc, to form a series of 'Product Introduction' documents. And we do need other series of documents as well. The reason why I am not doing this right now is that I am new to this team, and I want to find out how can I make good use of the existing documents. 
   
   Hope this clarifies your concerns.
   


-- 
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

[GitHub] [apisix] yzeng25 commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-876100749


   Hi all, after this morning's discussion, we decided to use the term "Upstream service" and "上游服务" in our documents.  PR is ready for review,.
   @juzhiyuan @tokers @spacewander @Yiyiyimu 
   cc @membphis @iamayushdas @KafilatAdeleke 


-- 
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

[GitHub] [apisix] juzhiyuan commented on pull request #4546: docs: update CN and EN getting-started documents

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on pull request #4546:
URL: https://github.com/apache/apisix/pull/4546#issuecomment-875591705


   > Similarly, here is what I would ask: is there an "upstream" since there is no "downstream"? which of the following is more broadly accepted, "后端服务", or "上游"?
   
   Hi, AFAIK, Upstream is used in Apache APISIX (as an Entity) and Kong (as an Upstream Object), it's more technical but not easy to understand, as a Getting Started guide, Backend Server/Target Node would be more clear and easy to know what it is. Maybe we could have a table including some description for internal words?


-- 
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