docs: unify plugin Description (#6532)

Co-authored-by: 琚致远 <juzhiyuan@apache.org>
apache · Mar 13, 2022 · 1ac7166 · 1ac7166
1 parent 6406026
commit 1ac7166
Show file tree

Hide file tree

Showing 127 changed files with 141 additions and 113 deletions.
diff --git a/docs/en/latest/plugins/api-breaker.md b/docs/en/latest/plugins/api-breaker.md
@@ -21,7 +21,7 @@ title: api-breaker
 #
 -->
 
-## Name
+## Description
 
 The plugin implements API fuse functionality to help us protect our upstream business services.
 

diff --git a/docs/en/latest/plugins/authz-casbin.md b/docs/en/latest/plugins/authz-casbin.md
@@ -21,7 +21,7 @@ title: authz-casbin
 #
 -->
 
-## Name
+## Description
 
 `authz-casbin` is an authorization plugin based on [Lua Casbin](https://github.com/casbin/lua-casbin/). This plugin supports powerful authorization scenarios based on various access control models.
 

diff --git a/docs/en/latest/plugins/authz-keycloak.md b/docs/en/latest/plugins/authz-keycloak.md
@@ -21,7 +21,7 @@ title: authz-keycloak
 #
 -->
 
-## Name
+## Description
 
 `authz-keycloak` is an authorization plugin to be used with the Keycloak Identity Server. Keycloak is an OAuth/OIDC and
 UMA compliant Identity Server. Although, it's developed working in conjunction with Keycloak it should work with any

diff --git a/docs/en/latest/plugins/aws-lambda.md b/docs/en/latest/plugins/aws-lambda.md
@@ -21,7 +21,7 @@ title: aws-lambda
 #
 -->
 
-## Name
+## Description
 
 `aws-lambda` is a serverless plugin built into Apache APISIX for seamless integration with [AWS Lambda](https://aws.amazon.com/lambda/), a widely used serverless solution, as a dynamic upstream to proxy all requests for a particular URI to the AWS cloud - one of the highly used public cloud platforms for production environment. If enabled, this plugin terminates the ongoing request to that particular URI and initiates a new request to the AWS lambda gateway uri (the new upstream) on behalf of the client with the suitable authorization details set by the users, request headers, request body, params (all these three components are passed from the original request) and returns the response body, status code and the headers back to the original client that has invoked the request to the APISIX agent.
 At present, the plugin supports authorization via AWS api key and AWS IAM Secrets.

diff --git a/docs/en/latest/plugins/azure-functions.md b/docs/en/latest/plugins/azure-functions.md
@@ -21,7 +21,7 @@ title: azure-functions
 #
 -->
 
-## Name
+## Description
 
 `azure-functions` is a serverless plugin built into Apache APISIX for seamless integration with [Azure Serverless Function](https://azure.microsoft.com/en-in/services/functions/) as a dynamic upstream to proxy all requests for a particular URI to the Microsoft Azure cloud, one of the most used public cloud platforms for production environment. If enabled, this plugin terminates the ongoing request to that particular URI and initiates a new request to the azure faas (the new upstream) on behalf of the client with the suitable authorization details set by the users, request headers, request body, params ( all these three components are passed from the original request ) and returns the response body, status code and the headers back to the original client that has invoked the request to the APISIX agent.
 

diff --git a/docs/en/latest/plugins/basic-auth.md b/docs/en/latest/plugins/basic-auth.md
@@ -21,7 +21,7 @@ title: basic-auth
 #
 -->
 
-## Name
+## Description
 
 `basic-auth` is an authentication plugin that need to work with `consumer`. Add Basic Authentication to a `service` or `route`.
 

diff --git a/docs/en/latest/plugins/clickhouse-logger.md b/docs/en/latest/plugins/clickhouse-logger.md
@@ -21,7 +21,7 @@ title: clickhouse-logger
 #
 -->
 
-## Name
+## Description
 
 `clickhouse-logger` is a plugin which push Log data requests to clickhouse.
 

diff --git a/docs/en/latest/plugins/client-control.md b/docs/en/latest/plugins/client-control.md
@@ -21,7 +21,7 @@ title: client-control
 #
 -->
 
-## Name
+## Description
 
 The `client-control` plugin dynamically controls the behavior of Nginx to
 handle the client request.

diff --git a/docs/en/latest/plugins/consumer-restriction.md b/docs/en/latest/plugins/consumer-restriction.md
@@ -21,7 +21,7 @@ title: consumer-restriction
 #
 -->
 
-## Introduction
+## Description
 
 The `consumer-restriction` makes corresponding access restrictions based on different objects selected.
 

diff --git a/docs/en/latest/plugins/datadog.md b/docs/en/latest/plugins/datadog.md
@@ -21,7 +21,7 @@ title: datadog
 #
 -->
 
-## Name
+## Description
 
 `datadog` is a monitoring plugin built into Apache APISIX for seamless integration with [Datadog](https://www.datadoghq.com/), one of the most used monitoring and observability platform for cloud applications. If enabled, this plugin supports multiple powerful types of metrics capture for every request and response cycle that essentially reflects the behaviour and health of the system.
 

diff --git a/docs/en/latest/plugins/dubbo-proxy.md b/docs/en/latest/plugins/dubbo-proxy.md
@@ -21,7 +21,7 @@ title: dubbo-proxy
 #
 -->
 
-## Name
+## Description
 
 dubbo-proxy plugin allows you proxy HTTP request to [**dubbo**](http://dubbo.apache.org).
 

diff --git a/docs/en/latest/plugins/echo.md b/docs/en/latest/plugins/echo.md
@@ -21,7 +21,7 @@ title: echo
 #
 -->
 
-## Name
+## Description
 
 `echo` is a useful plugin to help users understand as fully as possible how to develop an APISIX plugin.
 

diff --git a/docs/en/latest/plugins/error-log-logger.md b/docs/en/latest/plugins/error-log-logger.md
@@ -21,7 +21,7 @@ title: error-log-logger
 #
 -->
 
-## Name
+## Description
 
 `error-log-logger` is a plugin which pushes the log data of APISIX's `error.log` to TCP servers or [Apache SkyWalking](https://skywalking.apache.org/).
 

diff --git a/docs/en/latest/plugins/ext-plugin-post-req.md b/docs/en/latest/plugins/ext-plugin-post-req.md
@@ -21,6 +21,8 @@ title: ext-plugin-post-req
 #
 -->
 
+## Description
+
 `ext-plugin-post-req` is almost the same as `ext-plugin-pre-req`.
 
 The only difference is that it runs after executing builtin Lua plugins and

diff --git a/docs/en/latest/plugins/ext-plugin-pre-req.md b/docs/en/latest/plugins/ext-plugin-pre-req.md
@@ -21,7 +21,7 @@ title: ext-plugin-pre-req
 #
 -->
 
-## Name
+## Description
 
 The `ext-plugin-pre-req` runs specific external plugins in the plugin runner, before
 executing most of the builtin Lua plugins.

diff --git a/docs/en/latest/plugins/fault-injection.md b/docs/en/latest/plugins/fault-injection.md
@@ -21,7 +21,7 @@ title: fault-injection
 #
 -->
 
-## Name
+## Description
 
 Fault injection plugin, this plugin can be used with other plugins and will be executed before other plugins.  The `abort` attribute will directly return the user-specified http code to the client and terminate the subsequent plugins. The `delay` attribute will delay a request and execute subsequent plugins.
 

diff --git a/docs/en/latest/plugins/file-logger.md b/docs/en/latest/plugins/file-logger.md
@@ -21,7 +21,7 @@ title: file-logger
 #
 -->
 
-## Name
+## Description
 
 `file-logger` is a plugin that pushes a stream of log data to a specified location. For example, the output path can be customized: `logs/file.log`.
 

diff --git a/docs/en/latest/plugins/google-cloud-logging.md b/docs/en/latest/plugins/google-cloud-logging.md
@@ -21,7 +21,7 @@ title: google-cloud-logging
 #
 -->
 
-## Name
+## Description
 
 `google-cloud-logging` plugin is used to send the access log of `Apache APISIX` to the [Google Cloud Logging Service](https://cloud.google.com/logging/).
 

diff --git a/docs/en/latest/plugins/grpc-transcode.md b/docs/en/latest/plugins/grpc-transcode.md
@@ -21,7 +21,7 @@ title: grpc-transcode
 #
 -->
 
-## Name
+## Description
 
 HTTP(s) -> APISIX -> gRPC server
 

diff --git a/docs/en/latest/plugins/grpc-web.md b/docs/en/latest/plugins/grpc-web.md
@@ -21,7 +21,7 @@ title: grpc-web
 #
 -->
 
-## Name
+## Description
 
 The `grpc-web` plugin is a proxy plugin used to process [gRPC Web](https://github.com/grpc/grpc-web) client requests to `gRPC Server`.
 

diff --git a/docs/en/latest/plugins/gzip.md b/docs/en/latest/plugins/gzip.md
@@ -21,7 +21,7 @@ title: gzip
 #
 -->
 
-## Name
+## Description
 
 The `gzip` plugin dynamically set the gzip behavior of Nginx.
 

diff --git a/docs/en/latest/plugins/hmac-auth.md b/docs/en/latest/plugins/hmac-auth.md
@@ -21,7 +21,7 @@ title: hmac-auth
 #
 -->
 
-## Name
+## Description
 
 `hmac-auth` is an authentication plugin that need to work with `consumer`. Add HMAC Authentication to a `service` or `route`.
 

diff --git a/docs/en/latest/plugins/http-logger.md b/docs/en/latest/plugins/http-logger.md
@@ -21,7 +21,7 @@ title: http-logger
 #
 -->
 
-## Name
+## Description
 
 `http-logger` is a plugin which push Log data requests to HTTP/HTTPS servers.
 

diff --git a/docs/en/latest/plugins/ip-restriction.md b/docs/en/latest/plugins/ip-restriction.md
@@ -21,7 +21,7 @@ title: ip-restriction
 #
 -->
 
-## Name
+## Description
 
 The `ip-restriction` can restrict access to a Service or a Route by either
 whitelisting or blacklisting IP addresses. Single IPs, multiple IPs or ranges

diff --git a/docs/en/latest/plugins/jwt-auth.md b/docs/en/latest/plugins/jwt-auth.md
@@ -21,7 +21,7 @@ title: jwt-auth
 #
 -->
 
-## Name
+## Description
 
 `jwt-auth` is an authentication plugin that need to work with `consumer`. Add JWT Authentication to a `service` or `route`.
 

diff --git a/docs/en/latest/plugins/kafka-logger.md b/docs/en/latest/plugins/kafka-logger.md
@@ -21,7 +21,7 @@ title: kafka-logger
 #
 -->
 
-## Name
+## Description
 
 `kafka-logger` is a plugin which works as a Kafka client driver for the ngx_lua nginx module.
 

diff --git a/docs/en/latest/plugins/key-auth.md b/docs/en/latest/plugins/key-auth.md
@@ -21,7 +21,7 @@ title: key-auth
 #
 -->
 
-## Name
+## Description
 
 `key-auth` is an authentication plugin, it should work with `consumer` together.
 

diff --git a/docs/en/latest/plugins/ldap-auth.md b/docs/en/latest/plugins/ldap-auth.md
@@ -21,7 +21,7 @@ title: ldap-auth
 #
 -->
 
-## Name
+## Description
 
 `ldap-auth` is an authentication plugin that can works with `consumer`. Add Ldap Authentication to a `service` or `route`.
 

diff --git a/docs/en/latest/plugins/limit-conn.md b/docs/en/latest/plugins/limit-conn.md
@@ -21,7 +21,7 @@ title: limit-conn
 #
 -->
 
-## Name
+## Description
 
 Limiting request concurrency plugin.
 

diff --git a/docs/en/latest/plugins/limit-count.md b/docs/en/latest/plugins/limit-count.md
@@ -21,7 +21,7 @@ title: limit-count
 #
 -->
 
-## Name
+## Description
 
 Limit request rate by a fixed number of requests in a given time window.
 

diff --git a/docs/en/latest/plugins/limit-req.md b/docs/en/latest/plugins/limit-req.md
@@ -21,7 +21,7 @@ title: limit-req
 #
 -->
 
-## Introduction
+## Description
 
 limit request rate using the "leaky bucket" method.
 

diff --git a/docs/en/latest/plugins/log-rotate.md b/docs/en/latest/plugins/log-rotate.md
@@ -21,7 +21,7 @@ title: log-rotate
 #
 -->
 
-## Name
+## Description
 
 The plug-in can automatically rotate access and error log files in the log directory at regular intervals.
 

diff --git a/docs/en/latest/plugins/loggly.md b/docs/en/latest/plugins/loggly.md
@@ -21,7 +21,7 @@ title: loggly
 #
 -->
 
-## Name
+## Description
 
 The `loggly` plugin is used to forward the request log of `Apache APISIX` to `Loggly by SolarWinds` for analysis and storage. After the plugin is enabled, `Apache APISIX` will obtain request context information in `Log Phase` serialize it into [Loggly Syslog](https://documentation.solarwinds.com/en/success_center/loggly/content/admin/streaming-syslog-without-using-files.htm?cshid=loggly_streaming-syslog-without-using-files) data format which is actually syslog events with [RFC5424](https://datatracker.ietf.org/doc/html/rfc5424) compliant headers and submit it to the batch queue. When the maximum processing capacity of each batch of the batch processing queue or the maximum time to refresh the buffer is triggered, the data in the queue will be submitted to `Loggly` enterprise syslog endpoint.
 

diff --git a/docs/en/latest/plugins/mocking.md b/docs/en/latest/plugins/mocking.md
@@ -21,7 +21,7 @@ title: mocking
 #
 -->
 
-## Name
+## Description
 
 Mock API plugin, When the plugin is bound, it returns random mock data in the specified format and is no longer forwarded to the upstreams.
 

diff --git a/docs/en/latest/plugins/mqtt-proxy.md b/docs/en/latest/plugins/mqtt-proxy.md
@@ -21,7 +21,7 @@ title: mqtt-proxy
 #
 -->
 
-## Name
+## Description
 
 The plugin `mqtt-proxy` only works in stream model, it help you to dynamic load
 balance by `client_id` of MQTT.

diff --git a/docs/en/latest/plugins/node-status.md b/docs/en/latest/plugins/node-status.md
@@ -21,7 +21,7 @@ title: node-status
 #
 -->
 
-## Name
+## Description
 
 `node-status` is a plugin which we could get request status information through it's API.
 

diff --git a/docs/en/latest/plugins/openid-connect.md b/docs/en/latest/plugins/openid-connect.md
@@ -21,7 +21,7 @@ title: openid-connect
 #
 -->
 
-## Name
+## Description
 
 The OAuth 2 / Open ID Connect(OIDC) plugin provides authentication and introspection capability to APISIX.
 

diff --git a/docs/en/latest/plugins/opentelemetry.md b/docs/en/latest/plugins/opentelemetry.md
@@ -21,7 +21,7 @@ title: opentelemetry
 #
 -->
 
-## Name
+## Description
 
 [OpenTelemetry](https://opentelemetry.io/) report Tracing data according to [opentelemetry specification](https://github.com/open-telemetry/opentelemetry-specification).
 

diff --git a/docs/en/latest/plugins/prometheus.md b/docs/en/latest/plugins/prometheus.md
@@ -21,6 +21,8 @@ title: prometheus
 #
 -->
 
+## Description
+
 This plugin exposes metrics in Prometheus Exposition format.
 
 ## Attributes

diff --git a/docs/en/latest/plugins/proxy-cache.md b/docs/en/latest/plugins/proxy-cache.md
@@ -21,6 +21,8 @@ title: proxy-cache
 #
 -->
 
+## Description
+
 The proxy-cache plugin, which provides the ability to cache upstream response data and can be used with other plugins. The plugin supports disk-based caching and will support the memory-based caching in the future. The data that needs to be cached can be determined by the response code or request method and more complex caching policies can be configured by no_cache and cache_bypass attributes.
 
 *Note*:

diff --git a/docs/en/latest/plugins/proxy-control.md b/docs/en/latest/plugins/proxy-control.md
@@ -21,7 +21,7 @@ title: proxy-control
 #
 -->
 
-## Name
+## Description
 
 The `proxy-control` plugin dynamically controls the behavior of Nginx to proxy.
 

diff --git a/docs/en/latest/plugins/proxy-mirror.md b/docs/en/latest/plugins/proxy-mirror.md
@@ -21,6 +21,8 @@ title: proxy-mirror
 #
 -->
 
+## Description
+
 The proxy-mirror plugin, which provides the ability to mirror client requests.
 
 *Note*: The response returned by the mirror request is ignored.

diff --git a/docs/en/latest/plugins/proxy-rewrite.md b/docs/en/latest/plugins/proxy-rewrite.md
@@ -21,7 +21,7 @@ title: proxy-rewrite
 #
 -->
 
-## Name
+## Description
 
 The `proxy-rewrite` is an upstream proxy information rewriting plugin, which supports the rewriting of information such as `scheme`, `uri`, and `host`.
 

diff --git a/docs/en/latest/plugins/real-ip.md b/docs/en/latest/plugins/real-ip.md
@@ -21,7 +21,7 @@ title: real-ip
 #
 -->
 
-## Name
+## Description
 
 The `real-ip` plugin dynamically changes the client's IP and port seen by APISIX.
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,7 +21,7 @@ title: api-breaker @@
     #
     -->
-    ## Name
+    ## Description
     The plugin implements API fuse functionality to help us protect our upstream business services.
@@ Expand Down @@