doc: added new doc README.md in folder doc. (#699)

* doc: added new doc `README.md` in `doc` folder, and add more doc link to `README.md`.

Author: membphis

README.md

@@ -8,12 +8,11 @@
 - [![Gitter](https://badges.gitter.im/apisix/community.svg)](https://gitter.im/apisix/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 - [![Twitter](https://img.shields.io/twitter/follow/apisixfast.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=apisixfast)
 
-## What's APISIX?
-
 APISIX is a cloud-native microservices API gateway, delivering the ultimate performance, security, open source and scalable platform for all your APIs and microservices.
 
 APISIX is based on OpenResty and etcd. Compared with traditional API gateways, APISIX has dynamic routing and plug-in hot loading, which is especially suitable for API management under micro-service system.
 
+[Installation](#Installation) | [Documentation](doc/README.md) | [Development ENV](#development-manual-of-apisix) | [FAQ](FAQ.md)
 
 ## Why APISIX?
 
@@ -69,7 +68,7 @@ For more detailed information, see the [White Paper](https://www.iresty.com/down
 ## Online Demo Dashboard
 We provide an online dashboard [demo version](http://apisix.iresty.com)， make it easier for you to understand APISIX.
 
-## Install
+## Installation
 
 APISIX Installed and tested in the following systems, and the version of OpenResty MUST >= 1.15.8.1:
 
@@ -161,7 +160,7 @@ sudo apisix start
 Limit count plugin is a good start to try APISIX,
 you can follow the [documentation of limit count](doc/plugins/limit-count.md).
 
-Then you can try more [plugins](doc/plugins.md).
+Then you can try more [plugins](doc/README.md#plugins).
 
 ## Dashboard
 
@@ -211,10 +210,6 @@ If your concerns are not among them, please submit issue to communicate with us.
 
 See [CONTRIBUTING](Contributing.md) for details on submitting patches and the contribution workflow.
 
-## Reference document
-
-See more document, please take look at [Reference document](doc/doc-index.md).
-
 ## Acknowledgments
 
 inspired by Kong and Orange.

README_CN.md

@@ -7,12 +7,12 @@
 - **QQ 交流群**: 552030619
 - [![Gitter](https://badges.gitter.im/apisix/community.svg)](https://gitter.im/apisix/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
-## 什么是 APISIX？
-
 APISIX 是一个云原生、高性能、可扩展的微服务 API 网关。
 
 它是基于 OpenResty 和 etcd 来实现，和传统 API 网关相比，APISIX 具备动态路由和插件热加载，特别适合微服务体系下的 API 管理。
 
+[安装](#安装) | [文档](doc/README_CN.md) | [开发环境](#开发环境) | [FAQ](FAQ.md)
+
 ## 为什么选择 APISIX？
 
 如果你正在构建网站、移动设备或 IoT（物联网）的应用，那么你可能需要使用 API 网关来处理接口流量。
@@ -34,7 +34,7 @@ APISIX 通过插件机制，提供动态负载平衡、身份验证、限流限
 - **[SSL](doc/https-cn.md)**：动态加载 SSL 证书。
 - **HTTP(S) 反向代理**
 - **[健康检查](doc/health-check.md)**：启用上游节点的健康检查，将在负载均衡期间自动过滤不健康的节点，以确保系统稳定性。
-- **熔断器**: 智能跟踪不健康上游服务.
+- **熔断器**: 智能跟踪不健康上游服务。
 - **身份认证**: [key-auth](doc/plugins/key-auth-cn.md), [JWT](doc/plugins/jwt-auth-cn.md)。
 - **[限制速率](doc/plugins/limit-req-cn.md)**
 - **[限制请求数](doc/plugins/limit-count-cn.md)**
@@ -140,7 +140,7 @@ sudo sh install.sh
 
 ## 开发环境
 
-如果你是一个开发者，可以从 [开发文档](doc/dev-manual-cn.md) 中获取搭建开发环境和运行测试案例的步骤.
+如果你是一个开发者，可以从 [开发文档](doc/dev-manual-cn.md) 中获取搭建开发环境和运行测试案例的步骤。
 
 ## 快速上手
 
@@ -154,9 +154,9 @@ sudo apisix start
 
 2. 测试限流插件
 
-你可以测试限流插件，来上手体验 APISIX，按照[限流插件文档](doc/plugins/limit-count-cn.md)的步骤即可.
+你可以测试限流插件，来上手体验 APISIX，按照[限流插件文档](doc/plugins/limit-count-cn.md)的步骤即可。
 
-更进一步，你可以跟着文档来尝试更多的[插件](doc/plugins-cn.md).
+更进一步，你可以跟着文档来尝试更多的[插件](doc/README_CN.md#插件)。
 
 ## 控制台
 APISIX 内置了 dashboard，使用浏览器打开 `http://127.0.0.1:9080/apisix/dashboard/` 即可使用，

doc/README.md

@@ -0,0 +1,37 @@
+[中文](README_CN.md)
+
+Reference document
+==================
+
+* [APISIX Readme](../README.md)
+* [Architecture Design](architecture-design.md)
+* [Benchmark](benchmark.md)
+* [Build development ENV](dev-manual.md)
+* [Install Dependencies](install-dependencies.md): How to install dependencies for different OS.
+* [Health Check](health-check.md): Enable health check on the upstream node, and will automatically filter unhealthy nodes during load balancing to ensure system stability.
+* Router
+    * [radixtree](router-radixtree.md)
+* [Stand Alone Model](stand-alone.md): Supports to load route rules from local yaml file, it is more friendly such as under the kubernetes(k8s).
+* [Stream Proxy](stream-proxy.md)
+* [Admin API](admin-api-cn.md)
+* [Changelog](../CHANGELOG.md)
+* [Code Style](../CODE_STYLE.md)
+* [FAQ](../FAQ.md)
+
+Plugins
+=======
+
+* [hot reload](plugins.md): Hot reload without reload service.
+* [key-auth](plugins/key-auth.md): User authentication based on Key Authentication.
+* [JWT-auth](plugins/jwt-auth-cn.md): User authentication based on [JWT](https://jwt.io/) (JSON Web Tokens) Authentication.
+* [HTTPS/TLS](https.md): Dynamic load the SSL Certificate by Server Name Indication (SNI).
+* [limit-count](plugins/limit-count.md): Rate limiting based on a "fixed window" implementation.
+* [limit-req](plugins/limit-req.md): Request rate limiting and adjustment based on the "leaky bucket" method.
+* [limit-conn](plugins/limit-conn.md): Limite request concurrency (or concurrent connections).
+* [proxy-rewrite](plugins/proxy-rewrite.md): Rewrite upstream request information.
+* [prometheus](plugins/prometheus.md): Expose metrics related to APISIX and proxied upstream services in Prometheus exposition format, which can be scraped by a Prometheus Server.
+* [OpenTracing](plugins/zipkin.md): Supports Zikpin and Apache SkyWalking.
+* [grpc-transcode](plugins/grpc-transcoding.md): REST <--> gRPC transcoding。
+* [serverless](plugins/serverless-cn.md)：AllowS to dynamically run Lua code at *different* phase in APISIX.
+* [ip-restriction](plugins/ip-restriction.md): IP whitelist/blacklist.
+* openid-connect

doc/README_CN.md

@@ -0,0 +1,38 @@
+[English](README.md)
+
+Reference document
+==================
+
+* [APISIX 说明](../README_CN.md)
+* [架构设计](architecture-design-cn.md)
+* [压力测试](benchmark-cn.md)
+* [搭建开发环境](dev-manua-cnl.md)
+* [安装依赖](install-dependencies.md): How to install dependencies for different OS.
+* [健康检查](health-check.md): Enable health check on the upstream node, and will automatically filter unhealthy nodes during load balancing to ensure system stability.
+* Router(路由)
+    * [radixtree](router-radixtree.md)
+    * [r3](router-r3.md)
+* [独立运行模型](stand-alone-cn.md): Supports to load route rules from local yaml file, it is more friendly such as under the kubernetes(k8s).
+* [TCP/UDP 动态代理](stream-proxy-cn.md)
+* [管理 API](admin-api-cn.md)
+* [变更日志](../CHANGELOG_CN.md)
+* [代码风格](../CODE_STYLE.md)
+* [常见问答](../FAQ_CN.md)
+
+插件
+===
+
+* [插件热加载](plugins-cn.md)：无需重启服务，完成插件热加载或卸载。
+* [HTTPS](https-cn.md)：根据 TLS 扩展字段 SNI(Server Name Indication) 动态加载证书。
+* [动态负载均衡](architecture-design-cn.md#upstream)：跨多个上游服务的动态负载均衡，目前已支持 round-robin 和一致性哈希算法。
+* [key-auth](plugins/key-auth-cn.md)：基于 Key Authentication 的用户认证。
+* [JWT-auth](plugins/jwt-auth-cn.md)：基于 [JWT](https://jwt.io/) (JSON Web Tokens) Authentication 的用户认证。
+* [limit-count](plugins/limit-count-cn.md)：基于“固定窗口”的限速实现。
+* [limit-req](plugins/limit-req-cn.md)：基于漏桶原理的请求限速实现。
+* [limit-conn](plugins/limit-conn-cn.md)：限制并发请求（或并发连接）。
+* [prometheus](plugins/prometheus-cn.md)：以 Prometheus 格式导出 APISIX 自身的状态信息，方便被外部 Prometheus 服务抓取。
+* [OpenTracing](plugins/zipkin-cn.md)：支持 Zikpin 和 Apache SkyWalking。
+* [grpc-transcode](plugins/grpc-transcoding-cn.md)：REST <--> gRPC 转码。
+* [serverless](plugins/serverless-cn.md)：允许在 APISIX 中的不同阶段动态运行 Lua 代码。
+* [ip-restriction](plugins/ip-restriction-cn.md): IP 黑白名单。
+* openid-connect

doc/doc-index.md

@@ -1,22 +1,7 @@
 [English](plugins.md)
-## 插件
-目前已支持这些插件：
 
-* [HTTPS](https.md)：根据 TLS 扩展字段 SNI(Server Name Indication) 动态加载证书。
-* [动态负载均衡](architecture-design-cn.md#upstream)：跨多个上游服务的动态负载均衡，目前已支持 round-robin 和一致性哈希算法。
-* [key-auth](plugins/key-auth-cn.md)：基于 Key Authentication 的用户认证。
-* [JWT-auth](plugins/jwt-auth-cn.md)：基于 [JWT](https://jwt.io/) (JSON Web Tokens) Authentication 的用户认证。
-* [limit-count](plugins/limit-count-cn.md)：基于“固定窗口”的限速实现。
-* [limit-req](plugins/limit-req-cn.md)：基于漏桶原理的请求限速实现。
-* [limit-conn](plugins/limit-conn-cn.md)：限制并发请求（或并发连接）。
-* [prometheus](plugins/prometheus.md)：以 Prometheus 格式导出 APISIX 自身的状态信息，方便被外部 Prometheus 服务抓取。
-* [OpenTracing](plugins/zipkin.md)：支持 Zikpin 和 Apache SkyWalking。
-* [grpc-transcode](plugins/grpc-transcoding-cn.md)：REST <--> gRPC 转码。
-* [serverless](plugins/serverless-cn.md)：允许在 APISIX 中的不同阶段动态运行 Lua 代码。
-* [ip-restriction](plugins/ip-restriction.md): IP 黑白名单。
-* openid-connect
+## 热加载
 
-## 插件热加载
 APISIX 的插件是热加载的，不管你是新增、删除还是修改插件，都不需要重启服务。
 
 只需要通过 admin API 发送一个 HTTP 请求即可：

doc/plugins-cn.md

@@ -1,24 +1,6 @@
 [中文](plugins-cn.md)
 
-## Plugins
-
-Now we support the following plugins:
-
-* [HTTPS](https.md): dynamic load the SSL Certificate by Server Name Indication (SNI).
-* [dynamic load balancing](#Plugins): load balance traffic across multiple upstream services, supports round-robin and consistent hash algorithms.
-* [key-auth](plugins/key-auth.md): user authentication based on Key Authentication.
-* [JWT-auth](plugins/jwt-auth-cn.md): user authentication based on [JWT](https://jwt.io/) (JSON Web Tokens) Authentication.
-* [limit-count](plugins/limit-count.md): rate limiting based on a "fixed window" implementation.
-* [limit-req](plugins/limit-req.md): request rate limiting and adjustment based on the "leaky bucket" method.
-* [limit-conn](plugins/limit-conn.md): limite request concurrency (or concurrent connections).
-* [prometheus](plugins/prometheus.md): expose metrics related to APISIX and proxied upstream services in Prometheus exposition format, which can be scraped by a Prometheus Server.
-* [OpenTracing](plugins/zipkin.md): support Zikpin and Apache SkyWalking.
-* [grpc-transcode](plugins/grpc-transcode-cn.md): REST <--> gRPC transcoding。
-* [serverless](plugins/serverless-cn.md)：allow to dynamically run Lua code at *different* phase in APISIX.
-* [ip-restriction](plugins/ip-restriction.md): IP whitelist/blacklist.
-* openid-connect
-
-## update plugins without reload service
+## Hot reload
 APISIX plug-ins are hot-loaded. No matter you add, delete or modify plug-ins, you don't need to restart the service.
 
 Just send an HTTP request through admin API: