Skip to content

Commit

Permalink
docs: modify how-to-build filename (apache#7087)
Browse files Browse the repository at this point in the history
  • Loading branch information
guitu168 authored and Liu-Junlin committed May 20, 2022
1 parent 76b3e59 commit 45f7ff9
Show file tree
Hide file tree
Showing 13 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
{
"type": "doc",
"id": "how-to-build"
"id": "installation-guide"
},
{
"type": "category",
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/en/latest/mtls.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugin-develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](how-to-build.md) to setup the testing framework.

### attach the test-nginx execution process:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/dubbo-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ A/B 测试、金丝雀发布(灰度发布)、蓝绿部署、限流限速、

1. 安装

请参考[安装文档](./how-to-build.md)
请参考[APISIX 安装指南](./installation-guide.md)

2. 入门指南

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
{
"type": "doc",
"id": "how-to-build"
"id": "installation-guide"
},
{
"type": "category",
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)了解不同的安装方法。

:::

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/zh/latest/plugins/dubbo-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ title: dubbo-proxy

## 要求

如果你正在使用 `OpenResty`, 你需要编译它来支持 `dubbo`, 参考 [如何编译](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)
如果你正在使用 `OpenResty`, 你需要编译它来支持 `dubbo`, 参考 [APISIX-Base](../FAQ#如何构建-apisix-base-环境)

## 运行时属性

Expand Down
2 changes: 1 addition & 1 deletion utils/gen-vote-contents.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 45f7ff9

Please sign in to comment.