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/02/21 02:32:51 UTC
[GitHub] [apisix] yzeng25 commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
yzeng25 commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r810733267
##########
File path: docs/en/latest/getting-started.md
##########
@@ -23,36 +23,40 @@ title: Getting Started
## Summary
-This documentation is a quick start guide for Apache APISIX. The Quick Start is divided into the following three steps:
+This guide walks through how you can get up and running with Apache APISIX.
-1. Install Apache APISIX via [Docker Compose](https://docs.docker.com/compose/).
-1. Create a route and bind it with a Upstream.
-1. Use `curl` command to verify that the results returned after binding are as expected.
+The guide is divided into these three steps:
-In addition, this documentation provides some advanced operations on how to use Apache APISIX, including adding authentication, prefixing Route, using the APISIX Dashboard, and troubleshooting.
+1. Installing Apache APISIX
+2. Creating a Route and binding it with an Upstream
+3. Verifying the results after binding with `curl`
-We will use the following `echo` endpoint as an example, which will return the parameters we passed.
+This docs also introduces some of the advanced features and operations in Apache APISIX like authentication, prefixing a Route, using the APISIX Dashboard, and troubleshooting.
Review comment:
```suggestion
This document also introduces some of the advanced features and operations in Apache APISIX like authentication, prefixing a Route, using the APISIX Dashboard, and troubleshooting.
```
##########
File path: docs/en/latest/getting-started.md
##########
@@ -92,29 +98,31 @@ If you already have Apache APISIX installed, please skip Step 1, and go to [Step
## Step 1: Install Apache APISIX
-Thanks to Docker, we can start Apache APISIX and enable it by enabling [Admin API](./admin-api.md).
+You can check out [Building Apache APISIX](./how-to-build.md) for different installation methods.
+
+To get started quickly, we will install Apache APISIX with Docker and enable the [Admin API](./admin-api.md).
```bash
-# Download the Docker image of Apache APISIX
+# Download the docker-compose file of Apache APISIX
git clone https://github.com/apache/apisix-docker.git
-# Switch the current directory to the apisix-docker/example path
+# Switch the current directory to the apisix-docker/example
cd apisix-docker/example
-# Run the docker-compose command to install Apache APISIX
+# Start Apache APISIX with docker-compose
docker-compose -p docker-apisix up -d
```
-> Apache APISIX has already supported ARM64 architecture. For ARM64 users, please use `docker-compose -p docker-apisix -f docker-compose-arm64.yml up -d` instead in the last step.
+> Apache APISIX already supports ARM64 architecture. To run Apache APISIX on ARM64, run: `docker-compose -p docker-apisix -f docker-compose-arm64.yml up -d` instead of the last step above.
-It will take some time to download all required files, please be patient.
+Please remain patient as it will take some time to download the files and spin up the containers.
-Once the download is complete, execute the `curl` command on the host running Docker to access the Admin API, and determine if Apache APISIX was successfully started based on the returned data.
+Once Apache APISIX is running, you can use `curl` to access the Admin API. You can also check if Apache APISIX is running properly by running this command and checking the response.
```bash
-# Note: Please execute the curl command on the host where you are running Docker.
+# Execute in your host machine (machine running Docker)
Review comment:
Would be better to add a**on** or **in** between `running` and `Docker` in the end of this sentence.
```suggestion
# Execute in your host machine (machine running Docker)
```
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -21,27 +21,29 @@ title: How to build Apache APISIX
#
-->
+This guide walks you through how you can build and get Apache APISIX running on your environment. Please refer the [Getting Started](./getting-started.md) guide for a quick walkthrough on running Apache APISIX.
+
## Step 1: Install Apache APISIX
-You can install Apache APISIX via RPM Repository, Docker, Helm Chart, source release package, and source release package ( LTS version ). Please choose one from the following options.
+Apache APISIX can be installed via the [RPM package](#installation-via-rpm-repository-centos-7), [Docker image](#installation-via-docker), [Helm Chart](#installation-via-helm-chart) or the [source release package](#installation-via-source-release-package). You can install via any one of these options.
-### Installation via RPM Repository(CentOS 7)
+### Installation via RPM Repository (CentOS 7)
This installation method is suitable for CentOS 7.
-If the official OpenResty repository is not installed yet, the following command will help you automatically install both the repositories of OpenResty and Apache APISIX.
+If the official OpenResty repository is **not installed yet**, the following command will help you automatically install both the repositories—OpenResty and Apache APISIX.
Review comment:
```suggestion
If the official OpenResty repository is **not installed yet**, the following command will help you automatically install both the repositories of OpenResty and Apache APISIX.
```
##########
File path: docs/en/latest/getting-started.md
##########
@@ -310,15 +322,19 @@ Apache APISIX provides a [Dashboard](https://github.com/apache/apisix-dashboard)
### Troubleshooting
-- Make sure that all required ports (**default 9080/9443/2379**) are not used by other systems or processes.
+You can try these troubleshooting steps if you are unable to proceed as suggested in the docs above.
+
+Please [open an issue](/docs/general/contributor-guide#submit-an-issue) if you run into any bugs or if there are any missing troubleshooting steps.
+
+- Make sure that all required ports (**default 9080/9443/2379**) are available and is not used by other systems or processes.
Review comment:
```suggestion
- Make sure that all required ports (**default 9080/9443/2379**) are available. In other words, these ports are not used by other systems or processes.
```
##########
File path: docs/en/latest/getting-started.md
##########
@@ -92,29 +98,31 @@ If you already have Apache APISIX installed, please skip Step 1, and go to [Step
## Step 1: Install Apache APISIX
-Thanks to Docker, we can start Apache APISIX and enable it by enabling [Admin API](./admin-api.md).
+You can check out [Building Apache APISIX](./how-to-build.md) for different installation methods.
+
+To get started quickly, we will install Apache APISIX with Docker and enable the [Admin API](./admin-api.md).
```bash
-# Download the Docker image of Apache APISIX
+# Download the docker-compose file of Apache APISIX
git clone https://github.com/apache/apisix-docker.git
-# Switch the current directory to the apisix-docker/example path
+# Switch the current directory to the apisix-docker/example
cd apisix-docker/example
-# Run the docker-compose command to install Apache APISIX
+# Start Apache APISIX with docker-compose
docker-compose -p docker-apisix up -d
```
-> Apache APISIX has already supported ARM64 architecture. For ARM64 users, please use `docker-compose -p docker-apisix -f docker-compose-arm64.yml up -d` instead in the last step.
+> Apache APISIX already supports ARM64 architecture. To run Apache APISIX on ARM64, run: `docker-compose -p docker-apisix -f docker-compose-arm64.yml up -d` instead of the last step above.
-It will take some time to download all required files, please be patient.
+Please remain patient as it will take some time to download the files and spin up the containers.
-Once the download is complete, execute the `curl` command on the host running Docker to access the Admin API, and determine if Apache APISIX was successfully started based on the returned data.
+Once Apache APISIX is running, you can use `curl` to access the Admin API. You can also check if Apache APISIX is running properly by running this command and checking the response.
```bash
-# Note: Please execute the curl command on the host where you are running Docker.
+# Execute in your host machine (machine running Docker)
curl "http://127.0.0.1:9080/apisix/admin/services/" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'
```
-The following data is returned to indicate that Apache APISIX was successfully started:
+This response indicate that Apache APISIX is running successfully.
Review comment:
```suggestion
This response indicates that Apache APISIX is running successfully.
```
--
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