This is an automated email from the ASF dual-hosted git repository.
monkeydluffy 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 1e31e9da1 docs: Improve Building APISIX from source (#9444)
1e31e9da1 is described below
commit 1e31e9da12191789ea30439e82d2d45ed50b9b00
Author: Traky Deng <[email protected]>
AuthorDate: Tue May 16 18:09:51 2023 +0800
docs: Improve Building APISIX from source (#9444)
---
docs/en/latest/building-apisix.md | 19 ++++++++-----------
1 file changed, 8 insertions(+), 11 deletions(-)
diff --git a/docs/en/latest/building-apisix.md
b/docs/en/latest/building-apisix.md
index 98973f207..ad4f11c68 100644
--- a/docs/en/latest/building-apisix.md
+++ b/docs/en/latest/building-apisix.md
@@ -31,9 +31,9 @@ description: Guide for building and running APISIX locally
for development.
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-If you are looking to contribute to APISIX or setup a development environment,
this guide is for you.
+If you are looking to setup a development environment or contribute to APISIX,
this guide is for you.
-If you are looking to install and run APISIX, check out the
[Installation](./installation-guide.md) docs.
+If you are looking to quickly get started with APISIX, check out the other
[installation methods](./installation-guide.md).
:::note
@@ -43,30 +43,27 @@ If you want to build and package APISIX for a specific
platform, see [apisix-bui
## Building APISIX from source
-To start, you have to install some dependencies. APISIX provides a handy
script to get these installed:
+Install dependencies using the script provided by APISIX:
```shell
curl
https://raw.githubusercontent.com/apache/apisix/master/utils/install-dependencies.sh
-sL | bash -
```
-Then, create a directory and set the environment variable `APISIX_VERSION`:
+Save the APISIX version to an environment variable to be used next:
```shell
APISIX_VERSION='3.3.0'
-mkdir apisix-${APISIX_VERSION}
```
-You can now clone the APISIX source code from Github by running the command
below:
+Clone the APISIX source code of this version into a new directory
`apisix-APISIX_VERSION`:
```shell
git clone --depth 1 --branch ${APISIX_VERSION}
https://github.com/apache/apisix.git apisix-${APISIX_VERSION}
```
-You can also download the source package from the [Downloads
page](https://apisix.apache.org/downloads/). But the source package missing the
test case. This may affect subsequent operations.
+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.
-And you will also find source packages for APISIX Dashboard and APISIX Ingress
Controller from [Downloads page](https://apisix.apache.org/downloads/).
-
-Now, navigate to the directory, create dependencies, and install APISIX as
shown below:
+Next, navigate to the directory, install dependencies, and build APISIX. You
should have [Rust](https://www.rust-lang.org) installed in your environment
first before running `make deps`:
```shell
cd apisix-${APISIX_VERSION}
@@ -74,7 +71,7 @@ make deps
make install
```
-This will install the runtime dependent Lua libraries and the `apisix` command.
+This will install the runtime-dependent Lua libraries and the `apisix` CLI
tool.
:::note