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 2022/01/05 03:05:20 UTC

[GitHub] [apisix] piglei opened a new pull request #6016: Tiny enhancements on documentation("getting-started", "plugin" )

piglei opened a new pull request #6016:
URL: https://github.com/apache/apisix/pull/6016


   ### What this PR does / why we need it:
   
   - ("plugin.md") Fix a grammer error (zh language only)
   - ("getting-started.md") Edit "Create a Route - How it works" by replacing the example `Route` payload with an actionable curl command to reduce cognitive overhead
   
   ### Pre-submission checklist:
   
   <!--
   Please follow the PR manners:
   1. Use Draft if the PR is not ready to be reviewed
   2. Test is required for the feat/fix PR, unless you have a good reason
   3. Doc is required for the feat PR
   4. Use a new commit to resolve review instead of `push -f`
   5. If you need to resolve merge conflicts after the PR is reviewed, please merge master but do not rebase
   6. Use "request review" to notify the reviewer once you have resolved the review
   7. Only reviewer can click "Resolve conversation" to mark the reviewer's review resolved
   -->
   
   * [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] piglei commented on a change in pull request #6016: Tiny enhancements on documentation("getting-started", "plugin" )

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



##########
File path: docs/en/latest/getting-started.md
##########
@@ -138,35 +138,36 @@ Apache APISIX provides users with a powerful [Admin API](./admin-api.md) and [AP
 
 We can create a [Route](./architecture-design/route.md) and connect it to an Upstream service(also known as the [Upstream](./architecture-design/upstream.md)). When a `Request` arrives at Apache APISIX, Apache APISIX knows which Upstream the request should be forwarded to.
 
-Because we have configured matching rules for the Route object, Apache APISIX can forward the request to the corresponding Upstream service. The following code is an example of a Route configuration:
+Because we have configured matching rules for the Route object, Apache APISIX can forward the request to the corresponding Upstream service. The following code creates a sample configuration of Route:
 
 ```json

Review comment:
       Updated.




-- 
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 a change in pull request #6016: Tiny enhancements on documentation("getting-started", "plugin" )

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



##########
File path: docs/en/latest/getting-started.md
##########
@@ -138,35 +138,36 @@ Apache APISIX provides users with a powerful [Admin API](./admin-api.md) and [AP
 
 We can create a [Route](./architecture-design/route.md) and connect it to an Upstream service(also known as the [Upstream](./architecture-design/upstream.md)). When a `Request` arrives at Apache APISIX, Apache APISIX knows which Upstream the request should be forwarded to.
 
-Because we have configured matching rules for the Route object, Apache APISIX can forward the request to the corresponding Upstream service. The following code is an example of a Route configuration:
+Because we have configured matching rules for the Route object, Apache APISIX can forward the request to the corresponding Upstream service. The following code creates a sample configuration of Route:
 
 ```json

Review comment:
       ```suggestion
   ```bash
   ```

##########
File path: docs/zh/latest/getting-started.md
##########
@@ -136,35 +136,36 @@ Apache APISIX 提供了强大的 [Admin API](./admin-api.md) 和 [Dashboard](htt
 
 我们可以创建一个 [Route](./architecture-design/route.md) 并与上游服务（通常也被称为 [Upstream](./architecture-design/upstream.md) 或后端服务）绑定，当一个 `请求（Request）` 到达 Apache APISIX 时，Apache APISIX 就会明白这个请求应该转发到哪个上游服务中。
 
-因为我们为 Route 对象配置了匹配规则，所以 Apache APISIX 可以将请求转发到对应的上游服务。以下代码是一个 Route 配置示例：
+因为我们为 Route 对象配置了匹配规则，所以 Apache APISIX 可以将请求转发到对应的上游服务。以下代码会创建一个示例 Route 配置：
 
 ```json

Review comment:
       Ditto




-- 
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 #6016: Tiny enhancements on documentation("getting-started", "plugin" )

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


   Also cc @yzeng25 to have a review 🥰


-- 
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 #6016: docs: tiny enhancements on documentation("getting-started", "plugin" )

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


   


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