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/02/28 01:32:32 UTC
[GitHub] [apisix] juzhiyuan commented on a change in pull request #6464: docs: Restructure the "Architecture Design" Section
juzhiyuan commented on a change in pull request #6464:
URL: https://github.com/apache/apisix/pull/6464#discussion_r815528120
##########
File path: docs/en/latest/architecture-design/apisix.md
##########
@@ -55,6 +59,8 @@ etcd:
host: "http://foo:2379" # etcd address
```
-Other default configurations can be found in the `conf/config-default.yaml` file, which is bound to the APISIX source code. **Never** manually modify the `conf/config-default.yaml` file. If you need to customize any configuration, you should update the `config.yaml` file.
+Default configurations of APISIX can be found in the `conf/config-default.yaml` file.
+
+**Note**: This file is bound to the APISIX source code and should **not** be modified. The configuration should only be changed by the methods mentioned above.
Review comment:
```suggestion
**Note**: This file is bound to the APISIX source code and should **NOT** be modified. The configuration should only be changed by the methods mentioned above.
```
##########
File path: docs/en/latest/architecture-design/apisix.md
##########
@@ -55,6 +59,8 @@ etcd:
host: "http://foo:2379" # etcd address
```
-Other default configurations can be found in the `conf/config-default.yaml` file, which is bound to the APISIX source code. **Never** manually modify the `conf/config-default.yaml` file. If you need to customize any configuration, you should update the `config.yaml` file.
+Default configurations of APISIX can be found in the `conf/config-default.yaml` file.
+
+**Note**: This file is bound to the APISIX source code and should **not** be modified. The configuration should only be changed by the methods mentioned above.
-**Note** `APISIX` will generate `conf/nginx.conf` file automatically, so please _DO NOT EDIT_ `conf/nginx.conf` file too.
+**Note**: The `conf/nginx.conf` file is automatically generated by APISIX and should **not** be edited.
Review comment:
```suggestion
**Note**: The `conf/nginx.conf` file is automatically generated by APISIX and should **NOTE** be edited.
```
##########
File path: docs/en/latest/architecture-design/consumer.md
##########
@@ -21,32 +21,34 @@ title: Consumer
#
-->
-For the API gateway, it is usually possible to identify a certain type of requester by using a domain name such as a request domain name, a client IP address, etc., and then perform plugin filtering and forward the request to the specified upstream, but sometimes the depth is insufficient.
+For an API gateway, it is usually possible to identify the type of the requester by using things like their request domain name and client IP address. A gateway like APISIX can then filter these requests using [Plugins](./plugin.md) and forward it to the specified [Upstream](./upstream.md).
+
+But this level of depth can be insufficient in some occasions.
-As shown in the image above, as an API gateway, you should know who the API Consumer is, so you can configure different rules for different API Consumers.
+An API gateway should know who the consumer of the API is to configure different rules for different consumers.
+
+This is where the Consumer construct comes in APISIX. The fields are defined below.
| Field | Required | Description |
| -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| username | Yes | Consumer Name. |
-| plugins | No | The corresponding plugin configuration of the Consumer, which has the highest priority: Consumer > Route > Service. For specific plugin configurations, refer to the [Plugins](plugin.md) section. |
+| username | Yes | Name of the consumer. |
+| plugins | No | Plugin configuration of the Consumer. has the highest priority: Consumer > Route > Service. For specific Plugin configurations, refer the [Plugins](./plugin.md) section. |
Review comment:
```suggestion
| plugins | No | Plugin configuration of the Consumer. It has the highest priority: Consumer > Route > Service. For specific Plugin configurations, refer the [Plugins](./plugin.md) section. |
```
--
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