You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by me...@apache.org on 2021/02/05 16:06:38 UTC
[apisix] branch master updated: docs: standardize link anchors to
lower case (#3510)
This is an automated email from the ASF dual-hosted git repository.
membphis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 5bd740a docs: standardize link anchors to lower case (#3510)
5bd740a is described below
commit 5bd740a13165ff7cd8ec4c524af0da52379e984f
Author: John Bampton <jb...@users.noreply.github.com>
AuthorDate: Sat Feb 6 02:06:30 2021 +1000
docs: standardize link anchors to lower case (#3510)
many thx @jbampton
---
README.md | 4 ++--
README_CN.md | 2 +-
doc/admin-api.md | 12 ++++++------
doc/discovery.md | 2 +-
doc/plugins/batch-requests.md | 6 +++---
doc/plugins/cors.md | 6 +++---
doc/plugins/dubbo-proxy.md | 14 +++++++-------
doc/plugins/response-rewrite.md | 2 +-
doc/plugins/skywalking.md | 12 ++++++------
9 files changed, 30 insertions(+), 30 deletions(-)
diff --git a/README.md b/README.md
index 13e1c50..9bd721e 100644
--- a/README.md
+++ b/README.md
@@ -121,7 +121,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
- Version Control: Supports rollbacks of operations.
- CLI: start\stop\reload APISIX through the command line.
- [Stand-alone mode](doc/stand-alone.md): Supports to load route rules from local yaml file, it is more friendly such as under the kubernetes(k8s).
- - [Global Rule](doc/architecture-design.md#Global-Rule): Allows to run any plugin for all request, eg: limit rate, IP filter etc.
+ - [Global Rule](doc/architecture-design.md#global-rule): Allows to run any plugin for all request, eg: limit rate, IP filter etc.
- High performance: The single-core QPS reaches 18k with an average delay of less than 0.2 milliseconds.
- [Fault Injection](doc/plugins/fault-injection.md)
- [REST Admin API](doc/admin-api.md): Using the REST Admin API to control Apache APISIX, which only allows 127.0.0.1 access by default, you can modify the `allow_admin` field in `conf/config.yaml` to specify a list of IPs that are allowed to call the Admin API. Also note that the Admin API uses key auth to verify the identity of the caller. **The `admin_key` field in `conf/config.yaml` needs to be modified before deployment to ensure security**.
@@ -227,7 +227,7 @@ There are several ways to install the Apache Release version of APISIX:
The getting started guide is a great way to learn the basics of APISIX, just follow the steps in [Getting Started](doc/getting-started.md).
- Further, you can follow the documentation to try more [plugins](doc/README.md#Plugins).
+ Further, you can follow the documentation to try more [plugins](doc/README.md#plugins).
3. Admin API
diff --git a/README_CN.md b/README_CN.md
index 9407d85..f772510 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -119,7 +119,7 @@ A/B 测试、金丝雀发布(灰度发布)、蓝绿部署、限流限速、抵
- 版本控制：支持操作的多次回滚。
- CLI: 使用命令行来启动、关闭和重启 APISIX。
- [单机模式](doc/zh-cn/stand-alone.md): 支持从本地配置文件中加载路由规则，在 kubernetes(k8s) 等环境下更友好。
- - [全局规则](doc/zh-cn/architecture-design.md#Global-Rule)：允许对所有请求执行插件，比如黑白名单、限流限速等。
+ - [全局规则](doc/zh-cn/architecture-design.md#global-rule)：允许对所有请求执行插件，比如黑白名单、限流限速等。
- 高性能：在单核上 QPS 可以达到 18k，同时延迟只有 0.2 毫秒。
- [故障注入](doc/zh-cn/plugins/fault-injection.md)
- [REST Admin API](doc/zh-cn/admin-api.md): 使用 REST Admin API 来控制 Apache APISIX，默认只允许 127.0.0.1 访问，你可以修改 `conf/config.yaml` 中的 `allow_admin` 字段，指定允许调用 Admin API 的 IP 列表。同时需要注意的是，Admin API 使用 key auth 来校验调用者身份，**在部署前需要修改 `conf/config.yaml` 中的 `admin_key` 字段，来保证安全。**
diff --git a/doc/admin-api.md b/doc/admin-api.md
index f1cc0c5..852f24f 100644
--- a/doc/admin-api.md
+++ b/doc/admin-api.md
@@ -265,7 +265,7 @@ After successful execution, status nodes will be updated to:
Return response from etcd currently.
-[Back to TOC](#Table-of-Contents)
+[Back to TOC](#table-of-contents)
## Service
@@ -414,7 +414,7 @@ After successful execution, upstream nodes will not retain the original data, an
Return response from etcd currently.
-[Back to TOC](#Table-of-Contents)
+[Back to TOC](#table-of-contents)
## Consumer
@@ -485,7 +485,7 @@ Since `v2.2`, we can bind multiple authentication plugins to the same consumer.
Return response from etcd currently.
-[Back to TOC](#Table-of-Contents)
+[Back to TOC](#table-of-contents)
## Upstream
@@ -653,7 +653,7 @@ After the execution is successful, nodes will not retain the original data, and
Return response from etcd currently.
-[Back to TOC](#Table-of-Contents)
+[Back to TOC](#table-of-contents)
## SSL
@@ -752,7 +752,7 @@ Date: Thu, 26 Dec 2019 04:19:34 GMT
Content-Type: text/plain
```
-[Back to TOC](#Table-of-Contents)
+[Back to TOC](#table-of-contents)
## Plugin
@@ -791,4 +791,4 @@ $ curl "http://127.0.0.1:9080/apisix/admin/plugins/key-auth" -H 'X-API-KEY:
|---------|-------------------------|--|------|
|GET |/apisix/admin/plugins?all=true|NULL|Fetch resource|
-[Back to TOC](#Table-of-Contents)
+[Back to TOC](#table-of-contents)
diff --git a/doc/discovery.md b/doc/discovery.md
index 67c7e13..86bf839 100644
--- a/doc/discovery.md
+++ b/doc/discovery.md
@@ -20,7 +20,7 @@
# Integration service discovery registry
-* [**Summary**](#Summary)
+* [**Summary**](#summary)
* [**How extend the discovery client?**](#how-extend-the-discovery-client)
* [**Basic steps**](#basic-steps)
* [**the example of Eureka**](#the-example-of-eureka)
diff --git a/doc/plugins/batch-requests.md b/doc/plugins/batch-requests.md
index 19a0f3f..486b0dc 100644
--- a/doc/plugins/batch-requests.md
+++ b/doc/plugins/batch-requests.md
@@ -21,9 +21,9 @@
# Summary
-- [**Description**](#Description)
-- [**Attributes**](#Attributes)
-- [**How To Enable**](#how-to-Enable)
+- [**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)
diff --git a/doc/plugins/cors.md b/doc/plugins/cors.md
index f5d76ca..b208964 100644
--- a/doc/plugins/cors.md
+++ b/doc/plugins/cors.md
@@ -21,9 +21,9 @@
# Summary
-- [**Description**](#Description)
-- [**Attributes**](#Attributes)
-- [**How To Enable**](#how-to-Enable)
+- [**Description**](#description)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
- [**Test Plugin**](#test-plugin)
- [**Disable Plugin**](#disable-plugin)
diff --git a/doc/plugins/dubbo-proxy.md b/doc/plugins/dubbo-proxy.md
index 20339d9..eaaeb4f 100644
--- a/doc/plugins/dubbo-proxy.md
+++ b/doc/plugins/dubbo-proxy.md
@@ -19,13 +19,13 @@
# 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**](#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
diff --git a/doc/plugins/response-rewrite.md b/doc/plugins/response-rewrite.md
index 8d025ef..fb3fb88 100644
--- a/doc/plugins/response-rewrite.md
+++ b/doc/plugins/response-rewrite.md
@@ -26,7 +26,7 @@
- [**How To Enable**](#how-to-enable)
- [**Test Plugin**](#test-plugin)
- [**Disable Plugin**](#disable-plugin)
-- [**Attention**](#Attention)
+- [**Attention**](#attention)
## Name
diff --git a/doc/plugins/skywalking.md b/doc/plugins/skywalking.md
index 980e203..c6f55aa 100644
--- a/doc/plugins/skywalking.md
+++ b/doc/plugins/skywalking.md
@@ -21,12 +21,12 @@
# Summary
-- [**Name**](#Name)
-- [**Attributes**](#Attributes)
-- [**How To Enable**](#How-To-Enable)
-- [**Test Plugin**](#Test-Plugin)
- - [**Run Skywalking Example**](#Run-Skywalking-Example)
-- [**Disable Plugin**](#Disable-Plugin)
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+ - [**Run Skywalking Example**](#run-skywalking-example)
+- [**Disable Plugin**](#disable-plugin)
- [**Upstream services(Code With SpringBoot)**](#Upstream-services(Code-With-SpringBoot))
## Name