You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by "kayx23 (via GitHub)" <gi...@apache.org> on 2023/05/16 09:48:31 UTC

[GitHub] [apisix] kayx23 commented on a diff in pull request #9444: docs: Improve Building APISIX from source

kayx23 commented on code in PR #9444:
URL: https://github.com/apache/apisix/pull/9444#discussion_r1194910063


##########
docs/en/latest/building-apisix.md:
##########
@@ -43,38 +43,35 @@ 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}
 make deps
 make install
 ```
 
-This will install the runtime dependent Lua libraries and the `apisix` command.
+This will install the runtime dependency Lua libraries and the `apisix` CLI tool.

Review Comment:
   ```suggestion
   This will install the runtime-dependent Lua libraries and the `apisix` CLI tool.
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org