You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by ju...@apache.org on 2020/10/23 08:11:52 UTC
[apisix-dashboard] branch master updated: feat: docs improvment
(#592)
This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-dashboard.git
The following commit(s) were added to refs/heads/master by this push:
new dd4cfd5 feat: docs improvment (#592)
dd4cfd5 is described below
commit dd4cfd580b6d9b07d63a5cc6e467026c94ac46c4
Author: 琚致远 <ju...@apache.org>
AuthorDate: Fri Oct 23 16:11:42 2020 +0800
feat: docs improvment (#592)
* feat: update action's name
* feat: update action's name
* feat: remove unused files
* feat: update template's typo
* feat: update PR template
* feat: prettier lint
* feat(docs): added USER_GUIDE in Chinese
* feat(docs): update user guide
* feat(docs): added some features
* feat: added changelog in Chinese
* feat(docs): added License
* feat(docs): update README
* feat(docs): update typo
* feat(docs): remove tip
* feat(docs): adjust files folder
* feat(docs): adjust files folder
* feat(docs): remove extra space
* feat: update action's name
* feat(doc): update some incompatible cases
* feat(docs): added sh flag
* Update deploy.zh-CN.md
---
.github/ISSUE_TEMPLATE | 2 +-
.github/PULL_REQUEST_TEMPLATE | 2 +-
.github/workflows/api_ci.yml | 62 -----------
.github/workflows/api_cicd.yml | 70 -------------
.github/workflows/deploy-api.yml | 70 +++++++++++++
.../workflows/{deploy.yml => deploy-frontend.yml} | 2 +-
.../{license_ci.yml => license-checker.yml} | 2 +-
.github/workflows/test-api.yml | 61 +++++++++++
.../{api_newci.yml => test-deploy-with-go.yml} | 12 ++-
...d.yml => test-frontend-multiple-node-build.yml} | 8 +-
USER_GUIDE.md => CHANGELOG.zh-CN.md | 41 ++++----
README.md | 99 +++---------------
README.zh-CN.md | 115 ++++-----------------
api/internal/core/store/test_case.json | 2 +-
I18N_USER_GUIDE.md => docs/I18N_USER_GUIDE.md | 0
USER_GUIDE.md => docs/USER_GUIDE.md | 0
USER_GUIDE.md => docs/USER_GUIDE.zh-CN.md | 18 ++--
README.md => docs/deploy.md | 49 +--------
README.zh-CN.md => docs/deploy.zh-CN.md | 65 ++----------
.github/apisix-config.yaml => docs/develop.md | 32 ++++--
.../apisix-config.yaml => docs/develop.zh-CN.md | 35 +++++--
{images => docs/images}/manager-api.png | Bin
{images => docs/images}/metrics-cn.png | Bin
{images => docs/images}/metrics-en.png | Bin
.../images}/route-create-done-list-cn.png | Bin
.../images}/route-create-done-list-en.png | Bin
{images => docs/images}/route-create-step1-cn.png | Bin
{images => docs/images}/route-create-step1-en.png | Bin
{images => docs/images}/route-create-step2-cn.png | Bin
{images => docs/images}/route-create-step2-en.png | Bin
{images => docs/images}/route-create-step3-cn.png | Bin
{images => docs/images}/route-create-step3-en.png | Bin
{images => docs/images}/route-create-step4-cn.png | Bin
{images => docs/images}/route-create-step4-en.png | Bin
{images => docs/images}/route-list-en.png | Bin
{images => docs/images}/setting-cn.png | Bin
{images => docs/images}/setting-en.png | Bin
{images => docs/images}/ssl-list-cn.png | Bin
{images => docs/images}/ssl-list-en.png | Bin
39 files changed, 270 insertions(+), 477 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE
index 07703b5..b3c0269 100644
--- a/.github/ISSUE_TEMPLATE
+++ b/.github/ISSUE_TEMPLATE
@@ -19,5 +19,5 @@ ___
If possible, provide a way to reproduce the error.
___
-### Requirement or improvement
+### Requirements or improvement
- Please describe your requirements or improvement suggestions.
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
index d4051d9..37c9ccb 100644
--- a/.github/PULL_REQUEST_TEMPLATE
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -1,7 +1,7 @@
Please answer these questions before submitting a pull request
- Why submit this pull request?
-- [ ] Bug fix
+- [ ] Bugfix
- [ ] New feature provided
- [ ] Improve performance
diff --git a/.github/workflows/api_ci.yml b/.github/workflows/api_ci.yml
deleted file mode 100644
index a5b42f4..0000000
--- a/.github/workflows/api_ci.yml
+++ /dev/null
@@ -1,62 +0,0 @@
-name: API CI
-
-on:
- push:
- branches:
- - master
- pull_request:
- branches:
- - master
-
-jobs:
-
- run-test:
- runs-on: ubuntu-latest
-
- services:
- etcd:
- image: bitnami/etcd:3.4.13
- ports:
- - 2379:2379
- - 2380:2380
- env:
- ALLOW_NONE_AUTHENTICATION: yes
-
- steps:
- - uses: actions/checkout@v2
-
- - name: run Makefile
- run: |
- make license-check
-
- - name: get lua lib
- run: |
- wget https://github.com/api7/dag-to-lua/archive/v1.1.tar.gz
- sudo mkdir -p /go/manager-api/dag-to-lua/
- tar -zxvf v1.1.tar.gz
- sudo mv ./dag-to-lua-1.1/lib/* /go/manager-api/dag-to-lua/
-
- - name: install runtime
- run: |
- sudo apt-get update
- sudo apt-get install lua5.1
- sudo add-apt-repository ppa:longsleep/golang-backports
- sudo apt update
- export GO111MOUDULE=on
- sudo apt install golang-1.14-go
-
- - name: generate json schema
- working-directory: ./api
- run: |
- wget https://github.com/apache/apisix/archive/master.zip
- mkdir -p ./build-tools/apisix/
- unzip master.zip
- sudo mv ./apisix-master/apisix/* ./build-tools/apisix/
- rm -rf ./apisix-master
- cd ./build-tools/ && lua schema-sync.lua > ../conf/schema.json
-
- - name: run test
- working-directory: ./api
- run: |
- export APIX_ETCD_ENDPOINTS=127.0.0.1:2379
- go test ./...
diff --git a/.github/workflows/api_cicd.yml b/.github/workflows/api_cicd.yml
deleted file mode 100644
index d45d853..0000000
--- a/.github/workflows/api_cicd.yml
+++ /dev/null
@@ -1,70 +0,0 @@
-name: API CI && CD
-
-on:
- push:
- branches:
- - master
-
-jobs:
- build:
- runs-on: ubuntu-latest
-
- services:
- etcd:
- image: bitnami/etcd:3.3.13-r80
- ports:
- - 2379:2379
- - 2380:2380
- env:
- ALLOW_NONE_AUTHENTICATION: yes
-
- steps:
- - uses: actions/checkout@v2
-
- - name: license check
- run: |
- make license-check
-
- - name: get lua lib
- run: |
- wget https://github.com/api7/dag-to-lua/archive/v1.1.tar.gz
- sudo mkdir -p /go/manager-api/dag-to-lua/
- tar -zxvf v1.1.tar.gz
- sudo mv ./dag-to-lua-1.1/lib/* /go/manager-api/dag-to-lua/
-
- - name: install runtime
- run: |
- sudo apt-get update
- sudo apt-get install lua5.1
- sudo add-apt-repository ppa:longsleep/golang-backports
- sudo apt update
- export GO111MOUDULE=on
- sudo apt install golang-1.14-go
-
- - name: generate json schema
- working-directory: ./api
- run: |
- wget https://github.com/apache/apisix/archive/master.zip
- mkdir -p ./build-tools/apisix/
- unzip master.zip
- sudo mv ./apisix-master/apisix/* ./build-tools/apisix/
- rm -rf ./apisix-master
- cd ./build-tools/ && lua schema-sync.lua > ../conf/schema.json
-
- - name: run test
- working-directory: ./api
- run: |
- export APIX_ETCD_ENDPOINTS=127.0.0.1:2379
- go test ./...
-
- - uses: Azure/docker-login@v1
- with:
- login-server: apisixacr.azurecr.cn
- username: ${{ secrets.REGISTRY_USERNAME }}
- password: ${{ secrets.REGISTRY_PASSWORD }}
-
- - name: build and push docker image
- working-directory: ./api
- run: |
- docker build . -t apisixacr.azurecr.cn/managerapi:${{ github.sha }}
- docker push apisixacr.azurecr.cn/managerapi:${{ github.sha }}
\ No newline at end of file
diff --git a/.github/workflows/deploy-api.yml b/.github/workflows/deploy-api.yml
new file mode 100644
index 0000000..d996e52
--- /dev/null
+++ b/.github/workflows/deploy-api.yml
@@ -0,0 +1,70 @@
+name: Deploy API to Azure
+
+on:
+ push:
+ branches:
+ - master
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ services:
+ etcd:
+ image: bitnami/etcd:3.3.13-r80
+ ports:
+ - 2379:2379
+ - 2380:2380
+ env:
+ ALLOW_NONE_AUTHENTICATION: yes
+
+ steps:
+ - uses: actions/checkout@v2
+
+ - name: license check
+ run: |
+ make license-check
+
+ - name: get lua lib
+ run: |
+ wget https://github.com/api7/dag-to-lua/archive/v1.1.tar.gz
+ sudo mkdir -p /go/manager-api/dag-to-lua/
+ tar -zxvf v1.1.tar.gz
+ sudo mv ./dag-to-lua-1.1/lib/* /go/manager-api/dag-to-lua/
+
+ - name: install runtime
+ run: |
+ sudo apt-get update
+ sudo apt-get install lua5.1
+ sudo add-apt-repository ppa:longsleep/golang-backports
+ sudo apt update
+ export GO111MOUDULE=on
+ sudo apt install golang-1.14-go
+
+ - name: generate json schema
+ working-directory: ./api
+ run: |
+ wget https://github.com/apache/apisix/archive/master.zip
+ mkdir -p ./build-tools/apisix/
+ unzip master.zip
+ sudo mv ./apisix-master/apisix/* ./build-tools/apisix/
+ rm -rf ./apisix-master
+ cd ./build-tools/ && lua schema-sync.lua > ../conf/schema.json
+
+ - name: run test
+ working-directory: ./api
+ run: |
+ export APIX_ETCD_ENDPOINTS=127.0.0.1:2379
+ go test ./...
+
+ - uses: Azure/docker-login@v1
+ with:
+ login-server: apisixacr.azurecr.cn
+ username: ${{ secrets.REGISTRY_USERNAME }}
+ password: ${{ secrets.REGISTRY_PASSWORD }}
+
+ - name: build and push docker image
+ working-directory: ./api
+ run: |
+ docker build . -t apisixacr.azurecr.cn/managerapi:${{ github.sha }}
+ docker push apisixacr.azurecr.cn/managerapi:${{ github.sha }}
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy-frontend.yml
similarity index 94%
rename from .github/workflows/deploy.yml
rename to .github/workflows/deploy-frontend.yml
index cb6c978..9998d50 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy-frontend.yml
@@ -1,4 +1,4 @@
-name: Deploy to Azure
+name: Deploy frontend to Azure
on:
push:
diff --git a/.github/workflows/license_ci.yml b/.github/workflows/license-checker.yml
similarity index 92%
rename from .github/workflows/license_ci.yml
rename to .github/workflows/license-checker.yml
index 412be05..09b2cba 100644
--- a/.github/workflows/license_ci.yml
+++ b/.github/workflows/license-checker.yml
@@ -1,4 +1,4 @@
-name: LICENSE CI
+name: License checker
on:
push:
diff --git a/.github/workflows/test-api.yml b/.github/workflows/test-api.yml
new file mode 100644
index 0000000..386c52d
--- /dev/null
+++ b/.github/workflows/test-api.yml
@@ -0,0 +1,61 @@
+name: Test API
+
+on:
+ push:
+ branches:
+ - master
+ pull_request:
+ branches:
+ - master
+
+jobs:
+ run-test:
+ runs-on: ubuntu-latest
+
+ services:
+ etcd:
+ image: bitnami/etcd:3.4.13
+ ports:
+ - 2379:2379
+ - 2380:2380
+ env:
+ ALLOW_NONE_AUTHENTICATION: yes
+
+ steps:
+ - uses: actions/checkout@v2
+
+ - name: run Makefile
+ run: |
+ make license-check
+
+ - name: get lua lib
+ run: |
+ wget https://github.com/api7/dag-to-lua/archive/v1.1.tar.gz
+ sudo mkdir -p /go/manager-api/dag-to-lua/
+ tar -zxvf v1.1.tar.gz
+ sudo mv ./dag-to-lua-1.1/lib/* /go/manager-api/dag-to-lua/
+
+ - name: install runtime
+ run: |
+ sudo apt-get update
+ sudo apt-get install lua5.1
+ sudo add-apt-repository ppa:longsleep/golang-backports
+ sudo apt update
+ export GO111MOUDULE=on
+ sudo apt install golang-1.14-go
+
+ - name: generate json schema
+ working-directory: ./api
+ run: |
+ wget https://github.com/apache/apisix/archive/master.zip
+ mkdir -p ./build-tools/apisix/
+ unzip master.zip
+ sudo mv ./apisix-master/apisix/* ./build-tools/apisix/
+ rm -rf ./apisix-master
+ cd ./build-tools/ && lua schema-sync.lua > ../conf/schema.json
+
+ - name: run test
+ working-directory: ./api
+ run: |
+ export APIX_ETCD_ENDPOINTS=127.0.0.1:2379
+ go test ./...
diff --git a/.github/workflows/api_newci.yml b/.github/workflows/test-deploy-with-go.yml
similarity index 93%
rename from .github/workflows/api_newci.yml
rename to .github/workflows/test-deploy-with-go.yml
index ce59db7..59fefbb 100644
--- a/.github/workflows/api_newci.yml
+++ b/.github/workflows/test-deploy-with-go.yml
@@ -1,10 +1,12 @@
-name: NewCI
+name: Test deploy frontend and API using Go
on:
push:
- branches: [ master ]
+ branches:
+ - master
pull_request:
- branches: [ master ]
+ branches:
+ - master
jobs:
frontend:
@@ -30,11 +32,11 @@ jobs:
name: dist
path: ./dist/
- backend:
+ backend:
name: Back-End compile
needs: frontend
runs-on: ubuntu-latest
-
+
steps:
- uses: actions/checkout@v2
diff --git a/.github/workflows/multiple-node-build.yml b/.github/workflows/test-frontend-multiple-node-build.yml
similarity index 90%
rename from .github/workflows/multiple-node-build.yml
rename to .github/workflows/test-frontend-multiple-node-build.yml
index e713e1d..b631398 100644
--- a/.github/workflows/multiple-node-build.yml
+++ b/.github/workflows/test-frontend-multiple-node-build.yml
@@ -1,14 +1,16 @@
# This is a basic test to build the dashboard
-name: multiple-node-build
+name: Test building frontend in multiple node version
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
- branches: [master]
+ branches:
+ - master
pull_request:
- branches: [master]
+ branches:
+ - master
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
diff --git a/USER_GUIDE.md b/CHANGELOG.zh-CN.md
similarity index 51%
copy from USER_GUIDE.md
copy to CHANGELOG.zh-CN.md
index ed2aaa3..774e199 100644
--- a/USER_GUIDE.md
+++ b/CHANGELOG.zh-CN.md
@@ -17,36 +17,31 @@
#
-->
-# User Guide
+# 目录
-Please visit [http://139.217.190.60/](http://139.217.190.60/) in browser to have a full-preview of the Apache APISIX Dashboard.
+- [1.5.0](#150)
+- [1.0.0](#100)
-The following are parts of the modules' snapshot.
+# 1.5.0
-## Metrics
+该版本主要完成 Dashboard 的重构工作。
-
+### 核心
-## Route
+- 使用 Ant Design Pro 作为项目脚手架 [#263](https://github.com/apache/apisix-dashboard/pull/263)。
+- 增加了 manager-api 用于处理 APISIX 与 Dashboard 之间的逻辑。
+- 增加了监控、路由、证书、上游、Consumer 模块。
-The Route module aims to control routes by UI instead of calling APIs.
+## 1.0.0
-### List
+该版本主要增加了基本控制台并解决协议问题。
-
+### Core
-### Create
+- 初始化 Dashboard。 [#1](https://github.com/apache/apisix-dashboard/pull/1)
+- 解决 License 问题。
+- 从脚手架内移除无用文件。
+- 为各个模块增加查询列表、创建、编辑、删除功能。
+- 增加了自定义配置插件表单。
-
-
-
-
-
-
-
-
-
-
-## Setting
-
-
+[返回](#table-of-contents)
diff --git a/README.md b/README.md
index 745be50..ff68f39 100644
--- a/README.md
+++ b/README.md
@@ -21,106 +21,35 @@ English | [简体中文](./README.zh-CN.md)
# Apache APISIX Dashboard
-_Please Note: This branch is still under development, please DO NOT use this branch currently._
-
Dashboard for [Apache APISIX](https://github.com/apache/apisix)
[Online Demo](http://139.217.190.60/), Username/Password: `admin`.
## User Guide
-Please refer to [User Guide](./USER_GUIDE.md)
-
-## Deploy with Docker
-
-Please refer to [Deploy with Docker README](./compose/README.md)
-
-## Deploy Manually
-
-### Clone the project
-
-```sh
-$ git clone https://github.com/apache/apisix-dashboard.git
-
-$ cd apisix-dashboard
-```
-
-### Build the manager-api
-
-The `manager-api` is used to provide APIs for Dashboard, just like a bridge between the Apache APISIX and the Dashboard. Here are the steps to build it manually:
-
-1. We need `Go` 1.13+ and `Lua` 5.1+ to be preinstalled.
-
-2. Check environment variables
-
-- enable Go MODULE
-
-```sh
-$ go env -w GO111MODULE=on
-```
-
-- According to your local deployment environment, check the environment variables in `./api/run.sh`, modify the environment variables if needed.
-For example, change the ETCD endpoints to your ETCD instances work with APISIX:
+Please refer to [User Guide](./docs/USER_GUIDE.md)
-```
-export APIX_ETCD_ENDPOINTS="127.0.0.1:2379"
-```
+## Deployment
-If you have multiple instances, please use commas to separate:
+- [Deploy Manually](./docs/deploy.md)
+- [Deploy with Docker](./compose/README.md)
-```
-export APIX_ETCD_ENDPOINTS="127.0.0.1:2379,127.0.0.1:3379"
-```
-
-- For most users in China, we could use [Goproxy](https://goproxy.cn/) to speed up downloading modules.
-
-```sh
-$ go env -w GOPROXY=https://goproxy.cn,direct
-```
-
-3. Build and Run
-
-```sh
-$ ./api/run.sh &
-```
-
-
-### Build the Dashboard
-
-This project is initialized with [Ant Design Pro](https://pro.ant.design). The following are some quick guides for how to use.
-
-1. Make sure you have `Node.js(version 10.0.0+)/Nginx` installed on your machine.
-2. Install [yarn](https://yarnpkg.com/).
-3. Install dependencies:
-
-```sh
-$ yarn install
-```
-
-4. Build
-
-```sh
-$ yarn build
-```
+## Development
-5. The bundled files are under `/dist` folder if the step 4 is successful, then we recommend using `nginx` to handle those files, please install `nginx` manually, then refer to the nginx conf `compose/dashboard_conf/nginx.conf`.
-6. Move files under `dist` folder to nginx's default html folder, then visit `http://127.0.0.1` in your browser.
+- [Apache APISIX](https://github.com/apache/apisix)
+- [Dashboard](./docs/develop.md)
-## Development
+## Milestones
-1. Make sure you have `Node.js(version 8.10.0+)/Nginx` installed on your machine.
-2. Install [yarn](https://yarnpkg.com/).
-3. Install dependencies:
-4. If we want to modify the API, please refer to the `config/proxy.ts` file.
+- [2.0](https://github.com/apache/apisix-dashboard/milestone/4)
+- [2.1](https://github.com/apache/apisix-dashboard/milestone/5)
-```sh
-$ yarn install
+## Contributing
-$ yarn start
-```
+See [CONTRIBUTING](./CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
-## Other
+## FAQ
1. If you need the dashboard-1.0 which is built with Vue.js, please refer to [master-vue](https://github.com/apache/apisix-dashboard/tree/master-vue).
-2. More information about the new dashboard and manager-api please refer to [here](./manager-api.md)
+2. The dashboard 2.0 removes MySQL which [dashboard 1.5](https://github.com/apache/apisix-dashboard/tree/backup-1.5-latest) is relied on.
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 7772595..9b24761 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -19,117 +19,38 @@
[English](./README.md) | 简体中文
-# Apache APISIX 仪表盘
+# [Apache APISIX](https://github.com/apache/apisix) 控制台
-_注意：当前分支仍在开发中，当前请勿使用。_
-
-[Apache APISIX](https://github.com/apache/apisix-dashboard) 的仪表盘
-
-[在线演示](http://139.217.190.60/)，账户密码：`admin`。
+访问 [http://139.217.190.60/](http://139.217.190.60/) 查看在线预览，账户与密码：`admin`。
## 用户指南
-请参考 [用户指南](./USER_GUIDE.md)
-
-## 使用 Docker 部署
-
-请参考 [使用 Docker 部署](./compose/README.md)
-
-## 手动部署
-
-### 克隆项目
-
-```sh
-$ git clone https://github.com/apache/apisix-dashboard.git
-
-$ cd apisix-dashboard
-```
-
-### 生成 manager-api
-
-`manager-api` 用于为仪表盘提供接口，就像 Apache APISIX 和仪表盘之间的桥梁。下面是手动构建步骤：
-
-1. 需要预先安装 `Go` 1.13+ 、`Lua` 5.1+
-
-2. 检查环境变量
-
-- 开启 Go MODULE
-
-```sh
-$ go env -w GO111MODULE=on
-```
-
-- 根据您的本地部署环境，检查 `./api/run.sh` 中的环境变量，如果需要请修改环境变量。
-例如, 把 ETCD 地址改为你的与 APISIX 一起工作的 ETCD 实例:
-
-```
-export APIX_ETCD_ENDPOINTS="127.0.0.1:2379"
-```
+请参考 [用户指南](./docs/USER_GUIDE.zh-CN.md)
-如果有多个实例，请使用英文逗号分隔，如：
+## 部署
-```
-export APIX_ETCD_ENDPOINTS="127.0.0.1:2379,127.0.0.1:3379"
-```
+当前支持如下方式部署：
-- 对于大多数中国用户，我们可以使用 [Goproxy](https://goproxy.cn/) 加快模块下载速度。
-
-```sh
-$ go env -w GOPROXY=https://goproxy.cn,direct
-```
-
-3. 构建并启动
-
-```sh
-$ ./api/run.sh &
-```
-
-### 构建仪表盘
-
-该项目使用 [Ant Design Pro](https://pro.ant.design) 初始化。以下是一些使用方法的快速指南。
-
-1. 确保你的设备已经安装了 `Node.js(version 10.0.0+)/Nginx`。
-
-2. 安装 [yarn](https://yarnpkg.com/)。
-
-3. 安装依赖:
-
-```sh
-$ yarn install
-```
-
-4. 构建
-
-```sh
-$ yarn build
-```
-
-5. 如果第 4 步成功的话，那么构建后的文件在 `/dist` 目录下，接着我们推荐使用 `nginx` 处理这些文件，请手动安装 `nginx` 并参考 `compose/dashboard_conf/nginx.conf` 配置。
-
-6. 移动 `dist` 目录下的文件到 nginx 的默认 html 目录，然后在浏览器中访问 `http://127.0.0.1`。
+- [手动部署](./docs/deploy.zh-CN.md)
+- [使用 Docker 部署](./compose/README.md)
## 开发
-1. 确保你的设备已经安装了 `Node.js(version 8.10.0+)/Nginx`。
-
-2. 安装 [yarn](https://yarnpkg.com/)。
-
-3. 安装依赖:
+开发分为 Apache APISIX 开发、Dashboard 开发
-```sh
-$ yarn install
-```
+- [Apache APISIX](https://github.com/apache/apisix)
+- [Dashboard](./docs/develop.zh-CN.md)
-4. 如果我们想要修改 API，请参考 `config/proxy.ts` 文件。
+## 里程碑
-```sh
-$ yarn install
+- [2.0](https://github.com/apache/apisix-dashboard/milestone/4)
+- [2.1](https://github.com/apache/apisix-dashboard/milestone/5)
-$ yarn start
-```
+## 贡献
-## 其他
+请参考[贡献指南](./CONTRIBUTING.md)以获取更详细的流程。
-1. 如果你需要 Vue.js 构建的 dashboard-1.0，请参考 [master-vue](https://github.com/apache/apisix-dashboard/tree/master-vue)。
+## FAQ
-2. 关于新版仪表盘和 manager-api 的更多信息请参阅 [这里](./manager-api.md)
+1. 如果你需要 Vue.js 构建的 dashboard-1.0，请使用 [master-vue 分支](https://github.com/apache/apisix-dashboard/tree/master-vue)。
+2. 2.0 版本的控制台移除了[1.5 版本](https://github.com/apache/apisix-dashboard/tree/backup-1.5-latest)中的 MySQL，将直接操作 etcd。
diff --git a/api/internal/core/store/test_case.json b/api/internal/core/store/test_case.json
index 77f524b..950edf3 100644
--- a/api/internal/core/store/test_case.json
+++ b/api/internal/core/store/test_case.json
@@ -2,7 +2,7 @@
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
- "name": {
+ "name": {
"type": "string",
"minLength": 10
},
diff --git a/I18N_USER_GUIDE.md b/docs/I18N_USER_GUIDE.md
similarity index 100%
rename from I18N_USER_GUIDE.md
rename to docs/I18N_USER_GUIDE.md
diff --git a/USER_GUIDE.md b/docs/USER_GUIDE.md
similarity index 100%
copy from USER_GUIDE.md
copy to docs/USER_GUIDE.md
diff --git a/USER_GUIDE.md b/docs/USER_GUIDE.zh-CN.md
similarity index 79%
rename from USER_GUIDE.md
rename to docs/USER_GUIDE.zh-CN.md
index ed2aaa3..b5fe02f 100644
--- a/USER_GUIDE.md
+++ b/docs/USER_GUIDE.zh-CN.md
@@ -17,25 +17,23 @@
#
-->
-# User Guide
+# 用户指南
-Please visit [http://139.217.190.60/](http://139.217.190.60/) in browser to have a full-preview of the Apache APISIX Dashboard.
+请在浏览器内访问[http://139.217.190.60/](http://139.217.190.60/)以预览 Apache APISIX 的控制台。如下是部分模块的截图：
-The following are parts of the modules' snapshot.
-
-## Metrics
+## 监控
-## Route
+## 路由
-The Route module aims to control routes by UI instead of calling APIs.
+路由模块用于通过界面控制路由，以取代手动调用 API。
-### List
+### 路由列表
-### Create
+### 创建路由
@@ -47,6 +45,6 @@ The Route module aims to control routes by UI instead of calling APIs.
-## Setting
+## 设置
diff --git a/README.md b/docs/deploy.md
similarity index 66%
copy from README.md
copy to docs/deploy.md
index 745be50..41deb47 100644
--- a/README.md
+++ b/docs/deploy.md
@@ -17,27 +17,9 @@
#
-->
-English | [简体中文](./README.zh-CN.md)
+# Deploy manually
-# Apache APISIX Dashboard
-
-_Please Note: This branch is still under development, please DO NOT use this branch currently._
-
-Dashboard for [Apache APISIX](https://github.com/apache/apisix)
-
-[Online Demo](http://139.217.190.60/), Username/Password: `admin`.
-
-## User Guide
-
-Please refer to [User Guide](./USER_GUIDE.md)
-
-## Deploy with Docker
-
-Please refer to [Deploy with Docker README](./compose/README.md)
-
-## Deploy Manually
-
-### Clone the project
+## Clone the project
```sh
$ git clone https://github.com/apache/apisix-dashboard.git
@@ -45,7 +27,7 @@ $ git clone https://github.com/apache/apisix-dashboard.git
$ cd apisix-dashboard
```
-### Build the manager-api
+## Build the manager-api
The `manager-api` is used to provide APIs for Dashboard, just like a bridge between the Apache APISIX and the Dashboard. Here are the steps to build it manually:
@@ -59,8 +41,7 @@ The `manager-api` is used to provide APIs for Dashboard, just like a bridge betw
$ go env -w GO111MODULE=on
```
-- According to your local deployment environment, check the environment variables in `./api/run.sh`, modify the environment variables if needed.
-For example, change the ETCD endpoints to your ETCD instances work with APISIX:
+- According to your local deployment environment, check the environment variables in `./api/run.sh`, modify the environment variables if needed. For example, change the ETCD endpoints to your ETCD instances work with APISIX:
```
export APIX_ETCD_ENDPOINTS="127.0.0.1:2379"
@@ -84,8 +65,7 @@ $ go env -w GOPROXY=https://goproxy.cn,direct
$ ./api/run.sh &
```
-
-### Build the Dashboard
+## Build the frontend
This project is initialized with [Ant Design Pro](https://pro.ant.design). The following are some quick guides for how to use.
@@ -105,22 +85,3 @@ $ yarn build
5. The bundled files are under `/dist` folder if the step 4 is successful, then we recommend using `nginx` to handle those files, please install `nginx` manually, then refer to the nginx conf `compose/dashboard_conf/nginx.conf`.
6. Move files under `dist` folder to nginx's default html folder, then visit `http://127.0.0.1` in your browser.
-
-## Development
-
-1. Make sure you have `Node.js(version 8.10.0+)/Nginx` installed on your machine.
-2. Install [yarn](https://yarnpkg.com/).
-3. Install dependencies:
-4. If we want to modify the API, please refer to the `config/proxy.ts` file.
-
-```sh
-$ yarn install
-
-$ yarn start
-```
-
-## Other
-
-1. If you need the dashboard-1.0 which is built with Vue.js, please refer to [master-vue](https://github.com/apache/apisix-dashboard/tree/master-vue).
-
-2. More information about the new dashboard and manager-api please refer to [here](./manager-api.md)
diff --git a/README.zh-CN.md b/docs/deploy.zh-CN.md
similarity index 59%
copy from README.zh-CN.md
copy to docs/deploy.zh-CN.md
index 7772595..ceeefc4 100644
--- a/README.zh-CN.md
+++ b/docs/deploy.zh-CN.md
@@ -17,27 +17,9 @@
#
-->
-[English](./README.md) | 简体中文
+# 手动部署
-# Apache APISIX 仪表盘
-
-_注意：当前分支仍在开发中，当前请勿使用。_
-
-[Apache APISIX](https://github.com/apache/apisix-dashboard) 的仪表盘
-
-[在线演示](http://139.217.190.60/)，账户密码：`admin`。
-
-## 用户指南
-
-请参考 [用户指南](./USER_GUIDE.md)
-
-## 使用 Docker 部署
-
-请参考 [使用 Docker 部署](./compose/README.md)
-
-## 手动部署
-
-### 克隆项目
+## 克隆项目
```sh
$ git clone https://github.com/apache/apisix-dashboard.git
@@ -45,9 +27,9 @@ $ git clone https://github.com/apache/apisix-dashboard.git
$ cd apisix-dashboard
```
-### 生成 manager-api
+## 构建 manager-api
-`manager-api` 用于为仪表盘提供接口，就像 Apache APISIX 和仪表盘之间的桥梁。下面是手动构建步骤：
+`manager-api` 用于为控制台提供接口，就像 Apache APISIX 和控制台之间的桥梁。下面是手动构建步骤：
1. 需要预先安装 `Go` 1.13+ 、`Lua` 5.1+
@@ -59,17 +41,16 @@ $ cd apisix-dashboard
$ go env -w GO111MODULE=on
```
-- 根据您的本地部署环境，检查 `./api/run.sh` 中的环境变量，如果需要请修改环境变量。
-例如, 把 ETCD 地址改为你的与 APISIX 一起工作的 ETCD 实例:
+- 根据您的本地部署环境，检查 `./api/run.sh` 中的环境变量，如果需要请修改环境变量。例如, 把 ETCD 地址改为你的与 APISIX 一起工作的 ETCD 实例:
-```
-export APIX_ETCD_ENDPOINTS="127.0.0.1:2379"
+```sh
+$ export APIX_ETCD_ENDPOINTS="127.0.0.1:2379"
```
如果有多个实例，请使用英文逗号分隔，如：
-```
-export APIX_ETCD_ENDPOINTS="127.0.0.1:2379,127.0.0.1:3379"
+```sh
+$ export APIX_ETCD_ENDPOINTS="127.0.0.1:2379,127.0.0.1:3379"
```
- 对于大多数中国用户，我们可以使用 [Goproxy](https://goproxy.cn/) 加快模块下载速度。
@@ -84,7 +65,7 @@ $ go env -w GOPROXY=https://goproxy.cn,direct
$ ./api/run.sh &
```
-### 构建仪表盘
+## 构建前端
该项目使用 [Ant Design Pro](https://pro.ant.design) 初始化。以下是一些使用方法的快速指南。
@@ -107,29 +88,3 @@ $ yarn build
5. 如果第 4 步成功的话，那么构建后的文件在 `/dist` 目录下，接着我们推荐使用 `nginx` 处理这些文件，请手动安装 `nginx` 并参考 `compose/dashboard_conf/nginx.conf` 配置。
6. 移动 `dist` 目录下的文件到 nginx 的默认 html 目录，然后在浏览器中访问 `http://127.0.0.1`。
-
-## 开发
-
-1. 确保你的设备已经安装了 `Node.js(version 8.10.0+)/Nginx`。
-
-2. 安装 [yarn](https://yarnpkg.com/)。
-
-3. 安装依赖:
-
-```sh
-$ yarn install
-```
-
-4. 如果我们想要修改 API，请参考 `config/proxy.ts` 文件。
-
-```sh
-$ yarn install
-
-$ yarn start
-```
-
-## 其他
-
-1. 如果你需要 Vue.js 构建的 dashboard-1.0，请参考 [master-vue](https://github.com/apache/apisix-dashboard/tree/master-vue)。
-
-2. 关于新版仪表盘和 manager-api 的更多信息请参阅 [这里](./manager-api.md)
diff --git a/.github/apisix-config.yaml b/docs/develop.md
similarity index 67%
copy from .github/apisix-config.yaml
copy to docs/develop.md
index fcb7843..2a6385c 100644
--- a/.github/apisix-config.yaml
+++ b/docs/develop.md
@@ -1,3 +1,4 @@
+<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
@@ -14,14 +15,27 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
-# If you want to set the specified configuration value, you can set the new
-# in this file. For example if you want to specify the etcd address:
-#
+-->
+
+# Dashboard Devlopment
+
+## Frontend
+
+1. Make sure you have `Node.js(version version 10.0.0+)` installed on your machine.
+2. Install [yarn](https://yarnpkg.com/).
+3. Install dependencies:
+
+```sh
+$ yarn install
+```
+
+4. If we want to modify the API, please refer to the `config/proxy.ts` file.
+5. Start the development mode
+
+```sh
+$ yarn start
+```
-etcd:
- host:
- - 'http://etcd:2379'
+## manager-api
-apisix:
- allow_admin: # http://nginx.org/en/docs/http/ngx_http_access_module.html#allow
- - 0.0.0.0/0 # If we don't set any IP list, then any IP access is allowed by default.
+TODO
diff --git a/.github/apisix-config.yaml b/docs/develop.zh-CN.md
similarity index 68%
rename from .github/apisix-config.yaml
rename to docs/develop.zh-CN.md
index fcb7843..4f73094 100644
--- a/.github/apisix-config.yaml
+++ b/docs/develop.zh-CN.md
@@ -1,3 +1,4 @@
+<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
@@ -14,14 +15,30 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
-# If you want to set the specified configuration value, you can set the new
-# in this file. For example if you want to specify the etcd address:
-#
+-->
+
+# Dashboard 开发
+
+## 前端开发
+
+1. 确保你的设备已经安装了 `Node.js(version version 10.0.0+)`。
+
+2. 安装 [yarn](https://yarnpkg.com/)。
+
+3. 安装依赖:
+
+```sh
+$ yarn install
+```
+
+4. 若需要修改 manager-api 地址，请访问 `config/proxy.ts` 文件。
+
+5. 启动开发模式
+
+```sh
+$ yarn start
+```
-etcd:
- host:
- - 'http://etcd:2379'
+## manager-api 开发
-apisix:
- allow_admin: # http://nginx.org/en/docs/http/ngx_http_access_module.html#allow
- - 0.0.0.0/0 # If we don't set any IP list, then any IP access is allowed by default.
+待补充
diff --git a/images/manager-api.png b/docs/images/manager-api.png
similarity index 100%
rename from images/manager-api.png
rename to docs/images/manager-api.png
diff --git a/images/metrics-cn.png b/docs/images/metrics-cn.png
similarity index 100%
rename from images/metrics-cn.png
rename to docs/images/metrics-cn.png
diff --git a/images/metrics-en.png b/docs/images/metrics-en.png
similarity index 100%
rename from images/metrics-en.png
rename to docs/images/metrics-en.png
diff --git a/images/route-create-done-list-cn.png b/docs/images/route-create-done-list-cn.png
similarity index 100%
rename from images/route-create-done-list-cn.png
rename to docs/images/route-create-done-list-cn.png
diff --git a/images/route-create-done-list-en.png b/docs/images/route-create-done-list-en.png
similarity index 100%
rename from images/route-create-done-list-en.png
rename to docs/images/route-create-done-list-en.png
diff --git a/images/route-create-step1-cn.png b/docs/images/route-create-step1-cn.png
similarity index 100%
rename from images/route-create-step1-cn.png
rename to docs/images/route-create-step1-cn.png
diff --git a/images/route-create-step1-en.png b/docs/images/route-create-step1-en.png
similarity index 100%
rename from images/route-create-step1-en.png
rename to docs/images/route-create-step1-en.png
diff --git a/images/route-create-step2-cn.png b/docs/images/route-create-step2-cn.png
similarity index 100%
rename from images/route-create-step2-cn.png
rename to docs/images/route-create-step2-cn.png
diff --git a/images/route-create-step2-en.png b/docs/images/route-create-step2-en.png
similarity index 100%
rename from images/route-create-step2-en.png
rename to docs/images/route-create-step2-en.png
diff --git a/images/route-create-step3-cn.png b/docs/images/route-create-step3-cn.png
similarity index 100%
rename from images/route-create-step3-cn.png
rename to docs/images/route-create-step3-cn.png
diff --git a/images/route-create-step3-en.png b/docs/images/route-create-step3-en.png
similarity index 100%
rename from images/route-create-step3-en.png
rename to docs/images/route-create-step3-en.png
diff --git a/images/route-create-step4-cn.png b/docs/images/route-create-step4-cn.png
similarity index 100%
rename from images/route-create-step4-cn.png
rename to docs/images/route-create-step4-cn.png
diff --git a/images/route-create-step4-en.png b/docs/images/route-create-step4-en.png
similarity index 100%
rename from images/route-create-step4-en.png
rename to docs/images/route-create-step4-en.png
diff --git a/images/route-list-en.png b/docs/images/route-list-en.png
similarity index 100%
rename from images/route-list-en.png
rename to docs/images/route-list-en.png
diff --git a/images/setting-cn.png b/docs/images/setting-cn.png
similarity index 100%
rename from images/setting-cn.png
rename to docs/images/setting-cn.png
diff --git a/images/setting-en.png b/docs/images/setting-en.png
similarity index 100%
rename from images/setting-en.png
rename to docs/images/setting-en.png
diff --git a/images/ssl-list-cn.png b/docs/images/ssl-list-cn.png
similarity index 100%
rename from images/ssl-list-cn.png
rename to docs/images/ssl-list-cn.png
diff --git a/images/ssl-list-en.png b/docs/images/ssl-list-en.png
similarity index 100%
rename from images/ssl-list-en.png
rename to docs/images/ssl-list-en.png