This is an automated email from the ASF dual-hosted git repository.
traky 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 a8519524e docs: update variable in building apisix from source (#11640)
a8519524e is described below
commit a8519524e16cbb5b32fe3f6e20978d2fdf08f07a
Author: Traky Deng <[email protected]>
AuthorDate: Tue Apr 15 10:00:49 2025 +0800
docs: update variable in building apisix from source (#11640)
---
.ignore_words | 2 ++
docs/en/latest/building-apisix.md | 11 +++++++----
docs/zh/latest/building-apisix.md | 8 +++++---
3 files changed, 14 insertions(+), 7 deletions(-)
diff --git a/.ignore_words b/.ignore_words
index 5e9354537..86683d38e 100644
--- a/.ignore_words
+++ b/.ignore_words
@@ -7,3 +7,5 @@ nd
hel
nulll
smove
+aks
+nin
diff --git a/docs/en/latest/building-apisix.md
b/docs/en/latest/building-apisix.md
index 576911288..0c52ed944 100644
--- a/docs/en/latest/building-apisix.md
+++ b/docs/en/latest/building-apisix.md
@@ -45,24 +45,27 @@ 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.12.0'
+APISIX_BRANCH='release/3.11.0'
+APISIX_VERSION='release/3.12.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.
+Before installation, install
[OpenResty](https://openresty.org/en/installation.html).
+
Next, navigate to the directory, install dependencies, and build APISIX.
```shell
-cd apisix-${APISIX_VERSION}
+cd apisix-${APISIX_BRANCH}
make deps
make install
```
diff --git a/docs/zh/latest/building-apisix.md
b/docs/zh/latest/building-apisix.md
index 8b07dbb1d..26e174796 100644
--- a/docs/zh/latest/building-apisix.md
+++ b/docs/zh/latest/building-apisix.md
@@ -47,23 +47,25 @@ import TabItem from '@theme/TabItem';
首先，我们需要指定需要安装的版本`APISIX_VERSION`:
```shell
-APISIX_VERSION='3.12.0'
+APISIX_BRANCH='release/3.12.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
```
