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/20 14:02:19 UTC
[GitHub] [apisix] navendu-pottekkat opened a new pull request #6389: fix: update "getting started" and "how to build" guides
navendu-pottekkat opened a new pull request #6389:
URL: https://github.com/apache/apisix/pull/6389
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
Fixes #6380
This PR fixes issues in the "Getting Started" and "Building Apache APISIX" pages.
- Adds internal hyperlinks
- Fixes typos
- Enhances readability and usability
--
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
[GitHub] [apisix] navendu-pottekkat commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1046475138
@yzeng25 @spacewander What are your thoughts on changing the "How to Build" title to "Installation"?
There was a discussion on this in this issue thread: https://github.com/apache/apisix/issues/6380#issuecomment-1045783529
--
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
[GitHub] [apisix] yzeng25 commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r810857483
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -113,30 +117,34 @@ Please refer to: [Installing Apache APISIX with Helm Chart](https://github.com/a
make install
```
- - 4.1 `make deps` install `lualdap` failed, error like: `Could not find header file for LDAP`
+ **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
-5. If you have no more need for the Apache APISIX runtime, you could uninstall it like this.
+5. To uninstall the Apache APISIX runtime, run:
-```shell
- # Uninstall apisix command
- make uninstall
- # Purge dependencies
- make undeps
-```
+ ```shell
+ # Uninstall apisix command
+ make uninstall
+ # Purge dependencies
+ make undeps
+ ```
- Attention please, this operation will totally **remove** the related files.
+ **Note**: This operation will remove the files completely.
-### LTS version Installation via Source Release Package
+### LTS version installation via Source Release Package
-The current LTS VERSION of Apache APISIX is `2.10.3`. Set `APISIX VERSION` in [install by source package](# Install by source package) to `2.10.3` and follow the other steps.
+The [current LTS version](https://apisix.apache.org/downloads/) of Apache APISIX is `2.10.4`.
Review comment:
BTW there is a space in the end of this line that causes lint error.
```suggestion
The [current LTS version](https://apisix.apache.org/downloads/) of Apache APISIX is `2.10.4`.
```
--
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811577744
##########
File path: docs/en/latest/getting-started.md
##########
@@ -130,15 +138,13 @@ The following data is returned to indicate that Apache APISIX was successfully s
## Step 2: Create a Route
-Now we have a running instance of Apache APISIX! Next, let's create a Route.
-
-### How it works
+[Routes](./architecture-design/route.md) matches to clients requests based on defined rules, loads and executes the corresponding plugins, and forwards the request to the specified upstream.
Review comment:
```suggestion
[Routes](./architecture-design/route.md) matches the client's requests based on defined rules, loads and executes the corresponding plugins, and forwards the request to the specified upstream.
```
--
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
[GitHub] [apisix] navendu-pottekkat commented on pull request #6389: fix: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1046244962
@jwrookie @kwanhur Could you please review this PR?
--
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
[GitHub] [apisix] juzhiyuan commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1046812182
Also cc @Anita-ihuman and @avinal to have a review 🤗
--
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
[GitHub] [apisix] navendu-pottekkat commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1050846495
@juzhiyuan Is that triggered by a new release of the website repo?
--
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
[GitHub] [apisix] avinal edited a comment on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal edited a comment on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1051099033
> @juzhiyuan Is that triggered by a new release of the website repo?
Yes, all the commits are only reflected in a new release of Apache APISIX repo.
--
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
[GitHub] [apisix] yzeng25 commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1048482517
Hi @navendu-pottekkat , I can approve and get the checks running. Meanwhile you can fix the remaining 2 or 3 comments.
--
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
[GitHub] [apisix] navendu-pottekkat commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1048493485
@yzeng25 Done!
--
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
[GitHub] [apisix] spacewander commented on a change in pull request #6389: fix: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r810728419
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -1,5 +1,5 @@
---
-title: How to build Apache APISIX
+title: Building Apache APISIX
Review comment:
`Installing` would be better?
--
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
[GitHub] [apisix] yzeng25 commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1046567867
> @yzeng25 @spacewander What are your thoughts on changing the "How to Build" title to "Installation"?
>
> There was a discussion on this in this issue thread: [#6380 (comment)](https://github.com/apache/apisix/issues/6380#issuecomment-1045783529)
I think using "Installing Apache APISIX" for the document title is fine.
If you are referring to the file name, then you need to be cautious about it, since other pages might refer to it as something like `[how-to-build](how-to-build.md)`. In this case, you would need to do a global search and update all of them.
--
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811585631
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -301,14 +309,12 @@ Content-Type: text/plain
{"node":{...},"action":"get"}
```
-At this point, if the key you enter does not match the value of `apisix.admin_key` in `conf/config.yaml`, for example, we know that the correct key is `abcdefghabcdefgh`, but we enter an incorrect key, such as `wrong-key`, as shown below.
+If the key you enter does not match the value of `apisix.admin_key` in `conf/config.yaml`, a response with a status code 401 will indicate that the access failed.
Review comment:
```suggestion
If the key you entered does not match the value of `apisix.admin_key` in `conf/config.yaml`, a response with a status code 401 will indicate that the access failed.
```
--
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
[GitHub] [apisix] juzhiyuan merged pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged pull request #6389:
URL: https://github.com/apache/apisix/pull/6389
--
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
[GitHub] [apisix] navendu-pottekkat commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1048475295
@avinal Made changes as suggested. Could you please review the PR?
--
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811583797
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -113,30 +117,34 @@ Please refer to: [Installing Apache APISIX with Helm Chart](https://github.com/a
make install
```
- - 4.1 `make deps` install `lualdap` failed, error like: `Could not find header file for LDAP`
+ **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
-5. If you have no more need for the Apache APISIX runtime, you could uninstall it like this.
+5. To uninstall the Apache APISIX runtime, run:
-```shell
- # Uninstall apisix command
- make uninstall
- # Purge dependencies
- make undeps
-```
+ ```shell
+ # Uninstall apisix command
+ make uninstall
+ # Purge dependencies
+ make undeps
+ ```
- Attention please, this operation will totally **remove** the related files.
+ **Note**: This operation will remove the files completely.
-### LTS version Installation via Source Release Package
+### LTS version installation via Source Release Package
-The current LTS VERSION of Apache APISIX is `2.10.3`. Set `APISIX VERSION` in [install by source package](# Install by source package) to `2.10.3` and follow the other steps.
+The [current LTS version](https://apisix.apache.org/downloads/) of Apache APISIX is `2.10.4`.
-## Step 2: Install ETCD
+To install this version, set `APISIX _VERSION`
-This step is required if you have installed only Apache APISIX via RPM, Docker or source code but not ETCD.
+Set `APISIX VERSION` in [Installation via Source Release Package](#installation-via-source-release-package) to `2.10.4` and continue with the other steps.
Review comment:
```suggestion
Set `APISIX_VERSION` in [Installation via Source Release Package](#installation-via-source-release-package) to `2.10.4` and continue with the other steps.
```
--
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811582737
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -65,38 +67,40 @@ sudo yum clean all && yum makecache
sudo yum install -y --downloadonly --downloaddir=./apisix apisix
```
-Copy `./apisix` folder to the target host, run the following command to install Apache APISIX.
+Then copy `./apisix` folder to the target host and run the following command to install.
```shell
sudo yum install ./apisix/*.rpm
```
### Installation via Docker
-Please refer to: [Installing Apache APISIX with Docker](https://hub.docker.com/r/apache/apisix).
+Please refer to [Installing Apache APISIX with Docker](https://hub.docker.com/r/apache/apisix).
### Installation via Helm Chart
-Please refer to: [Installing Apache APISIX with Helm Chart](https://github.com/apache/apisix-helm-chart).
+Please refer to [Installing Apache APISIX with Helm Chart](https://github.com/apache/apisix-helm-chart).
### Installation via Source Release Package
+Follow the steps below to install Apache APISIX via the source release package.
+
1. Create a directory named `apisix-2.12.0`.
```shell
APISIX_VERSION='2.12.0'
mkdir apisix-${APISIX_VERSION}
```
-2. Download Apache APISIX Release source package.
+2. Download the [Apache APISIX source release package](https://downloads.apache.org/apisix/APISIX_VERSION/apache-apisix-APISIX_VERSION-src.tgz).
Review comment:
The download link won't work, right? until we use curl/wget and that is already mentioned below, so we can remove the link here. On the safe side we can put the latest link but then it would need to be updated every release. So better to remove it.
```suggestion
2. Download the Apache APISIX source release package.
```
--
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
[GitHub] [apisix] yzeng25 commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r810851163
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -1,5 +1,5 @@
---
-title: How to build Apache APISIX
+title: Building Apache APISIX
Review comment:
agree
--
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811578209
##########
File path: docs/en/latest/getting-started.md
##########
@@ -155,23 +161,25 @@ curl "http://127.0.0.1:9080/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f034335f
}'
```
-This routing configuration means that all matching inbound requests will be forwarded to the Upstream service `httpbin.org:80` when they meet **all** the rules listed below:
+This configuration basically means that it will forward all matching inbound requests to the upstream service (`httpbin.org:80`) if they meet these specified criterions.
Review comment:
```suggestion
This configuration means that it will forward all matching inbound requests to the upstream service (`httpbin.org:80`) if they meet these specified criteria.
```
--
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
[GitHub] [apisix] Anita-ihuman commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
Anita-ihuman commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r812315269
##########
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.
Review comment:
This is a quick start guide to Apache APISIX. It will walk you through the basic steps to get up and running with Apache APISIX.
--
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
[GitHub] [apisix] navendu-pottekkat commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r812573316
##########
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:
We should be running the command on the machine that is running Docker right and **not** on inside the Docker container right?
--
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811584370
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -182,54 +190,54 @@ apisix start
Both `apisix quit` and `apisix stop` can stop Apache APISIX. The main difference is that `apisix quit` stops Apache APISIX gracefully, while `apisix stop` stops Apache APISIX immediately.
-It is recommended to use gracefully stop command `apisix quit` because it ensures that Apache APISIX will complete all the requests it has received before stopping down. In contrast, `apisix stop` will trigger a forced shutdown, it stops Apache APISIX immediately, in which case the incoming requests will not be processed before the shutdown.
+It is recommended to use gracefully stop command `apisix quit` because it ensures that Apache APISIX will complete all the requests it has received before stopping. On the other hand, `apisix stop` will trigger a forced shutdown and will stop Apache APISIX immediately. This will cause the pending incoming requests to not be processed before shutdown.
Review comment:
```suggestion
It is recommended to use the gracefully stop command `apisix quit` because it ensures that Apache APISIX will complete all the requests it has received before stopping. On the other hand, `apisix stop` will trigger a forced shutdown and will stop Apache APISIX immediately. This will cause the pending incoming requests to not be processed before shutdown.
```
--
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
[GitHub] [apisix] yzeng25 commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811583443
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -113,30 +117,34 @@ Please refer to: [Installing Apache APISIX with Helm Chart](https://github.com/a
make install
```
- - 4.1 `make deps` install `lualdap` failed, error like: `Could not find header file for LDAP`
+ **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
-5. If you have no more need for the Apache APISIX runtime, you could uninstall it like this.
+5. To uninstall the Apache APISIX runtime, run:
-```shell
- # Uninstall apisix command
- make uninstall
- # Purge dependencies
- make undeps
-```
+ ```shell
+ # Uninstall apisix command
+ make uninstall
+ # Purge dependencies
+ make undeps
+ ```
- Attention please, this operation will totally **remove** the related files.
+ **Note**: This operation will remove the files completely.
-### LTS version Installation via Source Release Package
+### LTS version installation via Source Release Package
-The current LTS VERSION of Apache APISIX is `2.10.3`. Set `APISIX VERSION` in [install by source package](# Install by source package) to `2.10.3` and follow the other steps.
+The [current LTS version](https://apisix.apache.org/downloads/) of Apache APISIX is `2.10.4`.
-## Step 2: Install ETCD
+To install this version, set `APISIX _VERSION`
Review comment:
```suggestion
To install this version, set `APISIX_VERSION`
```
--
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
[GitHub] [apisix] yzeng25 commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r812586327
##########
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:
OK cool. We can skip this comment.
--
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
[GitHub] [apisix] navendu-pottekkat commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r812601005
##########
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.
Review comment:
Isn't the current change already capturing that intent of the guide?
--
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
[GitHub] [apisix] Anita-ihuman commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
Anita-ihuman commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r812316328
##########
File path: docs/en/latest/getting-started.md
##########
@@ -70,11 +74,13 @@ curl --location --request GET "http://httpbin.org/get?foo1=bar1&foo2=bar2"
}
```
-## Pre-requisites
+## Pre-Requisites
+
+Before you jump head, make sure that you have your machine setup with these tools.
Review comment:
ahead
--
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
[GitHub] [apisix] navendu-pottekkat commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r812581366
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -65,38 +67,40 @@ sudo yum clean all && yum makecache
sudo yum install -y --downloadonly --downloaddir=./apisix apisix
```
-Copy `./apisix` folder to the target host, run the following command to install Apache APISIX.
+Then copy `./apisix` folder to the target host and run the following command to install.
```shell
sudo yum install ./apisix/*.rpm
```
### Installation via Docker
-Please refer to: [Installing Apache APISIX with Docker](https://hub.docker.com/r/apache/apisix).
+Please refer to [Installing Apache APISIX with Docker](https://hub.docker.com/r/apache/apisix).
### Installation via Helm Chart
-Please refer to: [Installing Apache APISIX with Helm Chart](https://github.com/apache/apisix-helm-chart).
+Please refer to [Installing Apache APISIX with Helm Chart](https://github.com/apache/apisix-helm-chart).
### Installation via Source Release Package
+Follow the steps below to install Apache APISIX via the source release package.
+
1. Create a directory named `apisix-2.12.0`.
```shell
APISIX_VERSION='2.12.0'
mkdir apisix-${APISIX_VERSION}
```
-2. Download Apache APISIX Release source package.
+2. Download the [Apache APISIX source release package](https://downloads.apache.org/apisix/APISIX_VERSION/apache-apisix-APISIX_VERSION-src.tgz).
```shell
wget https://downloads.apache.org/apisix/${APISIX_VERSION}/apache-apisix-${APISIX_VERSION}-src.tgz
```
- You can also download the Apache APISIX Release source package from the Apache APISIX website. The [Apache APISIX Official Website - Download Page](https://apisix.apache.org/downloads/) also provides source packages for Apache APISIX, APISIX Dashboard and APISIX Ingress Controller.
+ You can also download the Apache APISIX source release package from the [Apache APISIX website](https://apisix.apache.org/downloads/). The website also provides source packages for Apache APISIX, APISIX Dashboard and APISIX Ingress Controller.
Review comment:
Ah, the Oxford comma!
--
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811576984
##########
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:
**on** looks more appropiate.
--
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811582905
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -65,38 +67,40 @@ sudo yum clean all && yum makecache
sudo yum install -y --downloadonly --downloaddir=./apisix apisix
```
-Copy `./apisix` folder to the target host, run the following command to install Apache APISIX.
+Then copy `./apisix` folder to the target host and run the following command to install.
```shell
sudo yum install ./apisix/*.rpm
```
### Installation via Docker
-Please refer to: [Installing Apache APISIX with Docker](https://hub.docker.com/r/apache/apisix).
+Please refer to [Installing Apache APISIX with Docker](https://hub.docker.com/r/apache/apisix).
### Installation via Helm Chart
-Please refer to: [Installing Apache APISIX with Helm Chart](https://github.com/apache/apisix-helm-chart).
+Please refer to [Installing Apache APISIX with Helm Chart](https://github.com/apache/apisix-helm-chart).
### Installation via Source Release Package
+Follow the steps below to install Apache APISIX via the source release package.
+
1. Create a directory named `apisix-2.12.0`.
```shell
APISIX_VERSION='2.12.0'
mkdir apisix-${APISIX_VERSION}
```
-2. Download Apache APISIX Release source package.
+2. Download the [Apache APISIX source release package](https://downloads.apache.org/apisix/APISIX_VERSION/apache-apisix-APISIX_VERSION-src.tgz).
```shell
wget https://downloads.apache.org/apisix/${APISIX_VERSION}/apache-apisix-${APISIX_VERSION}-src.tgz
```
- You can also download the Apache APISIX Release source package from the Apache APISIX website. The [Apache APISIX Official Website - Download Page](https://apisix.apache.org/downloads/) also provides source packages for Apache APISIX, APISIX Dashboard and APISIX Ingress Controller.
+ You can also download the Apache APISIX source release package from the [Apache APISIX website](https://apisix.apache.org/downloads/). The website also provides source packages for Apache APISIX, APISIX Dashboard and APISIX Ingress Controller.
Review comment:
```suggestion
You can also download the Apache APISIX source release package from the [Apache APISIX website](https://apisix.apache.org/downloads/). The website also provides source packages for Apache APISIX, APISIX Dashboard, and APISIX Ingress Controller.
```
--
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
[GitHub] [apisix] avinal commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r811578546
##########
File path: docs/en/latest/getting-started.md
##########
@@ -183,7 +191,7 @@ curl "http://127.0.0.1:9080/apisix/admin/upstreams/1" -H "X-API-KEY: edd1c9f0343
}'
```
-We use `roundrobin` as the load balancing mechanism, and set `httpbin.org:80` as our upstream target (Upstream service) with an ID of `1`. For more information on the fields, see [Admin API](./admin-api.md).
+We use `roundrobin` as the load balancing mechanism, and set `httpbin.org:80` as our Upstream service with an ID of `1`. See [Admin API](./admin-api.md) for more information about the fields.
Review comment:
```suggestion
We use `roundrobin` as the load balancing mechanism and set `httpbin.org:80` as our Upstream service with an ID of `1`. See [Admin API](./admin-api.md) for more information about the fields.
```
--
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
[GitHub] [apisix] navendu-pottekkat commented on a change in pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on a change in pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#discussion_r812580426
##########
File path: docs/en/latest/getting-started.md
##########
@@ -155,23 +161,25 @@ curl "http://127.0.0.1:9080/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f034335f
}'
```
-This routing configuration means that all matching inbound requests will be forwarded to the Upstream service `httpbin.org:80` when they meet **all** the rules listed below:
+This configuration basically means that it will forward all matching inbound requests to the upstream service (`httpbin.org:80`) if they meet these specified criterions.
Review comment:
criteria --> criterion in plural?
--
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
[GitHub] [apisix] avinal commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
avinal commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1051099033
> @juzhiyuan Is that triggered by a new release of the website repo?
Yes, all the commits are only reflected in a new release.
--
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
[GitHub] [apisix] spacewander commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
spacewander commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1046400270
Wow, thanks for taking care of that. I just request two members who have edited these docs before to review it.
--
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
[GitHub] [apisix] juzhiyuan commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1050839487
> @juzhiyuan Do we need to make a release to update the docs? I have made changes in 3 PRs across this repo and the website repo but the changes are not reflected yet. Is there a workflow that needs to be triggered?
This PR's changes will be shown in the next version: https://apisix.apache.org/docs/apisix/next/getting-started
--
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
[GitHub] [apisix] navendu-pottekkat commented on pull request #6389: docs: update "getting started" and "how to build" guides
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on pull request #6389:
URL: https://github.com/apache/apisix/pull/6389#issuecomment-1050527612
@juzhiyuan Do we need to make a release to update the docs? I have made changes in 3 PRs across this repo and the website repo but the changes are not reflected yet. Is there a workflow that needs to be triggered?
--
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