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 2021/06/30 03:33:49 UTC
[GitHub] [apisix] spacewander opened a new pull request #4505: docs: don't repeat the same doc in the README
spacewander opened a new pull request #4505:
URL: https://github.com/apache/apisix/pull/4505
Signed-off-by: spacewander <sp...@gmail.com>
### 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. -->
### Pre-submission checklist:
* [x] Did you explain what problem does this PR solve? Or what new features have been added?
* [ ] Have you added corresponding test cases?
* [x] Have you modified the corresponding document?
* [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
--
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] Yiyiyimu commented on a change in pull request #4505: docs: don't repeat the same doc in the README
Posted by GitBox <gi...@apache.org>.
Yiyiyimu commented on a change in pull request #4505:
URL: https://github.com/apache/apisix/pull/4505#discussion_r661838123
##########
File path: README.md
##########
@@ -141,95 +141,14 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
## Get Started
-### Configure and Installation
+1. Installation
APISIX Installed and tested in the following systems:
CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubuntu 18.04
-There are several ways to install the Apache Release version of APISIX:
-
-1. Source code compilation (applicable to all systems)
-
- - Installation runtime dependencies: OpenResty and etcd, and compilation dependencies: luarocks. Refer to [install dependencies documentation](docs/en/latest/install-dependencies.md)
- - Download the latest source code release package:
-
- ```shell
- $ mkdir apisix-2.7
- $ wget https://downloads.apache.org/apisix/2.7/apache-apisix-2.7-src.tgz
- $ tar zxvf apache-apisix-2.7-src.tgz -C apisix-2.7
- ```
-
- - Install the dependencies：
-
- ```shell
- $ make deps
- ```
-
- - check version of APISIX:
-
- ```shell
- $ ./bin/apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ ./bin/apisix start
- ```
-
-2. [Docker image](https://hub.docker.com/r/apache/apisix) （applicable to all systems）
-
- By default, the latest Apache release package will be pulled:
-
- ```shell
- $ docker pull apache/apisix
- ```
-
- The Docker image does not include `etcd`; you can refer to [docker compose example](https://github.com/apache/apisix-docker/tree/master/example) to start a test cluster.
-
-3. RPM package（only for CentOS 7）
-
- - Installation runtime dependencies: OpenResty, etcd and OpenSSL develop library, refer to [install dependencies documentation](docs/en/latest/install-dependencies.md#centos-7)
- - install APISIX：
-
- ```shell
- $ sudo yum install -y https://github.com/apache/apisix/releases/download/2.7/apisix-2.7-0.x86_64.rpm
- ```
-
- - check the version of APISIX:
-
- ```shell
- $ apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ apisix start
- ```
-
-**Note**: Apache APISIX would not support the v2 protocol of etcd anymore since APISIX v2.0, and the minimum etcd version supported is v3.4.0. Please update etcd when needed. If you need to migrate your data from etcd v2 to v3, please follow [etcd migration guide](https://etcd.io/docs/v3.4.0/op-guide/v2-migration/).
-
-### For Developer
-
-1. For developers, you can use the latest master branch to experience more features
-
- - build from source code
-
- ```shell
- $ git clone git@github.com:apache/apisix.git
- $ cd apisix
- $ make deps
- ```
-
- - Docker image
-
- ```shell
- $ git clone https://github.com/apache/apisix-docker.git
- $ cd apisix-docker
- $ sudo docker build -f alpine-dev/Dockerfile .
- ```
+There are several ways to install the Apache Release version of APISIX.
Review comment:
Remove since this line give no information here
--
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 #4505: docs: don't repeat the same doc in the README
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #4505:
URL: https://github.com/apache/apisix/pull/4505#discussion_r661898723
##########
File path: README.md
##########
@@ -141,95 +141,14 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
## Get Started
-### Configure and Installation
+1. Installation
APISIX Installed and tested in the following systems:
CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubuntu 18.04
-There are several ways to install the Apache Release version of APISIX:
-
-1. Source code compilation (applicable to all systems)
-
- - Installation runtime dependencies: OpenResty and etcd, and compilation dependencies: luarocks. Refer to [install dependencies documentation](docs/en/latest/install-dependencies.md)
- - Download the latest source code release package:
-
- ```shell
- $ mkdir apisix-2.7
- $ wget https://downloads.apache.org/apisix/2.7/apache-apisix-2.7-src.tgz
- $ tar zxvf apache-apisix-2.7-src.tgz -C apisix-2.7
- ```
-
- - Install the dependencies：
-
- ```shell
- $ make deps
- ```
-
- - check version of APISIX:
-
- ```shell
- $ ./bin/apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ ./bin/apisix start
- ```
-
-2. [Docker image](https://hub.docker.com/r/apache/apisix) （applicable to all systems）
-
- By default, the latest Apache release package will be pulled:
-
- ```shell
- $ docker pull apache/apisix
- ```
-
- The Docker image does not include `etcd`; you can refer to [docker compose example](https://github.com/apache/apisix-docker/tree/master/example) to start a test cluster.
-
-3. RPM package（only for CentOS 7）
-
- - Installation runtime dependencies: OpenResty, etcd and OpenSSL develop library, refer to [install dependencies documentation](docs/en/latest/install-dependencies.md#centos-7)
- - install APISIX：
-
- ```shell
- $ sudo yum install -y https://github.com/apache/apisix/releases/download/2.7/apisix-2.7-0.x86_64.rpm
- ```
-
- - check the version of APISIX:
-
- ```shell
- $ apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ apisix start
- ```
-
-**Note**: Apache APISIX would not support the v2 protocol of etcd anymore since APISIX v2.0, and the minimum etcd version supported is v3.4.0. Please update etcd when needed. If you need to migrate your data from etcd v2 to v3, please follow [etcd migration guide](https://etcd.io/docs/v3.4.0/op-guide/v2-migration/).
-
-### For Developer
-
-1. For developers, you can use the latest master branch to experience more features
-
- - build from source code
-
- ```shell
- $ git clone git@github.com:apache/apisix.git
- $ cd apisix
- $ make deps
- ```
-
- - Docker image
-
- ```shell
- $ git clone https://github.com/apache/apisix-docker.git
- $ cd apisix-docker
- $ sudo docker build -f alpine-dev/Dockerfile .
- ```
+There are several ways to install the Apache Release version of APISIX.
+Please refer to [install documentation](docs/en/latest/how-to-build.md).
Review comment:
What 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] Yiyiyimu commented on a change in pull request #4505: docs: don't repeat the same doc in the README
Posted by GitBox <gi...@apache.org>.
Yiyiyimu commented on a change in pull request #4505:
URL: https://github.com/apache/apisix/pull/4505#discussion_r661838123
##########
File path: README.md
##########
@@ -141,95 +141,14 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
## Get Started
-### Configure and Installation
+1. Installation
APISIX Installed and tested in the following systems:
CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubuntu 18.04
-There are several ways to install the Apache Release version of APISIX:
-
-1. Source code compilation (applicable to all systems)
-
- - Installation runtime dependencies: OpenResty and etcd, and compilation dependencies: luarocks. Refer to [install dependencies documentation](docs/en/latest/install-dependencies.md)
- - Download the latest source code release package:
-
- ```shell
- $ mkdir apisix-2.7
- $ wget https://downloads.apache.org/apisix/2.7/apache-apisix-2.7-src.tgz
- $ tar zxvf apache-apisix-2.7-src.tgz -C apisix-2.7
- ```
-
- - Install the dependencies：
-
- ```shell
- $ make deps
- ```
-
- - check version of APISIX:
-
- ```shell
- $ ./bin/apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ ./bin/apisix start
- ```
-
-2. [Docker image](https://hub.docker.com/r/apache/apisix) （applicable to all systems）
-
- By default, the latest Apache release package will be pulled:
-
- ```shell
- $ docker pull apache/apisix
- ```
-
- The Docker image does not include `etcd`; you can refer to [docker compose example](https://github.com/apache/apisix-docker/tree/master/example) to start a test cluster.
-
-3. RPM package（only for CentOS 7）
-
- - Installation runtime dependencies: OpenResty, etcd and OpenSSL develop library, refer to [install dependencies documentation](docs/en/latest/install-dependencies.md#centos-7)
- - install APISIX：
-
- ```shell
- $ sudo yum install -y https://github.com/apache/apisix/releases/download/2.7/apisix-2.7-0.x86_64.rpm
- ```
-
- - check the version of APISIX:
-
- ```shell
- $ apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ apisix start
- ```
-
-**Note**: Apache APISIX would not support the v2 protocol of etcd anymore since APISIX v2.0, and the minimum etcd version supported is v3.4.0. Please update etcd when needed. If you need to migrate your data from etcd v2 to v3, please follow [etcd migration guide](https://etcd.io/docs/v3.4.0/op-guide/v2-migration/).
-
-### For Developer
-
-1. For developers, you can use the latest master branch to experience more features
-
- - build from source code
-
- ```shell
- $ git clone git@github.com:apache/apisix.git
- $ cd apisix
- $ make deps
- ```
-
- - Docker image
-
- ```shell
- $ git clone https://github.com/apache/apisix-docker.git
- $ cd apisix-docker
- $ sudo docker build -f alpine-dev/Dockerfile .
- ```
+There are several ways to install the Apache Release version of APISIX.
Review comment:
Could remove since this line give no information here
--
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 merged pull request #4505: docs: don't repeat the same doc in the README
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #4505:
URL: https://github.com/apache/apisix/pull/4505
--
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] Yiyiyimu commented on a change in pull request #4505: docs: don't repeat the same doc in the README
Posted by GitBox <gi...@apache.org>.
Yiyiyimu commented on a change in pull request #4505:
URL: https://github.com/apache/apisix/pull/4505#discussion_r661922030
##########
File path: README.md
##########
@@ -141,95 +141,14 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
## Get Started
-### Configure and Installation
+1. Installation
APISIX Installed and tested in the following systems:
CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubuntu 18.04
-There are several ways to install the Apache Release version of APISIX:
-
-1. Source code compilation (applicable to all systems)
-
- - Installation runtime dependencies: OpenResty and etcd, and compilation dependencies: luarocks. Refer to [install dependencies documentation](docs/en/latest/install-dependencies.md)
- - Download the latest source code release package:
-
- ```shell
- $ mkdir apisix-2.7
- $ wget https://downloads.apache.org/apisix/2.7/apache-apisix-2.7-src.tgz
- $ tar zxvf apache-apisix-2.7-src.tgz -C apisix-2.7
- ```
-
- - Install the dependencies：
-
- ```shell
- $ make deps
- ```
-
- - check version of APISIX:
-
- ```shell
- $ ./bin/apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ ./bin/apisix start
- ```
-
-2. [Docker image](https://hub.docker.com/r/apache/apisix) （applicable to all systems）
-
- By default, the latest Apache release package will be pulled:
-
- ```shell
- $ docker pull apache/apisix
- ```
-
- The Docker image does not include `etcd`; you can refer to [docker compose example](https://github.com/apache/apisix-docker/tree/master/example) to start a test cluster.
-
-3. RPM package（only for CentOS 7）
-
- - Installation runtime dependencies: OpenResty, etcd and OpenSSL develop library, refer to [install dependencies documentation](docs/en/latest/install-dependencies.md#centos-7)
- - install APISIX：
-
- ```shell
- $ sudo yum install -y https://github.com/apache/apisix/releases/download/2.7/apisix-2.7-0.x86_64.rpm
- ```
-
- - check the version of APISIX:
-
- ```shell
- $ apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ apisix start
- ```
-
-**Note**: Apache APISIX would not support the v2 protocol of etcd anymore since APISIX v2.0, and the minimum etcd version supported is v3.4.0. Please update etcd when needed. If you need to migrate your data from etcd v2 to v3, please follow [etcd migration guide](https://etcd.io/docs/v3.4.0/op-guide/v2-migration/).
-
-### For Developer
-
-1. For developers, you can use the latest master branch to experience more features
-
- - build from source code
-
- ```shell
- $ git clone git@github.com:apache/apisix.git
- $ cd apisix
- $ make deps
- ```
-
- - Docker image
-
- ```shell
- $ git clone https://github.com/apache/apisix-docker.git
- $ cd apisix-docker
- $ sudo docker build -f alpine-dev/Dockerfile .
- ```
+There are several ways to install the Apache Release version of APISIX.
+Please refer to [install documentation](docs/en/latest/how-to-build.md).
Review comment:
My bad, no steps need to be moved. Failed to check carefully
--
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] Yiyiyimu commented on a change in pull request #4505: docs: don't repeat the same doc in the README
Posted by GitBox <gi...@apache.org>.
Yiyiyimu commented on a change in pull request #4505:
URL: https://github.com/apache/apisix/pull/4505#discussion_r661838927
##########
File path: README.md
##########
@@ -141,95 +141,14 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
## Get Started
-### Configure and Installation
+1. Installation
APISIX Installed and tested in the following systems:
CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubuntu 18.04
-There are several ways to install the Apache Release version of APISIX:
-
-1. Source code compilation (applicable to all systems)
-
- - Installation runtime dependencies: OpenResty and etcd, and compilation dependencies: luarocks. Refer to [install dependencies documentation](docs/en/latest/install-dependencies.md)
- - Download the latest source code release package:
-
- ```shell
- $ mkdir apisix-2.7
- $ wget https://downloads.apache.org/apisix/2.7/apache-apisix-2.7-src.tgz
- $ tar zxvf apache-apisix-2.7-src.tgz -C apisix-2.7
- ```
-
- - Install the dependencies：
-
- ```shell
- $ make deps
- ```
-
- - check version of APISIX:
-
- ```shell
- $ ./bin/apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ ./bin/apisix start
- ```
-
-2. [Docker image](https://hub.docker.com/r/apache/apisix) （applicable to all systems）
-
- By default, the latest Apache release package will be pulled:
-
- ```shell
- $ docker pull apache/apisix
- ```
-
- The Docker image does not include `etcd`; you can refer to [docker compose example](https://github.com/apache/apisix-docker/tree/master/example) to start a test cluster.
-
-3. RPM package（only for CentOS 7）
-
- - Installation runtime dependencies: OpenResty, etcd and OpenSSL develop library, refer to [install dependencies documentation](docs/en/latest/install-dependencies.md#centos-7)
- - install APISIX：
-
- ```shell
- $ sudo yum install -y https://github.com/apache/apisix/releases/download/2.7/apisix-2.7-0.x86_64.rpm
- ```
-
- - check the version of APISIX:
-
- ```shell
- $ apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ apisix start
- ```
-
-**Note**: Apache APISIX would not support the v2 protocol of etcd anymore since APISIX v2.0, and the minimum etcd version supported is v3.4.0. Please update etcd when needed. If you need to migrate your data from etcd v2 to v3, please follow [etcd migration guide](https://etcd.io/docs/v3.4.0/op-guide/v2-migration/).
-
-### For Developer
-
-1. For developers, you can use the latest master branch to experience more features
-
- - build from source code
-
- ```shell
- $ git clone git@github.com:apache/apisix.git
- $ cd apisix
- $ make deps
- ```
-
- - Docker image
-
- ```shell
- $ git clone https://github.com/apache/apisix-docker.git
- $ cd apisix-docker
- $ sudo docker build -f alpine-dev/Dockerfile .
- ```
+There are several ways to install the Apache Release version of APISIX.
+Please refer to [install documentation](docs/en/latest/how-to-build.md).
Review comment:
We might need to move some docs from here to `how-to-build`, since `how-to-build` present less specific steps compared to here.
--
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 #4505: docs: don't repeat the same doc in the README
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #4505:
URL: https://github.com/apache/apisix/pull/4505#discussion_r661929328
##########
File path: README.md
##########
@@ -141,95 +141,14 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
## Get Started
-### Configure and Installation
+1. Installation
APISIX Installed and tested in the following systems:
CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubuntu 18.04
-There are several ways to install the Apache Release version of APISIX:
-
-1. Source code compilation (applicable to all systems)
-
- - Installation runtime dependencies: OpenResty and etcd, and compilation dependencies: luarocks. Refer to [install dependencies documentation](docs/en/latest/install-dependencies.md)
- - Download the latest source code release package:
-
- ```shell
- $ mkdir apisix-2.7
- $ wget https://downloads.apache.org/apisix/2.7/apache-apisix-2.7-src.tgz
- $ tar zxvf apache-apisix-2.7-src.tgz -C apisix-2.7
- ```
-
- - Install the dependencies：
-
- ```shell
- $ make deps
- ```
-
- - check version of APISIX:
-
- ```shell
- $ ./bin/apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ ./bin/apisix start
- ```
-
-2. [Docker image](https://hub.docker.com/r/apache/apisix) （applicable to all systems）
-
- By default, the latest Apache release package will be pulled:
-
- ```shell
- $ docker pull apache/apisix
- ```
-
- The Docker image does not include `etcd`; you can refer to [docker compose example](https://github.com/apache/apisix-docker/tree/master/example) to start a test cluster.
-
-3. RPM package（only for CentOS 7）
-
- - Installation runtime dependencies: OpenResty, etcd and OpenSSL develop library, refer to [install dependencies documentation](docs/en/latest/install-dependencies.md#centos-7)
- - install APISIX：
-
- ```shell
- $ sudo yum install -y https://github.com/apache/apisix/releases/download/2.7/apisix-2.7-0.x86_64.rpm
- ```
-
- - check the version of APISIX:
-
- ```shell
- $ apisix version
- ```
-
- - start APISIX:
-
- ```shell
- $ apisix start
- ```
-
-**Note**: Apache APISIX would not support the v2 protocol of etcd anymore since APISIX v2.0, and the minimum etcd version supported is v3.4.0. Please update etcd when needed. If you need to migrate your data from etcd v2 to v3, please follow [etcd migration guide](https://etcd.io/docs/v3.4.0/op-guide/v2-migration/).
-
-### For Developer
-
-1. For developers, you can use the latest master branch to experience more features
-
- - build from source code
-
- ```shell
- $ git clone git@github.com:apache/apisix.git
- $ cd apisix
- $ make deps
- ```
-
- - Docker image
-
- ```shell
- $ git clone https://github.com/apache/apisix-docker.git
- $ cd apisix-docker
- $ sudo docker build -f alpine-dev/Dockerfile .
- ```
+There are several ways to install the Apache Release version of APISIX.
Review comment:
Updated.
--
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