From 274d8431dc9ea681dcee0e9772da262f5aeacba7 Mon Sep 17 00:00:00 2001 From: hf400159 Date: Thu, 19 May 2022 23:17:23 +0800 Subject: [PATCH 1/2] docs: update filename --- README.md | 2 +- docs/en/latest/config.json | 2 +- docs/en/latest/getting-started.md | 2 +- docs/en/latest/{how-to-build.md => installation-guide.md} | 0 docs/en/latest/mtls.md | 2 +- docs/en/latest/plugin-develop.md | 2 +- docs/en/latest/plugins/dubbo-proxy.md | 2 +- docs/zh/latest/README.md | 2 +- docs/zh/latest/config.json | 2 +- docs/zh/latest/getting-started.md | 2 +- docs/zh/latest/{how-to-build.md => installation-guide.md} | 0 docs/zh/latest/plugins/dubbo-proxy.md | 2 +- utils/gen-vote-contents.sh | 2 +- 13 files changed, 11 insertions(+), 11 deletions(-) rename docs/en/latest/{how-to-build.md => installation-guide.md} (100%) rename docs/zh/latest/{how-to-build.md => installation-guide.md} (100%) diff --git a/README.md b/README.md index 23c8fbc62547..8abc66a2cca7 100644 --- a/README.md +++ b/README.md @@ -169,7 +169,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against 1. Installation - Please refer to [install documentation](docs/en/latest/how-to-build.md). + Please refer to [install documentation](docs/en/latest/installation-guide.md). 2. Getting started diff --git a/docs/en/latest/config.json b/docs/en/latest/config.json index 35e64986e91b..61a4d6240c71 100644 --- a/docs/en/latest/config.json +++ b/docs/en/latest/config.json @@ -31,7 +31,7 @@ }, { "type": "doc", - "id": "how-to-build" + "id": "installation-guide" }, { "type": "category", diff --git a/docs/en/latest/getting-started.md b/docs/en/latest/getting-started.md index 2cd35f20280b..8b393fcc828e 100644 --- a/docs/en/latest/getting-started.md +++ b/docs/en/latest/getting-started.md @@ -156,7 +156,7 @@ docker-compose -p docker-apisix -f docker-compose-arm64.yml up -d :::note -You can check out [Installing Apache APISIX](./how-to-build.md) for different installation methods. +You can check out [Installing Apache APISIX](./installation-guide.md) for different installation methods. ::: diff --git a/docs/en/latest/how-to-build.md b/docs/en/latest/installation-guide.md similarity index 100% rename from docs/en/latest/how-to-build.md rename to docs/en/latest/installation-guide.md diff --git a/docs/en/latest/mtls.md b/docs/en/latest/mtls.md index 6e8a09582380..b46e7d7b81e2 100644 --- a/docs/en/latest/mtls.md +++ b/docs/en/latest/mtls.md @@ -154,7 +154,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-Base](./how-to-build.md#step-6-build-openresty-for-apache-apisix). +This feature requires APISIX to run on [APISIX-Base](./FAQ/#how-do-i-build-the-apisix-base-environment). 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 0273c20162a5..8fbf9b731a11 100644 --- a/docs/en/latest/plugin-develop.md +++ b/docs/en/latest/plugin-develop.md @@ -510,7 +510,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#Step-4-Run-Test-Cases) to setup the testing framework. +Refer the following [document](installation-guide.md) to setup the testing framework. ### attach the test-nginx execution process: diff --git a/docs/en/latest/plugins/dubbo-proxy.md b/docs/en/latest/plugins/dubbo-proxy.md index f37028b9a6ee..fb8873595039 100644 --- a/docs/en/latest/plugins/dubbo-proxy.md +++ b/docs/en/latest/plugins/dubbo-proxy.md @@ -27,7 +27,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#step-6-build-openresty-for-apache-apisix) +If you are using OpenResty, you need to build it with dubbo support, see [APISIX-Base](./FAQ/#how-do-i-build-the-apisix-base-environment). ## Runtime Attributes diff --git a/docs/zh/latest/README.md b/docs/zh/latest/README.md index da8958e7b16b..04cb2ce5e1de 100644 --- a/docs/zh/latest/README.md +++ b/docs/zh/latest/README.md @@ -167,7 +167,7 @@ A/B 测试、金丝雀发布（灰度发布）、蓝绿部署、限流限速、 1. 安装 - 请参考[安装文档](./how-to-build.md)。 + 请参考[APISIX 安装指南](./installation-guide.md)。 2. 入门指南 diff --git a/docs/zh/latest/config.json b/docs/zh/latest/config.json index 99b3c7c41b25..07b6d196e56b 100644 --- a/docs/zh/latest/config.json +++ b/docs/zh/latest/config.json @@ -31,7 +31,7 @@ }, { "type": "doc", - "id": "how-to-build" + "id": "installation-guide" }, { "type": "category", diff --git a/docs/zh/latest/getting-started.md b/docs/zh/latest/getting-started.md index 2bf06f25bc20..b40736269ee2 100644 --- a/docs/zh/latest/getting-started.md +++ b/docs/zh/latest/getting-started.md @@ -148,7 +148,7 @@ docker-compose -p docker-apisix -f docker-compose-arm64.yml up -d :::note -你也可以参考 [APISIX 安装指南](./how-to-build.md)了解不同的安装方法。 +你也可以参考 [APISIX 安装指南](./installation-guide.md)了解不同的安装方法。 ::: diff --git a/docs/zh/latest/how-to-build.md b/docs/zh/latest/installation-guide.md similarity index 100% rename from docs/zh/latest/how-to-build.md rename to docs/zh/latest/installation-guide.md diff --git a/docs/zh/latest/plugins/dubbo-proxy.md b/docs/zh/latest/plugins/dubbo-proxy.md index e7d3be07c161..970e67958381 100644 --- a/docs/zh/latest/plugins/dubbo-proxy.md +++ b/docs/zh/latest/plugins/dubbo-proxy.md @@ -27,7 +27,7 @@ title: dubbo-proxy ## 要求 -如果你正在使用 `OpenResty`, 你需要编译它来支持 `dubbo`, 参考 [如何编译](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)。 +如果你正在使用 `OpenResty`, 你需要编译它来支持 `dubbo`, 参考 [APISIX-Base](../FAQ#如何构建-apisix-base-环境)。 ## 运行时属性 diff --git a/utils/gen-vote-contents.sh b/utils/gen-vote-contents.sh index cccae1348eca..87ddedbc18d8 100755 --- a/utils/gen-vote-contents.sh +++ b/utils/gen-vote-contents.sh @@ -73,7 +73,7 @@ tar zxvf apache-apisix-$VERSION-src.tgz 4. Build Apache APISIX: -https://github.com/apache/apisix/blob/release/$BLOB_VERSION/docs/en/latest/how-to-build.md#installation-via-source-release-package +https://github.com/apache/apisix/blob/release/$BLOB_VERSION/docs/en/latest/installation-guide.md#installation-via-source-release-package The vote will be open for at least 72 hours or until necessary number of votes are reached. From 05b39042b3ba5d8d1e5f1a5deb6c8a6005ab767e Mon Sep 17 00:00:00 2001 From: hf400159 Date: Fri, 20 May 2022 09:18:19 +0800 Subject: [PATCH 2/2] docs: modify how-to-build filename --- docs/en/latest/plugin-develop.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/latest/plugin-develop.md b/docs/en/latest/plugin-develop.md index 8fbf9b731a11..6dcd207bcbd5 100644 --- a/docs/en/latest/plugin-develop.md +++ b/docs/en/latest/plugin-develop.md @@ -510,7 +510,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](installation-guide.md) to setup the testing framework. +Refer the following [document](how-to-build.md) to setup the testing framework. ### attach the test-nginx execution process: