This is an automated email from the ASF dual-hosted git repository.
spacewander pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 858a577 docs: don't repeat the same doc in the README (#4505)
858a577 is described below
commit 858a57715c265c9ff7a292b7c76b591e0237f4bc
Author: 罗泽轩 <[email protected]>
AuthorDate: Thu Jul 1 11:21:17 2021 +0800
docs: don't repeat the same doc in the README (#4505)
Signed-off-by: spacewander <[email protected]>
---
README.md | 95 +++---------------------------------------
docs/en/latest/how-to-build.md | 5 ++-
docs/zh/latest/README.md | 93 +++--------------------------------------
docs/zh/latest/how-to-build.md | 5 ++-
4 files changed, 19 insertions(+), 179 deletions(-)
diff --git a/README.md b/README.md
index d969578..e3d9e42 100644
--- a/README.md
+++ b/README.md
@@ -141,95 +141,13 @@ 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 [email protected]: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 .
- ```
+Please refer to [install documentation](docs/en/latest/how-to-build.md).
2. Getting started
@@ -239,15 +157,14 @@ There are several ways to install the Apache Release
version of APISIX:
3. Admin API
- Apache APISIX provides [REST Admin API](docs/en/latest/admin-api.md) to
dynamic control the Apache APISIX cluster.
+ Apache APISIX provides [REST Admin API](docs/en/latest/admin-api.md) to
dynamically control the Apache APISIX cluster.
4. Plugin development
- You can refer to [plugin development
guide](docs/en/latest/plugin-develop.md), and [sample plugin
`echo`](docs/en/latest/plugins/echo.md) documentation and code implementation.
-
- Please note that Apache APISIX plugins' added, updated, deleted, etc., are
hot-loaded without restarting the service.
+ You can refer to [plugin development
guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s
code implementation.
+ Reading [plugin concept](docs/en/latest/architecture-design/plugin.md)
would help you learn more about the plugin.
-For more documents, please refer to [Apache APISIX Document Index](README.md)
+For more documents, please refer to [Apache APISIX Documentation
site](https://apisix.apache.org/docs/apisix/getting-started/)
## Benchmark
diff --git a/docs/en/latest/how-to-build.md b/docs/en/latest/how-to-build.md
index 1a0533d..6d19ffc 100644
--- a/docs/en/latest/how-to-build.md
+++ b/docs/en/latest/how-to-build.md
@@ -27,9 +27,12 @@ The runtime environment for Apache APISIX requires Nginx and
etcd.
So before installation, please follow the different operating systems [install
Dependencies](install-dependencies.md).
+The Docker / Helm Chart installation may already contain the required Nginx or
etcd.
+Please refer to their own documentations.
+
## 2. Install Apache APISIX
-You can install Apache APISIX in a variety of ways, including source code
packages, Docker, and Luarocks.
+You can install Apache APISIX in a variety of ways, including source code
packages, Docker, and Helm Chart.
### Installation via RPM package (CentOS 7)
diff --git a/docs/zh/latest/README.md b/docs/zh/latest/README.md
index 78fd49f..a151653 100644
--- a/docs/zh/latest/README.md
+++ b/docs/zh/latest/README.md
@@ -144,95 +144,13 @@ A/B 测试、金丝雀发布(灰度发布)、蓝绿部署、限流限速、抵
## 立刻开始
-### 编译和安装
+1. 安装
APISIX 在以下操作系统中可顺利安装并做过测试：
CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64**
Ubuntu 18.04
-有以下几种方式来安装 APISIX 的 Apache Release 版本:
-
-1. 源码编译（适用所有系统）
-
- - 安装运行时依赖：OpenResty 和
etcd，以及编译的依赖：luarocks。参考[依赖安装文档](install-dependencies.md)
- - 下载最新的源码发布包：
-
- ```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
- ```
-
- - 安装运行时依赖的 Lua 库：
-
- ```shell
- $ make deps
- ```
-
- - 检查 APISIX 的版本号：
-
- ```shell
- $ ./bin/apisix version
- ```
-
- - 启动 APISIX:
-
- ```shell
- $ ./bin/apisix start
- ```
-
-2. [Docker 镜像](https://hub.docker.com/r/apache/apisix)（适用所有系统）
-
- 默认会拉取最新的 Apache 发布包：
-
- ```shell
- $ docker pull apache/apisix
- ```
-
- Docker 镜像中并不包含 etcd，你可以参考 [docker compose
的示例](https://github.com/apache/apisix-docker/tree/master/example)来启动一个测试集群。
-
-3. RPM 包（只适用于 CentOS 7）
-
- - 安装依赖：OpenResty, etcd 和 OpenSSL develop
library，参考[依赖安装文档](install-dependencies.md#centos-7)
- - 安装 APISIX：
-
- ```shell
- $ sudo yum install -y
https://github.com/apache/apisix/releases/download/2.7/apisix-2.7-0.x86_64.rpm
- ```
-
- - 检查 APISIX 的版本号：
-
- ```shell
- $ apisix version
- ```
-
- - 启动 APISIX:
-
- ```shell
- $ apisix start
- ```
-
-**注意**：Apache APISIX 从 v2.0 开始不再支持 etcd v2 协议，并且 etcd 最低支持版本为
v3.4.0，如果有需要请进行升级。如果需要将数据迁移至 etcd v3，请按照 [etcd
迁移指南](https://etcd.io/docs/v3.4.0/op-guide/v2-migration/) 进行迁移。
-
-### 针对开发者
-
-1. 对于开发者而言，可以使用最新的 master 分支来体验更多功能
-
- - 源码编译
-
- ```shell
- $ git clone [email protected]:apache/apisix.git
- $ cd apisix
- $ make deps
- ```
-
- - Docker 镜像
-
- ```shell
- $ git clone https://github.com/apache/apisix-docker.git
- $ cd apisix-docker
- $ sudo docker build -f alpine-dev/Dockerfile .
- ```
+请参考[安装文档](./how-to-build.md)。
2. 入门指南
@@ -246,11 +164,10 @@ CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian
10, macOS, **ARM64** Ubun
4. 插件二次开发
- 可以参考[插件开发指南](plugin-develop.md)，以及[示例插件 echo](plugins/echo.md) 的文档和代码实现。
-
- 请注意，Apache APISIX 的插件新增、更新、删除等都是热加载的，不用重启服务。
+ 可以参考[插件开发指南](plugin-develop.md)，以及示例插件 `example-plugin` 的代码实现。
+ 阅读[插件概念](architecture-design/plugin.md) 会帮助你学到更多关于插件的知识。
-更多文档请参考 [Apache APISIX 文档索引](README.md)。
+更多文档请参考 [Apache APISIX
文档站](https://apisix.apache.org/docs/apisix/getting-started/)。
## 性能测试
diff --git a/docs/zh/latest/how-to-build.md b/docs/zh/latest/how-to-build.md
index 83a9e75..3c74de2 100644
--- a/docs/zh/latest/how-to-build.md
+++ b/docs/zh/latest/how-to-build.md
@@ -27,9 +27,12 @@ Apache APISIX 的运行环境需要 Nginx 和 etcd，
所以在安装前，请根据不同的操作系统来[安装依赖](install-dependencies.md)。
+通过 Docker / Helm Chart 安装时可能已经包含了所需的 Nginx 和 etcd。
+请参照各自对应的文档。
+
## 2. 安装 Apache APISIX
-你可以通过源码包、Docker、Luarocks 等多种方式来安装 Apache APISIX。
+你可以通过源码包、Docker、Helm Chart 等多种方式来安装 Apache APISIX。
### 通过 RPM 包安装（CentOS 7）
