You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/06/06 23:46:11 UTC

[GitHub] [apisix-website] juzhiyuan commented on a diff in pull request #1135: docs: create page for "Building APISIX"

juzhiyuan commented on code in PR #1135:
URL: https://github.com/apache/apisix-website/pull/1135#discussion_r890648031


##########
website/docs/general/building-apisix.md:
##########
@@ -0,0 +1,258 @@
+---
+id: building-apisix
+title: Building APISIX
+keywords:
+  - API gateway
+  - APISIX
+  - Apache APISIX
+  - Code Contribution
+  - Building APISIX

Review Comment:
   ```suggestion
     - Building APISIX
     - Apache APISIX Development
   ```



##########
website/docs/general/building-apisix.md:
##########
@@ -0,0 +1,258 @@
+---
+id: building-apisix
+title: Building APISIX

Review Comment:
   Thanks! How about using `Building Apache APISIX from source codes`? or pick another one to improve SEO 😄



##########
website/docs/general/building-apisix.md:
##########
@@ -0,0 +1,258 @@
+---
+id: building-apisix
+title: Building APISIX
+keywords:
+  - API gateway
+  - APISIX
+  - Apache APISIX
+  - Code Contribution
+  - Building APISIX
+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 install and run APISIX, check out the [Installation](/docs/apisix/how-to-build) docs.
+
+:::note
+
+If you want to build and package APISIX for a specific platform, see [apisix-build-tools](https://github.com/api7/apisix-build-tools).
+
+:::
+
+## Building APISIX from source
+
+To start, you have to install some dependencies. APISIX provides a handy script to get these installed:
+
+```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`:
+
+```shell
+APISIX_VERSION='2.13.1'
+mkdir apisix-${APISIX_VERSION}
+```
+
+You can now download the APISIX source by running the command below. You can also download the source package from the [downloads page](https://apisix.apache.org/downloads/). You will also find source packages for APISIX Dashboard and APISIX Ingress Controller.

Review Comment:
   ```suggestion
   You can now download the APISIX source by running the command below. You can also download the source package from the [Downloads page](https://apisix.apache.org/downloads/). You will also find source packages for APISIX Dashboard and APISIX Ingress Controller.
   ```



##########
website/docs/general/building-apisix.md:
##########
@@ -0,0 +1,258 @@
+---
+id: building-apisix
+title: Building APISIX
+keywords:
+  - API gateway
+  - APISIX
+  - Apache APISIX
+  - Code Contribution
+  - Building APISIX
+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 install and run APISIX, check out the [Installation](/docs/apisix/how-to-build) docs.

Review Comment:
   We'd better also update `how-to-build` doc name, as the current doc is how to build, the other one is `installation`.



##########
website/docs/general/building-apisix.md:
##########
@@ -0,0 +1,258 @@
+---
+id: building-apisix
+title: Building APISIX
+keywords:
+  - API gateway
+  - APISIX
+  - Apache APISIX
+  - Code Contribution
+  - Building APISIX
+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 install and run APISIX, check out the [Installation](/docs/apisix/how-to-build) docs.
+
+:::note
+
+If you want to build and package APISIX for a specific platform, see [apisix-build-tools](https://github.com/api7/apisix-build-tools).
+
+:::
+
+## Building APISIX from source
+
+To start, you have to install some dependencies. APISIX provides a handy script to get these installed:
+
+```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`:
+
+```shell
+APISIX_VERSION='2.13.1'

Review Comment:
   ```suggestion
   APISIX_VERSION='2.14.1'
   ```



-- 
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