From 6c101d08ae66e2cd9070f9538103357c3509ac50 Mon Sep 17 00:00:00 2001 From: Traky Deng Date: Sat, 12 Oct 2024 13:55:20 +0800 Subject: [PATCH 1/4] correction --- docs/en/latest/building-apisix.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/latest/building-apisix.md b/docs/en/latest/building-apisix.md index a88cfa883b9f..4e65759f6b9d 100644 --- a/docs/en/latest/building-apisix.md +++ b/docs/en/latest/building-apisix.md @@ -45,16 +45,16 @@ To build and package APISIX for a specific platform, see [apisix-build-tools](ht ## Building APISIX from source -First of all, we need to specify the version `APISIX_VERSION` to be installed: +First of all, we need to specify the branch to be built: ```shell -APISIX_VERSION='3.11.0' +APISIX_BRANCH='release/3.11.0' ``` Then, you can run the following command to clone the APISIX source code from Github: ```shell -git clone --depth 1 --branch ${APISIX_VERSION} https://github.com/apache/apisix.git apisix-${APISIX_VERSION} +git clone --depth 1 --branch ${APISIX_BRANCH} https://github.com/apache/apisix.git apisix-${APISIX_BRANCH} ``` Alternatively, you can also download the source package from the [Downloads](https://apisix.apache.org/downloads/) page. Note that source packages here are not distributed with test cases. @@ -62,7 +62,7 @@ Alternatively, you can also download the source package from the [Downloads](htt Next, navigate to the directory, install dependencies, and build APISIX. ```shell -cd apisix-${APISIX_VERSION} +cd apisix-${APISIX_BRANCH} make deps make install ``` From 50d76a0ff49ae902ca01e6559780bc436034aa49 Mon Sep 17 00:00:00 2001 From: Traky Deng Date: Sat, 12 Oct 2024 14:02:25 +0800 Subject: [PATCH 2/4] install open resty --- docs/en/latest/building-apisix.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en/latest/building-apisix.md b/docs/en/latest/building-apisix.md index 4e65759f6b9d..6e3a8ae5d976 100644 --- a/docs/en/latest/building-apisix.md +++ b/docs/en/latest/building-apisix.md @@ -59,6 +59,8 @@ git clone --depth 1 --branch ${APISIX_BRANCH} https://github.com/apache/apisix.g Alternatively, you can also download the source package from the [Downloads](https://apisix.apache.org/downloads/) page. Note that source packages here are not distributed with test cases. +Before installation, install [OpenResty](https://openresty.org/en/installation.html). + Next, navigate to the directory, install dependencies, and build APISIX. ```shell From 3b1b0c59cecb69b03ccf9636d3a45a3bec46e9d7 Mon Sep 17 00:00:00 2001 From: Traky Deng Date: Sat, 19 Oct 2024 14:27:30 +0800 Subject: [PATCH 3/4] update zh doc --- docs/zh/latest/building-apisix.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/zh/latest/building-apisix.md b/docs/zh/latest/building-apisix.md index d6908e02c86a..ed84029fa683 100644 --- a/docs/zh/latest/building-apisix.md +++ b/docs/zh/latest/building-apisix.md @@ -53,17 +53,19 @@ APISIX_VERSION='3.11.0' 然后,你可以运行以下命令,从 Github 克隆 APISIX 源码: ```shell -git clone --depth 1 --branch ${APISIX_VERSION} https://github.com/apache/apisix.git apisix-${APISIX_VERSION} +git clone --depth 1 --branch ${APISIX_BRANCH} https://github.com/apache/apisix.git apisix-${APISIX_BRANCH} ``` 你可以从[下载页面](https://apisix.apache.org/downloads/)下载源码包。但是官网的源码包缺少测试用例,可能会对你后续操作产生困扰。 另外,你也可以在该页面找到 APISIX Dashboard 和 APISIX Ingress Controller 的源码包。 +安装之前,请安装[OpenResty](https://openresty.org/en/installation.html)。 + 然后切换到 APISIX 源码的目录,创建依赖项并安装 APISIX,命令如下所示: ```shell -cd apisix-${APISIX_VERSION} +cd apisix-${APISIX_BRANCH} make deps make install ``` From dc79a4c6dc0d92e987eaeda1246e0091c9f0ef61 Mon Sep 17 00:00:00 2001 From: Traky Deng Date: Sat, 19 Oct 2024 14:28:04 +0800 Subject: [PATCH 4/4] update zh doc --- docs/zh/latest/building-apisix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/latest/building-apisix.md b/docs/zh/latest/building-apisix.md index ed84029fa683..247bef0f8a99 100644 --- a/docs/zh/latest/building-apisix.md +++ b/docs/zh/latest/building-apisix.md @@ -47,7 +47,7 @@ import TabItem from '@theme/TabItem'; 首先,我们需要指定需要安装的版本`APISIX_VERSION`: ```shell -APISIX_VERSION='3.11.0' +APISIX_BRANCH='release/3.11.0' ``` 然后,你可以运行以下命令,从 Github 克隆 APISIX 源码: