docs: remove all outlines from markdown files (apache#6494)

Co-authored-by: 高亮亮 <gll287546@alibaba-inc.com>
ShenFeng312 · Mar 3, 2022 · d4154bc · d4154bc
1 parent c37fc99
commit d4154bc
Show file tree

Hide file tree

Showing 125 changed files with 0 additions and 1,124 deletions.
diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md
@@ -21,20 +21,6 @@ title: Admin API
 #
 -->
 
-## Table of Contents
-
-- [Description](#description)
-- [Route](#route)
-- [Service](#service)
-- [Consumer](#consumer)
-- [Upstream](#upstream)
-- [SSL](#ssl)
-- [Global Rule](#global-rule)
-- [Plugin Config](#plugin-config)
-- [Plugin Metadata](#plugin-metadata)
-- [Plugin](#plugin)
-- [Stream Route](#stream-route)
-
 ## Description
 
 The Admin API is a group of APIs served for the Apache APISIX, we could pass parameters to APIs to control APISIX Nodes. To have a better understanding about how it works, please see [the architecture design](./architecture-design/apisix.md).

diff --git a/docs/en/latest/discovery/dns.md b/docs/en/latest/discovery/dns.md
@@ -21,9 +21,6 @@ title: DNS
 #
 -->
 
-* [service discovery via DNS](#service-discovery-via-dns)
-    * [SRV record](#srv-record)
-
 ## service discovery via DNS
 
 Some service discovery system, like Consul, support exposing service information

diff --git a/docs/en/latest/install-dependencies.md b/docs/en/latest/install-dependencies.md
@@ -21,9 +21,6 @@ title: Install Dependencies
 #
 -->
 
-- [Note](#note)
-- [Install](#install)
-
 ## Note
 
 - Since v2.0 Apache APISIX would not support the v2 protocol storage to etcd anymore, and the minimum etcd version supported is v3.4.0. What's more, etcd v3 uses gRPC as the messaging protocol, while Apache APISIX uses HTTP(S) to communicate with etcd cluster, so be sure the [etcd gRPC gateway](https://etcd.io/docs/v3.4.0/dev-guide/api_grpc_gateway/) is enabled.

diff --git a/docs/en/latest/plugin-develop.md b/docs/en/latest/plugin-develop.md
@@ -21,23 +21,6 @@ title: Plugin Develop
 #
 -->
 
-## table of contents
-
-- [table of contents](#table-of-contents)
-- [where to put your plugins](#where-to-put-your-plugins)
-- [check dependencies](#check-dependencies)
-- [name, priority and the others](#name-priority-and-the-others)
-- [schema and check](#schema-and-check)
-- [choose phase to run](#choose-phase-to-run)
-- [implement the logic](#implement-the-logic)
-  - [conf parameter](#conf-parameter)
-  - [ctx parameter](#ctx-parameter)
-- [register public API](#register-public-api)
-- [register control API](#register-control-api)
-- [register custom variable](#register-custom-variable)
-- [write test case](#write-test-case)
-  - [attach the test-nginx execution process:](#attach-the-test-nginx-execution-process)
-
 This documentation is about developing plugin in Lua. For other languages,
 see [external plugin](./external-plugin.md).
 

diff --git a/docs/en/latest/plugins/api-breaker.md b/docs/en/latest/plugins/api-breaker.md
@@ -21,14 +21,6 @@ title: api-breaker
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 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,16 +21,6 @@ title: authz-casbin
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**Metadata**](#metadata)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-- [**Examples**](#examples)
-
 ## Name
 
 `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,15 +21,6 @@ title: authz-keycloak
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-- [**Examples**](#examples)
-
 ## Name
 
 `authz-keycloak` is an authorization plugin to be used with the Keycloak Identity Server. Keycloak is an OAuth/OIDC and

diff --git a/docs/en/latest/plugins/aws-lambda.md b/docs/en/latest/plugins/aws-lambda.md
@@ -21,16 +21,6 @@ title: aws-lambda
 #
 -->
 
-## Summary
-
-- [Summary](#summary)
-- [Name](#name)
-- [Attributes](#attributes)
-  - [IAM Authorization Schema](#iam-authorization-schema)
-- [How To Enable](#how-to-enable)
-  - [Plugin with Path Forwarding](#plugin-with-path-forwarding)
-- [Disable Plugin](#disable-plugin)
-
 ## Name
 
 `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.

diff --git a/docs/en/latest/plugins/azure-functions.md b/docs/en/latest/plugins/azure-functions.md
@@ -21,16 +21,6 @@ title: azure-functions
 #
 -->
 
-## Summary
-
-- [Summary](#summary)
-- [Name](#name)
-- [Attributes](#attributes)
-- [Metadata](#metadata)
-- [How To Enable](#how-to-enable)
-  - [Plugin with Path Forwarding](#plugin-with-path-forwarding)
-- [Disable Plugin](#disable-plugin)
-
 ## Name
 
 `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,14 +21,6 @@ title: basic-auth
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 `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/batch-requests.md b/docs/en/latest/plugins/batch-requests.md
@@ -21,17 +21,6 @@ title: batch-requests
 #
 -->
 
-## Summary
-
-- [**Description**](#description)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**How To Configure**](#how-to-configure)
-- [**Metadata**](#metadata)
-- [**Batch Api Request/Response**](#batch-api-requestresponse)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Description
 
 `batch-requests` can accept multiple request and send them from `apisix` via [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining), and return an aggregated response to client, which can significantly improve performance when the client needs to access multiple APIs.

diff --git a/docs/en/latest/plugins/clickhouse-logger.md b/docs/en/latest/plugins/clickhouse-logger.md
@@ -21,15 +21,6 @@ title: clickhouse-logger
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Metadata**](#metadata)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 `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,14 +21,6 @@ title: client-control
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 The `client-control` plugin dynamically controls the behavior of Nginx to

diff --git a/docs/en/latest/plugins/consumer-restriction.md b/docs/en/latest/plugins/consumer-restriction.md
@@ -21,16 +21,6 @@ title: consumer-restriction
 #
 -->
 
-## Summary
-
-  - [Introduction](#introduction)
-  - [Attributes](#attributes)
-  - [Example](#example)
-    - [How to restrict consumer_name](#how-to-restrict-consumer_name)
-    - [How to restrict allowed_by_methods](#how-to-restrict-allowed_by_methods)
-    - [How to restrict service_id](#how-to-restrict-service_id)
-  - [Disable Plugin](#disable-plugin)
-
 ## Introduction
 
 The `consumer-restriction` makes corresponding access restrictions based on different objects selected.

diff --git a/docs/en/latest/plugins/cors.md b/docs/en/latest/plugins/cors.md
@@ -21,14 +21,6 @@ title: cors
 #
 -->
 
-## Summary
-
-- [**Description**](#description)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Description
 
 `cors` plugin can help you enable [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) easily.

diff --git a/docs/en/latest/plugins/csrf.md b/docs/en/latest/plugins/csrf.md
@@ -21,14 +21,6 @@ title: csrf
 #
 -->
 
-## Summary
-
-- [**Description**](#description)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Description
 
 The `CSRF` plugin based on the [`Double Submit Cookie`](https://en.wikipedia.org/wiki/Cross-site_request_forgery#Double_Submit_Cookie) way, protect your API from CSRF attacks. This plugin considers the `GET`, `HEAD` and `OPTIONS` methods to be safe operations. Therefore calls to the `GET`, `HEAD` and `OPTIONS` methods are not checked for interception.

diff --git a/docs/en/latest/plugins/datadog.md b/docs/en/latest/plugins/datadog.md
@@ -21,17 +21,6 @@ title: datadog
 #
 -->
 
-## Summary
-
-- [Summary](#summary)
-- [Name](#name)
-- [Attributes](#attributes)
-- [Metadata](#metadata)
-- [Exported Metrics](#exported-metrics)
-- [How To Enable](#how-to-enable)
-- [Disable Plugin](#disable-plugin)
-- [Custom Configuration](#custom-configuration)
-
 ## Name
 
 `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,16 +21,6 @@ title: dubbo-proxy
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Requirement**](#requirement)
-- [**Runtime Attributes**](#runtime-attributes)
-- [**Static Attributes**](#static-attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 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,14 +21,6 @@ title: echo
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 `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,17 +21,6 @@ title: error-log-logger
 #
 -->
 
-## Summary
-
-- [Summary](#summary)
-- [Name](#name)
-- [Attributes](#attributes)
-- [How To Enable And Disable](#how-to-enable-and-disable)
-  - [Enable plugin](#enable-plugin)
-  - [Disable plugin](#disable-plugin)
-- [How to set the TCP server address](#how-to-set-the-tcp-server-address)
-- [How to set the SkyWalking OAP server address](#how-to-set-the-skywalking-oap-server-address)
-
 ## Name
 
 `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-pre-req.md b/docs/en/latest/plugins/ext-plugin-pre-req.md
@@ -21,14 +21,6 @@ title: ext-plugin-pre-req
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 The `ext-plugin-pre-req` runs specific external plugins in the plugin runner, before

diff --git a/docs/en/latest/plugins/file-logger.md b/docs/en/latest/plugins/file-logger.md
@@ -21,15 +21,6 @@ title: file-logger
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Metadata**](#metadata)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 `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/forward-auth.md b/docs/en/latest/plugins/forward-auth.md
@@ -21,13 +21,6 @@ title: forward-auth
 #
 -->
 
-## Summary
-
-- [**Description**](#description)
-- [**Attributes**](#attributes)
-- [**Data Definition**](#data-definition)
-- [**Example**](#example)
-
 ## Description
 
 The `forward-auth` plugin implements a classic external authentication model. We can implement a custom error return or user redirection to the authentication page if the authentication fails.

diff --git a/docs/en/latest/plugins/google-cloud-logging.md b/docs/en/latest/plugins/google-cloud-logging.md
@@ -21,14 +21,6 @@ title: google-cloud-logging
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**Attributes**](#attributes)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 `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-web.md b/docs/en/latest/plugins/grpc-web.md
@@ -21,13 +21,6 @@ title: grpc-web
 #
 -->
 
-## Summary
-
-- [**Name**](#name)
-- [**How To Enable**](#how-to-enable)
-- [**Test Plugin**](#test-plugin)
-- [**Disable Plugin**](#disable-plugin)
-
 ## Name
 
 The `grpc-web` plugin is a proxy plugin used to process [gRPC Web](https://github.com/grpc/grpc-web) client requests to `gRPC Server`.