docs: replace Enabling with Enable in plugin docs (#9860)

apache · Jul 19, 2023 · 59c1d99 · 59c1d99
1 parent fbe96b8
commit 59c1d99
Show file tree

Hide file tree

Showing 75 changed files with 75 additions and 75 deletions.
diff --git a/docs/en/latest/plugins/api-breaker.md b/docs/en/latest/plugins/api-breaker.md
@@ -53,7 +53,7 @@ In an unhealthy state, if the Upstream service responds with a status code from
 | healthy.http_statuses   | array[integer] | False    | [200]   | [200, ..., 499] | Status codes of Upstream to be considered healthy.                                                                                                                                                                                           |
 | healthy.successes       | integer        | False    | 3       | >=1             | Number of consecutive healthy requests for the Upstream service to be considered healthy.                                                                                                                                                    |
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below shows how you can configure the Plugin on a specific Route:
 

diff --git a/docs/en/latest/plugins/authz-casbin.md b/docs/en/latest/plugins/authz-casbin.md
@@ -57,7 +57,7 @@ If you wish to use a global Casbin configuration, you can first specify `model`
 | model  | string | True     | Casbin model configuration in text format. |
 | policy | string | True     | Casbin policy in text format.              |
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the Plugin on a Route by either using the model/policy file paths or using the model/policy text in Plugin configuration/metadata.
 

diff --git a/docs/en/latest/plugins/authz-casdoor.md b/docs/en/latest/plugins/authz-casdoor.md
@@ -55,7 +55,7 @@ The `callback_url` must belong to the URI of your Route. See the code snippet be
 
 :::
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the Plugin on a specific Route as shown below:
 

diff --git a/docs/en/latest/plugins/authz-keycloak.md b/docs/en/latest/plugins/authz-keycloak.md
@@ -143,7 +143,7 @@ curl --location --request POST 'http://127.0.0.1:9080/api/token' \
 --data-urlencode 'password=<Password>'
 ```
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below shows how you can enable the `authz-keycloak` Plugin on a specific Route. `${realm}` represents the realm name in Keycloak.
 

diff --git a/docs/en/latest/plugins/aws-lambda.md b/docs/en/latest/plugins/aws-lambda.md
@@ -58,7 +58,7 @@ This Plugin supports authorization via AWS API key and AWS IAM secrets.
 | aws_region | string | False    | "us-east-1"   | AWS region where the request is being sent.                                         |
 | service    | string | False    | "execute-api" | The service that is receiving the request. For HTTP trigger, it is `"execute-api"`. |
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below shows how you can configure the Plugin on a specific Route:
 

diff --git a/docs/en/latest/plugins/azure-functions.md b/docs/en/latest/plugins/azure-functions.md
@@ -71,7 +71,7 @@ curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/azure-functions -H 'X-AP
 }'
 ```
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can configure the Plugin on a specific Route as shown below assuming that you already have your Azure Functions up and running:
 

diff --git a/docs/en/latest/plugins/basic-auth.md b/docs/en/latest/plugins/basic-auth.md
@@ -51,7 +51,7 @@ For Route:
 |------------------|---------|----------|---------|------------------------------------------------------------------------|
 | hide_credentials | boolean | False    | false   | Set to true will not pass the authorization request headers to the Upstream. |
 
-## Enabling the Plugin
+## Enable Plugin
 
 To enable the Plugin, you have to create a Consumer object with the authentication configuration:
 

diff --git a/docs/en/latest/plugins/batch-requests.md b/docs/en/latest/plugins/batch-requests.md
@@ -57,7 +57,7 @@ You may need to use the [public-api](public-api.md) plugin to expose this endpoi
 
 :::
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the `batch-requests` Plugin by adding it to your configuration file (`conf/config.yaml`):
 

diff --git a/docs/en/latest/plugins/body-transformer.md b/docs/en/latest/plugins/body-transformer.md
@@ -49,7 +49,7 @@ Use cases:
 | `response.input_format`      | string       | False      | response body original format, if not specified, it would be determined from `Content-Type` header.       |
 | `response.template`      | string       | True      | response body transformation template       |
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the Plugin on a specific Route as shown below:
 

diff --git a/docs/en/latest/plugins/cas-auth.md b/docs/en/latest/plugins/cas-auth.md
@@ -41,7 +41,7 @@ to do authentication, from the SP (service provider) perspective.
 | `cas_callback_uri`      | string       | True      | redirect uri used to callback the SP from IdP after login or logout.       |
 | `logout_uri`      | string       | True      | logout uri to trigger logout.       |
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the Plugin on a specific Route as shown below:
 

diff --git a/docs/en/latest/plugins/clickhouse-logger.md b/docs/en/latest/plugins/clickhouse-logger.md
@@ -93,7 +93,7 @@ Then create a table in your ClickHouse database to store the logs.
 echo "CREATE TABLE default.test (\`host\` String, \`client_ip\` String, \`route_id\` String, \`service_id\` String, \`@timestamp\` String, PRIMARY KEY(\`@timestamp\`)) ENGINE = MergeTree()" | curl 'http://localhost:8123/'
 ```
 
-## Enabling the Plugin
+## Enable Plugin
 
 If multiple endpoints are configured, they will be written randomly.
 The example below shows how you can enable the Plugin on a specific Route:

diff --git a/docs/en/latest/plugins/client-control.md b/docs/en/latest/plugins/client-control.md
@@ -42,7 +42,7 @@ This Plugin requires APISIX to run on APISIX-Base. See [apisix-build-tools](http
 | ------------- | ------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
 | max_body_size | integer | False    | [0,...]      | Dynamically set the [`client_max_body_size`](https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size) directive. |
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below enables the Plugin on a specific Route:
 

diff --git a/docs/en/latest/plugins/cors.md b/docs/en/latest/plugins/cors.md
@@ -56,7 +56,7 @@ The `cors` Plugins lets you enable [CORS](https://developer.mozilla.org/en-US/do
 |---------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | allow_origins | object | False    | A map with origin reference and allowed origins. The keys in the map are used in the attribute `allow_origins_by_metadata` and the value are equivalent to the `allow_origins` attribute of the Plugin. |
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the Plugin on a specific Route or Service:
 

diff --git a/docs/en/latest/plugins/csrf.md b/docs/en/latest/plugins/csrf.md
@@ -44,7 +44,7 @@ This Plugin considers the `GET`, `HEAD` and `OPTIONS` methods to be safe operati
 
 NOTE: `encrypt_fields = {"key"}` is also defined in the schema, which means that the field will be stored encrypted in etcd. See [encrypted storage fields](../plugin-develop.md#encrypted-storage-fields).
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below shows how you can enable the Plugin on a specific Route:
 

diff --git a/docs/en/latest/plugins/datadog.md b/docs/en/latest/plugins/datadog.md
@@ -113,7 +113,7 @@ If there are no suitable values for any particular tag, the tag will be omitted.
 
 :::
 
-## Enabling the Plugin
+## Enable Plugin
 
 Once you have your Datadog agent running, you can enable the Plugin as shown below:
 

diff --git a/docs/en/latest/plugins/degraphql.md b/docs/en/latest/plugins/degraphql.md
@@ -57,7 +57,7 @@ After starting the server, the following endpoints are now available:
 - http://localhost:8080/ - A simple reacter
 - ws://localhost:8080/subscriptions
 
-### Enabling the Plugin
+### Enable Plugin
 
 #### Query list
 

diff --git a/docs/en/latest/plugins/dubbo-proxy.md b/docs/en/latest/plugins/dubbo-proxy.md
@@ -52,7 +52,7 @@ If you are using OpenResty, you need to build it with Dubbo support. See [How do
 | ------------------------ | ------ | -------- | ------- | ------------ | --------------------------------------------------------------- |
 | upstream_multiplex_count | number | True | 32      | >= 1         | Maximum number of multiplex requests in an upstream connection. |
 
-## Enabling the Plugin
+## Enable Plugin
 
 To enable the `dubbo-proxy` Plugin, you have to add it in your configuration file (`conf/config.yaml`):
 

diff --git a/docs/en/latest/plugins/echo.md b/docs/en/latest/plugins/echo.md
@@ -50,7 +50,7 @@ The `echo` Plugin is built as an example. It has missing cases and should **not*
 
 At least one of `before_body`, `body`, and `after_body` must be specified.
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below shows how you can enable the `echo` Plugin for a specific Route:
 

diff --git a/docs/en/latest/plugins/elasticsearch-logger.md b/docs/en/latest/plugins/elasticsearch-logger.md
@@ -53,7 +53,7 @@ NOTE: `encrypt_fields = {"auth.password"}` is also defined in the schema, which
 
 This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the data. The batch processor submits data every `5` seconds or when the data in the queue reaches `1000`. See [Batch Processor](../batch-processor.md#configuration) for more information or setting your custom configuration.
 
-## Enabling the Plugin
+## Enable Plugin
 
 ### Full configuration
 

diff --git a/docs/en/latest/plugins/error-log-logger.md b/docs/en/latest/plugins/error-log-logger.md
@@ -69,7 +69,7 @@ NOTE: `encrypt_fields = {"clickhouse.password"}` is also defined in the schema,
 
 This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the data. The batch processor submits data every `5` seconds or when the data in the queue reaches `1000`. See [Batch Processor](../batch-processor.md#configuration) for more information or setting your custom configuration.
 
-## Enabling the Plugin
+## Enable Plugin
 
 To enable the Plugin, you can add it in your configuration file (`conf/config.yaml`):
 

diff --git a/docs/en/latest/plugins/ext-plugin-post-resp.md b/docs/en/latest/plugins/ext-plugin-post-resp.md
@@ -55,7 +55,7 @@ Execution of External Plugins will affect the response of the current request.
 | conf              | array   | False    |         | [{"name": "ext-plugin-A", "value": "{\"enable\":\"feature\"}"}] | List of Plugins and their configurations to be executed on the Plugin Runner.                                          |
 | allow_degradation | boolean | False    | false   |                                                                 | Sets Plugin degradation when the Plugin Runner is not available. When set to `true`, requests are allowed to continue. |
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below enables the `ext-plugin-post-resp` Plugin on a specific Route:
 

diff --git a/docs/en/latest/plugins/ext-plugin-pre-req.md b/docs/en/latest/plugins/ext-plugin-pre-req.md
@@ -46,7 +46,7 @@ Execution of External Plugins will affect the behavior of the current request.
 | conf              | array   | False    |         | [{"name": "ext-plugin-A", "value": "{\"enable\":\"feature\"}"}] | List of Plugins and their configurations to be executed on the Plugin Runner.                                          |
 | allow_degradation | boolean | False    | false   |                                                                 | Sets Plugin degradation when the Plugin Runner is not available. When set to `true`, requests are allowed to continue. |
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below enables the `ext-plugin-pre-req` Plugin on a specific Route:
 

diff --git a/docs/en/latest/plugins/fault-injection.md b/docs/en/latest/plugins/fault-injection.md
@@ -75,7 +75,7 @@ This means that the relationship between the first two expressions is AND, and t
 
 :::
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the `fault-injection` Plugin on a specific Route as shown below:
 

diff --git a/docs/en/latest/plugins/file-logger.md b/docs/en/latest/plugins/file-logger.md
@@ -79,7 +79,7 @@ With this configuration, your logs would be formatted as shown below:
 {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}
 ```
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below shows how you can enable the Plugin on a specific Route:
 

diff --git a/docs/en/latest/plugins/google-cloud-logging.md b/docs/en/latest/plugins/google-cloud-logging.md
@@ -86,7 +86,7 @@ With this configuration, your logs would be formatted as shown below:
 {"partialSuccess":false,"entries":[{"jsonPayload":{"client_ip":"127.0.0.1","host":"localhost","@timestamp":"2023-01-09T14:47:25+08:00","route_id":"1"},"resource":{"type":"global"},"insertId":"942e81f60b9157f0d46bc9f5a8f0cc40","logName":"projects/apisix/logs/apisix.apache.org%2Flogs","timestamp":"2023-01-09T14:47:25+08:00","labels":{"source":"apache-apisix-google-cloud-logging"}}]}
 ```
 
-## Enabling the Plugin
+## Enable Plugin
 
 ### Full configuration
 

diff --git a/docs/en/latest/plugins/grpc-transcode.md b/docs/en/latest/plugins/grpc-transcode.md
@@ -57,7 +57,7 @@ APISIX takes in an HTTP request, transcodes it and forwards it to a gRPC service
 | default values  | `auto_default_values`, `no_default_values`, `use_default_values`, `use_default_metatable` |
 | hooks           | `enable_hooks`, `disable_hooks`                                                           |
 
-## Enabling the Plugin
+## Enable Plugin
 
 Before enabling the Plugin, you have to add the content of your `.proto` or `.pb` files to APISIX.
 

diff --git a/docs/en/latest/plugins/grpc-web.md b/docs/en/latest/plugins/grpc-web.md
@@ -32,7 +32,7 @@ description: This document contains information about the Apache APISIX grpc-web
 
 The `grpc-web` Plugin is a proxy Plugin that can process [gRPC Web](https://github.com/grpc/grpc-web) requests from JavaScript clients to a gRPC service.
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the `grpc-web` Plugin on a specific Route as shown below:
 

diff --git a/docs/en/latest/plugins/gzip.md b/docs/en/latest/plugins/gzip.md
@@ -49,7 +49,7 @@ This Plugin requires APISIX to run on [APISIX-Base](../FAQ.md#how-do-i-build-the
 | buffers.size   | integer              | False    | 4096          | >= 1         | Dynamically sets the `gzip_buffers` directive.                                          |
 | vary           | boolean              | False    | false         |              | Dynamically sets the `gzip_vary` directive.                                             |
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below enables the `gzip` Plugin on the specified Route:
 

diff --git a/docs/en/latest/plugins/hmac-auth.md b/docs/en/latest/plugins/hmac-auth.md
@@ -50,7 +50,7 @@ This Plugin works with a [Consumer](../terminology/consumer.md) object and a con
 
 NOTE: `encrypt_fields = {"secret_key"}` is also defined in the schema, which means that the field will be stored encrypted in etcd. See [encrypted storage fields](../plugin-develop.md#encrypted-storage-fields).
 
-## Enabling the Plugin
+## Enable Plugin
 
 First we enable the Plugin on a Consumer object as shown below:
 

diff --git a/docs/en/latest/plugins/http-logger.md b/docs/en/latest/plugins/http-logger.md
@@ -88,7 +88,7 @@ With this configuration, your logs would be formatted as shown below:
 {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}
 ```
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below shows how you can enable the Plugin on a specific Route:
 

diff --git a/docs/en/latest/plugins/inspect.md b/docs/en/latest/plugins/inspect.md
@@ -85,7 +85,7 @@ The `info` is a hash table which contains below keys:
 | delay           | integer | False     | 3 | Time in seconds specifying how often to check the hooks file.                                       |
 | hooks_file           | string | False     | "/usr/local/apisix/plugin_inspect_hooks.lua"  | Lua file to define hooks, which could be a link file. Ensure only administrator could write this file, otherwise it may be a security risk. |
 
-## Enabling the Plugin
+## Enable Plugin
 
 Plugin is enabled by default (`conf/config-default.yaml`):
 

diff --git a/docs/en/latest/plugins/ip-restriction.md b/docs/en/latest/plugins/ip-restriction.md
@@ -48,7 +48,7 @@ Either one of `whitelist` or `blacklist` attribute must be specified. They canno
 
 :::
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the Plugin on a Route or a Service as shown below:
 

diff --git a/docs/en/latest/plugins/jwt-auth.md b/docs/en/latest/plugins/jwt-auth.md
@@ -72,7 +72,7 @@ You may need to use the [public-api](public-api.md) plugin to expose this endpoi
 
 :::
 
-## Enabling the Plugin
+## Enable Plugin
 
 To enable the Plugin, you have to create a Consumer object with the JWT token and configure your Route to use JWT authentication.
 

diff --git a/docs/en/latest/plugins/kafka-logger.md b/docs/en/latest/plugins/kafka-logger.md
@@ -164,7 +164,7 @@ With this configuration, your logs would be formatted as shown below:
 {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}
 ```
 
-## Enabling the Plugin
+## Enable Plugin
 
 The example below shows how you can enable the `kafka-logger` Plugin on a specific Route:
 

diff --git a/docs/en/latest/plugins/key-auth.md b/docs/en/latest/plugins/key-auth.md
@@ -52,7 +52,7 @@ For Route:
 | query  | string | optional    | apikey  |       | The query string to get the key from. Lower priority than header.                                                                                                                                                                                                             |
 | hide_credentials   | bool | optional    | false        |       | Apache APISIX will pass the request header or query string that contains the authentication information to the Upstream if `hide_credentials` is `false`. Otherwise the authentication information will be removed before proxying.|
 
-## Enabling the Plugin
+## Enable Plugin
 
 To enable the Plugin, you have to create a Consumer object with an authentication key and configure your Route to authenticate requests.
 

diff --git a/docs/en/latest/plugins/ldap-auth.md b/docs/en/latest/plugins/ldap-auth.md
@@ -54,7 +54,7 @@ For Route:
 | tls_verify| boolean  | False     | `false`        | Whether to verify the server certificate when `use_tls` is enabled; If set to `true`, you must set `ssl_trusted_certificate` in `config.yaml`, and make sure the host of `ldap_uri` matches the host in server certificate. |
 | uid      | string  | False    | `cn`    | uid attribute.                                                         |
 
-## Enabling the plugin
+## Enable plugin
 
 First, you have to create a Consumer and enable the `ldap-auth` Plugin on it:
 

diff --git a/docs/en/latest/plugins/limit-conn.md b/docs/en/latest/plugins/limit-conn.md
@@ -44,7 +44,7 @@ The `limit-con` Plugin limits the number of concurrent requests to your services
 | rejected_msg           | string  | False    |         | non-empty                  | Body of the response returned when the requests exceeding the threshold are rejected.                                                                                                                                                                                                                                                                                                                 |
 | allow_degradation      | boolean | False    | false   |                            | When set to `true` enables Plugin degradation when the Plugin is temporarily unavailable and allows requests to continue.                                                                                                                                                                                                                                                                             |
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the Plugin on a Route as shown below:
 

diff --git a/docs/en/latest/plugins/limit-count.md b/docs/en/latest/plugins/limit-count.md
@@ -57,7 +57,7 @@ The `limit-count` Plugin limits the number of requests to your service by a give
 | redis_cluster_ssl      | boolean  |  False |     false         |                                        | If set to `true`, then uses SSL to connect to redis-cluster. Used when the `policy` attribute is set to `redis-cluster`.                                                                                                                                                                                                                                                                                                                                                                                                 |
 | redis_cluster_ssl_verify      | boolean  | False |    false      |                                        | If set to `true`, then verifies the validity of the server SSL certificate. Used when the `policy` attribute is set to `redis-cluster`.                                                                                                                                                                                                                                                                                                                                                                                                 |
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the Plugin on a Route as shown below:
 

diff --git a/docs/en/latest/plugins/limit-req.md b/docs/en/latest/plugins/limit-req.md
@@ -44,7 +44,7 @@ The `limit-req` Plugin limits the number of requests to your service using the [
 | nodelay           | boolean | False    | false   |                            | If set to `true`, requests within the burst threshold would not be delayed.                                                                                                                                                                                                                                                                                                                           |
 | allow_degradation | boolean | False    | false   |                            | When set to `true` enables Plugin degradation when the Plugin is temporarily unavailable and allows requests to continue.                                                                                                                                                                                                                                                                             |
 
-## Enabling the Plugin
+## Enable Plugin
 
 You can enable the Plugin on a Route as shown below:
-Original file line number
+Diff line change
@@ Expand Up @@
     :::
-    ## Enabling the Plugin
+    ## Enable Plugin
     You can enable the Plugin on a specific Route as shown below:
@@ Expand Down @@