From 69e54d41d3d372ed4cf4802790aec6de1308cd61 Mon Sep 17 00:00:00 2001 From: yilinzeng <36651058+yzeng25@users.noreply.github.com> Date: Mon, 26 Jul 2021 11:43:32 +0800 Subject: [PATCH] docs: fix section titles' links (#4671) --- docs/en/latest/admin-api.md | 4 ++-- docs/en/latest/mtls.md | 4 ++-- docs/en/latest/plugin-develop.md | 2 +- docs/en/latest/plugins/client-control.md | 2 +- docs/en/latest/plugins/dubbo-proxy.md | 2 +- docs/en/latest/plugins/gzip.md | 2 +- docs/zh/latest/admin-api.md | 4 ++-- docs/zh/latest/mtls.md | 4 ++-- docs/zh/latest/plugins/dubbo-proxy.md | 2 +- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md index 7ed10979ac9a..e86dbae23c23 100644 --- a/docs/en/latest/admin-api.md +++ b/docs/en/latest/admin-api.md @@ -581,11 +581,11 @@ In addition to the basic complex equalization algorithm selection, APISIX's Upst `tls.client_cert/key` can be used to communicate with upstream via mTLS. Their formats are the same as SSL's `cert` and `key` fields. -This feature requires APISIX to run on [APISIX-OpenResty](./how-to-build.md#6-build-openresty-for-apisix). +This feature requires APISIX to run on [APISIX-OpenResty](./how-to-build.md#step-6-build-openresty-for-apache-apisix). `keepalive_pool` allows the upstream to have its separate connection pool. Its children fields, like `requests`, can be used to configure the upstream keepalive options. -This feature requires APISIX to run on [APISIX-OpenResty](./how-to-build.md#6-build-openresty-for-apisix). +This feature requires APISIX to run on [APISIX-OpenResty](./how-to-build.md#step-6-build-openresty-for-apache-apisix). **Config Example:** diff --git a/docs/en/latest/mtls.md b/docs/en/latest/mtls.md index 6c50b3107f2f..87d3173129c7 100644 --- a/docs/en/latest/mtls.md +++ b/docs/en/latest/mtls.md @@ -66,7 +66,7 @@ curl --cacert /data/certs/mtls_ca.crt --key /data/certs/mtls_client.key --cert / ### How to configure -You need to [build APISIX-Openresty](./how-to-build.md#6-build-openresty-for-apisix) and configure `etcd.tls` section if you want APISIX to work on an etcd cluster with mTLS enabled. +You need to [build APISIX-Openresty](./how-to-build.md#step-6-build-openresty-for-apache-apisix) and configure `etcd.tls` section if you want APISIX to work on an etcd cluster with mTLS enabled. ```yaml etcd: @@ -146,7 +146,7 @@ Sometimes the upstream requires mTLS. In this situation, the APISIX acts as the When configuring `upstreams`, we could use parameter `tls.client_cert` and `tls.client_key` to configure the client certificate APISIX used to communicate with upstreams. Please refer to [Admin API](./admin-api.md#upstream) for details. -This feature requires APISIX to run on [APISIX-OpenResty](./how-to-build.md#6-build-openresty-for-apisix). +This feature requires APISIX to run on [APISIX-OpenResty](./how-to-build.md#step-6-build-openresty-for-apache-apisix). Here is a similar Python script to patch a existed upstream with mTLS (changes admin API url if needed): diff --git a/docs/en/latest/plugin-develop.md b/docs/en/latest/plugin-develop.md index 0f819401bf42..f7c85861206f 100644 --- a/docs/en/latest/plugin-develop.md +++ b/docs/en/latest/plugin-develop.md @@ -420,7 +420,7 @@ The above test case represents a simple scenario. Most scenarios will require mu Additionally, there are some convenience testing endpoints which can be found [here](https://github.com/apache/apisix/blob/master/t/lib/server.lua#L36). For example, see [proxy-rewrite](https://github.com/apache/apisix/blob/master/t/plugin/proxy-rewrite.lua). In test 42, the upstream `uri` is made to redirect `/test?new_uri=hello` to `/hello` (which always returns `hello world`). In test 43, the response body is confirmed to equal `hello world`, meaning the proxy-rewrite configuration added with test 42 worked correctly. -Refer the following [document](how-to-build.md#4-test) to setup the testing framework. +Refer the following [document](how-to-build.md#Step-4-Run-Test-Cases) to setup the testing framework. ### Attach the test-nginx execution process: diff --git a/docs/en/latest/plugins/client-control.md b/docs/en/latest/plugins/client-control.md index 5f1c493109dd..f1913236619d 100644 --- a/docs/en/latest/plugins/client-control.md +++ b/docs/en/latest/plugins/client-control.md @@ -34,7 +34,7 @@ title: client-control The `client-control` plugin dynamically controls the behavior of Nginx to handle the client request. -This plugin requires APISIX to run on [APISIX-OpenResty](../how-to-build.md#6-build-openresty-for-apisix). +This plugin requires APISIX to run on [APISIX-OpenResty](../how-to-build.md#step-6-build-openresty-for-apache-apisix). ## Attributes diff --git a/docs/en/latest/plugins/dubbo-proxy.md b/docs/en/latest/plugins/dubbo-proxy.md index 9b619d58a3f6..b0493083317d 100644 --- a/docs/en/latest/plugins/dubbo-proxy.md +++ b/docs/en/latest/plugins/dubbo-proxy.md @@ -37,7 +37,7 @@ dubbo-proxy plugin allows you proxy HTTP request to [**dubbo**](http://dubbo.apa ## Requirement -If you are using OpenResty, you need to build it with dubbo support, see [how to build](../how-to-build.md#6-build-openresty-for-apisix) +If you are using OpenResty, you need to build it with dubbo support, see [how to build](../how-to-build.md#step-6-build-openresty-for-apache-apisix) To make http2dubbo work in APISIX, we enhance the dubbo module based on Tengine's `mod_dubbo`. The modifications are contributed back to Tengine, but they are not included in the latest release version (Tengine-2.3.2) yet. So Tengine itself is unsupported. diff --git a/docs/en/latest/plugins/gzip.md b/docs/en/latest/plugins/gzip.md index ef520301ad38..d94721571d96 100644 --- a/docs/en/latest/plugins/gzip.md +++ b/docs/en/latest/plugins/gzip.md @@ -33,7 +33,7 @@ title: gzip The `gzip` plugin dynamically set the gzip behavior of Nginx. -This plugin requires APISIX to run on [APISIX-OpenResty](../how-to-build.md#6-build-openresty-for-apisix). +This plugin requires APISIX to run on [APISIX-OpenResty](../how-to-build.md#step-6-build-openresty-for-apache-apisix). ## Attributes diff --git a/docs/zh/latest/admin-api.md b/docs/zh/latest/admin-api.md index ba907de8ea44..d6d69f74a62d 100644 --- a/docs/zh/latest/admin-api.md +++ b/docs/zh/latest/admin-api.md @@ -586,11 +586,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外，还支持对上 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。 -这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#6-为-apisix-构建-openresty)。 +这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6-为-Apache-APISIX-构建-OpenResty)。 `keepalive_pool` 允许 upstream 对象有自己单独的连接池。 它下属的字段，比如 `requests`，可以用了配置上游连接保持的参数。 -这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#6-为-apisix-构建-openresty)。 +这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6-为-Apache-APISIX-构建-OpenResty)。 **upstream 对象 json 配置内容：** diff --git a/docs/zh/latest/mtls.md b/docs/zh/latest/mtls.md index bf2be4e62e1a..a01bc7b91d55 100644 --- a/docs/zh/latest/mtls.md +++ b/docs/zh/latest/mtls.md @@ -66,7 +66,7 @@ curl --cacert /data/certs/mtls_ca.crt --key /data/certs/mtls_client.key --cert / ### 如何配置 -你需要构建 [APISIX-Openresty](./how-to-build.md#6-为-apisix-构建-openresty)，并且需要在配置文件中设定 `etcd.tls` 来使 ETCD 的双向认证功能正常工作。 +你需要构建 [APISIX-Openresty](./how-to-build.md#步骤6-为-Apache-APISIX-构建-OpenResty)，并且需要在配置文件中设定 `etcd.tls` 来使 ETCD 的双向认证功能正常工作。 ```yaml etcd: @@ -146,7 +146,7 @@ curl --resolve 'mtls.test.com::' "https://