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/03/31 06:55:14 UTC
[GitHub] [apisix] yzeng25 commented on a change in pull request #6763: docs: update "General" Plugins
yzeng25 commented on a change in pull request #6763:
URL: https://github.com/apache/apisix/pull/6763#discussion_r839222464
##########
File path: docs/en/latest/plugins/batch-requests.md
##########
@@ -63,54 +77,56 @@ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API
## Metadata
-| Name | Type | Requirement | Default | Valid | Description |
-| ---------------- | ------- | ------ | ------------- | ------- | ------------------------------------------------ |
-| max_body_size | integer | required | 1048576 | > 0 | the maximum of request body size in bytes |
+| Name | Type | Required | Default | Valid values | Description |
+| ------------- | ------- | -------- | ------- | ------------ | ------------------------------------------ |
+| max_body_size | integer | True | 1048576 | > 0 | Maximum size of the request body in bytes. |
Review comment:
Maybe using brackets is better?
```suggestion
| max_body_size | integer | True | 1048576 | [1,...] | Maximum size of the request body in bytes. |
```
##########
File path: docs/en/latest/plugins/server-info.md
##########
@@ -89,18 +95,17 @@ $ curl http://127.0.0.1:9090/v1/server_info -s | jq .
}
```
-The APISIX Dashboard will collects server info in etcd, so you may also try to check them through Dashboard.
+:::tip
+
+You can also view the server info report through the [APISIX Dashboard](/docs/dashboard/USER_GUIDE).
+
+:::
## Disable Plugin
-Remove `server-info` in the plugin list of configure file `conf/config.yaml`.
+To disable the Plugin, you can remove `server-info` from the list of Plugins in your configuration file:
-```
-plugins: # plugin list
- - example-plugin
- - limit-req
- - node-status
- - jwt-auth
- - zipkin
- ......
+```yaml title="conf/config.yaml"
Review comment:
Could you explain about `yaml title="conf/config.yaml"` part? I can't really get the point of using it.
##########
File path: docs/en/latest/plugins/ext-plugin-post-req.md
##########
@@ -23,9 +28,6 @@ title: ext-plugin-post-req
## Description
-`ext-plugin-post-req` is almost the same as `ext-plugin-pre-req`.
+`ext-plugin-post-req` differs from the [ext-plugin-pre-req](./ext-plugin-pre-req.md) Plugin in that it runs after executing the built-in Lua Plugins and before proxying to the Upstream.
Review comment:
I think stressing the difference in bold size letters could help :)
```suggestion
`ext-plugin-post-req` differs from the [ext-plugin-pre-req](./ext-plugin-pre-req.md) Plugin in that **it runs after executing the built-in Lua Plugins and before proxying to the Upstream**.
```
--
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