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/12/10 11:57:48 UTC
[apisix-dashboard] 01/01: docs: only keep English docs
This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch juzhiyuan/docs-remove-chinese
in repository https://gitbox.apache.org/repos/asf/apisix-dashboard.git
commit 915c6f48fc9122c2251d9514f331ee3c22f665eb
Author: juzhiyuan <ju...@apache.org>
AuthorDate: Thu Dec 10 19:57:28 2020 +0800
docs: only keep English docs
---
CHANGELOG.zh-CN.md | 83 -----------------------------------
README.md | 7 ---
README.zh-CN.md | 95 ----------------------------------------
docs/FAQ.zh-CN.md | 56 -----------------------
docs/USER_GUIDE.zh-CN.md | 52 ----------------------
docs/deploy-with-docker.zh-CN.md | 84 -----------------------------------
docs/deploy.zh-CN.md | 86 ------------------------------------
docs/develop.zh-CN.md | 76 --------------------------------
web/src/e2e/README.zh-CN.md | 41 -----------------
9 files changed, 580 deletions(-)
diff --git a/CHANGELOG.zh-CN.md b/CHANGELOG.zh-CN.md
deleted file mode 100644
index 21bb8f5..0000000
--- a/CHANGELOG.zh-CN.md
+++ /dev/null
@@ -1,83 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-# 目录
-- [2.1.0](#210)
-- [2.0.0](#200)
-- [1.5.0](#150)
-- [1.0.0](#100)
-
-# 2.1.0
-
-该版本主要提升了 manager-api 的 E2E 测试。
-
-### 核心
-
-- 支持优雅退出。[#796](https://github.com/apache/apisix-dashboard/pull/796)
-- 增加了后端 e2e 测试用例。[#810](https://github.com/apache/apisix-dashboard/pull/810)
-
-更多的变动可以参考[里程碑](https://github.com/apache/apisix-dashboard/milestone/7)。
-
-# 2.0.0
-
-该版本主要移除了 MySQL 并增加了 E2E 测试。
-
-### 核心
-
-- 前端根据新的 admin-api 进行重构。
-- 后端移除对 mysql 的依赖。
-- 支持插件编排模式。
-- 制定前端国际化标准。
-- Dashboard 新的部署方式。
-- 增加更多测试用例。
-- 文档增强。
-- 添加后端 E2E 测试例子。
-- 完善 CI 测试。
-- 支持日志保存到本地文件。
-- 优化部署流程。
-- 前端增加 E2E 测试例子。[#619](https://github.com/apache/apisix-dashboard/pull/619)
-- 修复 Prometheus 插件在更新路由时更新错误值的问题。[#666](https://github.com/apache/apisix-dashboard/pull/666)
-- 修复在路由页面中重定向选项选择为 启用HTTPS 时页面显示异常的问题。[#692](https://github.com/apache/apisix-dashboard/pull/692)
-
-
-更多的变动可以参考[里程碑](https://github.com/apache/apisix-dashboard/milestone/4)
-
-# 1.5.0
-
-该版本主要完成 Dashboard 的重构工作。
-
-### 核心
-
-- 使用 Ant Design Pro 作为项目脚手架 [#263](https://github.com/apache/apisix-dashboard/pull/263)。
-- 增加了 manager-api 用于处理 APISIX 与 Dashboard 之间的逻辑。
-- 增加了监控、路由、证书、上游、Consumer 模块。
-
-## 1.0.0
-
-该版本主要增加了基本控制台并解决协议问题。
-
-### Core
-
-- 初始化 Dashboard。 [#1](https://github.com/apache/apisix-dashboard/pull/1)
-- 解决 License 问题。
-- 从脚手架内移除无用文件。
-- 为各个模块增加查询列表、创建、编辑、删除功能。
-- 增加了自定义配置插件表单。
-
-[返回](#table-of-contents)
diff --git a/README.md b/README.md
index ac547bf..254d47f 100644
--- a/README.md
+++ b/README.md
@@ -22,11 +22,6 @@
[](https://github.com/apache/apisix-dashboard/blob/master/LICENSE)
<p align="center">
- <a href="https://github.com/apache/apisix-dashboard">English</a> •
- <a href="https://github.com/apache/apisix-dashboard/blob/master/README.zh-CN.md">中文</a>
-</p>
-
-<p align="center">
<a href="https://apisix.apache.org/">Website</a> •
<a href="https://github.com/apache/apisix/tree/master/doc">Docs</a> •
<a href="https://twitter.com/apacheapisix">Twitter</a>
@@ -49,7 +44,6 @@ Note: Currently the Dashboard does not have complete coverage of Apache APISIX f
```
.
├── CHANGELOG.md
-├── CHANGELOG.zh-CN.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Dockerfile
@@ -57,7 +51,6 @@ Note: Currently the Dashboard does not have complete coverage of Apache APISIX f
├── Makefile
├── NOTICE
├── README.md
-├── README.zh-CN.md
├── api
├── docs
├── licenses
diff --git a/README.zh-CN.md b/README.zh-CN.md
deleted file mode 100644
index affa63e..0000000
--- a/README.zh-CN.md
+++ /dev/null
@@ -1,95 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-# Apache APISIX Dashboard（实验性的）
-
-[](https://github.com/apache/apisix-dashboard/blob/master/LICENSE)
-
-<p align="center">
- <a href="https://github.com/apache/apisix-dashboard">English</a> •
- <a href="https://github.com/apache/apisix-dashboard/blob/master/README.zh-CN.md">中文</a>
-</p>
-
-<p align="center">
- <a href="https://apisix.apache.org/">官网</a> •
- <a href="https://github.com/apache/apisix/tree/master/doc">文档</a> •
- <a href="https://twitter.com/apacheapisix">Twitter</a>
-</p>
-
-## 介绍
-
-Apache APISIX Dashboard 旨在通过前端界面，让用户尽可能更方便地操作 [Apache APISIX](https://github.com/apache/apisix)。
-
-Dashboard 为控制平面，完成所有参数的校验；Apache APISIX 混合了数据平面与控制平面，会逐渐演进为纯粹的数据平面。
-
-本项目包含了 `manager-api` 与前端界面，前者将逐渐替代 Apache APISIX 中的 `admin-api`，我们正在积极地迁移相关逻辑。
-
-注意：目前 Dashboard 尚未完整覆盖 Apache APISIX 的功能，[访问此处](https://github.com/apache/apisix-dashboard/milestones)以查看里程碑。
-
-
-
-## 目录结构
-
-```
-.
-├── CHANGELOG.md
-├── CHANGELOG.zh-CN.md
-├── CODE_OF_CONDUCT.md
-├── CONTRIBUTING.md
-├── Dockerfile
-├── LICENSE
-├── Makefile
-├── NOTICE
-├── README.md
-├── README.zh-CN.md
-├── api
-├── docs
-├── licenses
-└── web
-```
-
-1. `api` 目录用于存放 `manager-api` 源码，它用于管理 `etcd` 并为前端界面提供接口。
-2. `web` 目录用于存放前端源码。
-
-## 构建并启动
-
-支持以下方式：
-
-- [源码](./docs/deploy.zh-CN.md)
-- [Docker](./docs/deploy-with-docker.zh-CN.md)
-
-## 本地开发
-
-请参考[开发指南](./docs/develop.zh-CN.md)
-
-## 使用指南
-
-请参考[用户指南](./docs/USER_GUIDE.zh-CN.md)
-
-## 参与贡献
-
-请参考[贡献指南](./CONTRIBUTING.md)以获取更详细的流程
-
-## FAQ
-
-请参考 [FAQ 汇总](./docs/FAQ.zh-CN.md)以查看更多已知问题
-
-## License
-
-[Apache License 2.0](./LICENSE)
diff --git a/docs/FAQ.zh-CN.md b/docs/FAQ.zh-CN.md
deleted file mode 100644
index 7e9a47d..0000000
--- a/docs/FAQ.zh-CN.md
+++ /dev/null
@@ -1,56 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-# FAQ
-
-### 1. Vue.js 版本的 Dashboard
-
-若您需要 Vue.js 构建的 Apache APISIX Dashboard 1.0，请使用 [master-vue 分支](https://github.com/apache/apisix-dashboard/tree/master-vue)。
-
-### 2. Dashboard 2.0 版本与 1.5 版本有什么差异？
-
-2.0 版本的控制台移除了[1.5 版本](https://github.com/apache/apisix-dashboard/tree/backup-1.5-latest)中的 MySQL，将直接操作 etcd。
-
-### 3. etcd 兼容性问题
-
-若您使用 v2.0 以下版本的 Apache APISIX，需要注意 etcd v2 API 的数据与 v3 API 的数据是[不互通的](https://etcd.io/docs/v3.4.0/op-guide/v2-migration/)。Apache APISIX Dashboard v2.0 及以上版本使用 etcd v3 API，apisix 1.5 及以下版本使用 etcd v2 API。
-
-### 4. 在 Apache APISIX 中修改插件 schema 或创建自定义插件后，为什么在控制台找不到？
-
-由于 Dashboard 缓存了 Apache APISIX 中插件的 jsonschema 数据，因此您在 Apache APISIX 中创建自定义插件后，需要同步 Dashboard 中的数据，当前**仅支持手动操作**，该问题会在后续版本得到优化。如下为操作步骤：
-
-1. 安装 [Lua](https://www.lua.org/download.html) 与 `zip`。
-
-2. 执行如下命令：
-
-```sh
-# `$version` 为 `master` 或者 Apache APISIX 的版本号，如 2.0。
-$ api/build-tools/schema-sync.sh $version
-```
-
-若您有自定义插件，请确保该插件在 `apisix` 目录中，并使用如下命令：
-
-```sh
-$ api/build-tools/schema-sync.sh /path/to/apisix
-
-# 示例：
-$ api/build-tools/schema-sync.sh /usr/local/apisix
-```
-
-命令执行完成后，若您使用的是已经完成构建的二进制 `manager-api`，那么需要手动将 `api/conf/schema.json` 拷贝到 Dashboard **工作目录**下的 `conf` 目录中。其中，**工作目录**是指根据该[文档](./deploy.zh-CN.md)构建完成后，在根目录下生成的 `output` 目录或修改名称后的目录。
diff --git a/docs/USER_GUIDE.zh-CN.md b/docs/USER_GUIDE.zh-CN.md
deleted file mode 100644
index b18b7ad..0000000
--- a/docs/USER_GUIDE.zh-CN.md
+++ /dev/null
@@ -1,52 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-# 用户指南
-
-如下是部分模块的截图：
-
-## 监控
-
-我们通过 [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) 引用的方式以支持监控页，访问 [Grafana](https://grafana.com/) 前请启用 [`allow_embedding=true`](https://grafana.com/docs/grafana/latest/administration/configuration/#allow_embedding)，该配置项默认为 `false`，这将导致浏览器因安全策略而无法正常渲染 Grafana 页面。
-
-
-
-## 路由
-
-路由模块用于通过界面控制路由，以取代手动调用 API。
-
-### 路由列表
-
-
-
-### 创建路由
-
-
-
-
-
-
-
-
-
-
-
-## 设置
-
-
diff --git a/docs/deploy-with-docker.zh-CN.md b/docs/deploy-with-docker.zh-CN.md
deleted file mode 100644
index fb7c362..0000000
--- a/docs/deploy-with-docker.zh-CN.md
+++ /dev/null
@@ -1,84 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-# 使用 Docker 构建并启动
-
-使用 Docker 构建 Dashboard，您只需下载**根目录**中的 `Dockerfile` 文件到您的设备（无需下载源码），并根据本指南操作即可。
-
-本构建指南产物中，将包含 `manager-api` 与 `web`。
-
-## 环境准备
-
-在使用 Docker 构建镜像、启动容器前，请确认您的环境中，已安装并运行如下依赖：
-
-1. [Docker](https://docs.docker.com/engine/install/)
-2. [etcd](https://etcd.io/docs/v3.4.0/dl-build/) 3.4.0+
-
-## 构建
-
-```sh
-# 在 Dockerfile 所在目录下（默认为项目根目录）执行构建命令，请手动指定 tag。
-$ docker build -t apisix-dashboard:$tag .
-
-# 对于中国大陆的用户，可启用 `ENABLE_PROXY` 参数加快模块下载速度。
-$ docker build -t apisix-dashboard:$tag . --build-arg ENABLE_PROXY=true
-
-# 如果需要使用最新代码构建，可启用 `APISIX_DASHBOARD_VERSION` 参数指定为 `master` ，此参数也可以指定为其他版本的分支名，如 `v2.0` 。
-$ docker build -t apisix-dashboard:$tag . --build-arg APISIX_DASHBOARD_VERSION=master
-```
-
-## 启动
-
-1. 准备配置文件
-
-在启动容器前，需要在**宿主主机**内准备配置文件 `conf.yaml`，以便覆盖容器内部默认的[配置文件](../api/conf/conf.yaml)。
-
-配置文件有如下注意事项：
-
-- `conf.listen.host` 为 `0.0.0.0` 时，才能使外部网络访问到容器内的服务。
-- `conf.etcd.endpoints` 必须能够在容器内访问 `etcd` 服务。例如：使用 `host.docker.internal:2379` 以便容器能够访问宿主机网络中的 `etcd`。
-
-2. 启动 Dashboard
-
-```sh
-# /path/to/conf.yaml 需使用 绝对路径 指向上述提到的配置文件
-$ docker run -d -p 9000:9000 -v /path/to/conf.yaml:/usr/local/apisix-dashboard/conf/conf.yaml --name apisix-dashboard apisix-dashboard:$tag
-```
-
-3. 检查容器是否启动成功
-
-```sh
-$ docker ps -a
-```
-
-若容器 `apisix-dashboard` 状态正常，访问 `http://127.0.0.1:9000` 以使用有前端界面的控制台，默认用户密码均为 `admin`。
-
-4. 停止 Dashboard
-
-```sh
-$ docker stop apisix-dashboard
-```
-
-## 其它
-
-1. 多次构建镜像时，不建议使用缓存。
-
-```sh
-$ docker build -t apisix-dashboard:$tag . --no-cache=true
-```
diff --git a/docs/deploy.zh-CN.md b/docs/deploy.zh-CN.md
deleted file mode 100644
index 11e9642..0000000
--- a/docs/deploy.zh-CN.md
+++ /dev/null
@@ -1,86 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-# 使用源码构建并启动
-
-Dashboard 包含了 `manager-api` 与 `web` 两部分，其中 `web` 是*可选*的。
-
-本构建指南产物中，将包含 `manager-api` 与 `web`。
-
-## 环境准备
-
-在使用源码构建前，请确认您的环境中，已安装如下依赖：
-
-### manager-api
-
-1. [Golang](https://golang.org/dl/) 1.13+：对于中国大陆的用户，可使用如下命令加快模块下载速度。
-
-```sh
-$ go env -w GOPROXY=https://goproxy.cn,direct
-```
-
-2. [Lua](https://www.lua.org/download.html) 5.1+：仅在使用**插件编排**功能时，需要安装本依赖。在后续版本中，会对该部分进行优化以取消对其依赖。
-
-### web
-
-1. [Node.js](https://nodejs.org/en/download/) 10.23.0+
-2. [Yarn](https://yarnpkg.com/getting-started/install)
-
-## 克隆项目
-
-```sh
-$ git clone -b v2.0 https://github.com/apache/apisix-dashboard.git
-```
-
-## 构建
-
-```sh
-$ cd apisix-dashboard
-$ make build
-```
-
-构建完成后，构建结果将存放在根目录下 `output` 目录中。
-
-注意：`make build` 将会构建 `manger-api` 与 `web`，使用 `make help` 命令以查看更多指令。
-
-## 启动
-
-1. 在构建完成后、启动前，请确认您的环境中，已安装并运行如下依赖：
-
-- [etcd](https://etcd.io/docs/v3.4.0/dl-build/) 3.4.0+
-
-2. 根据您的部署环境，检查并修改 `output/conf/conf.yaml` 中的配置信息。
-
-3. 启动 Dashboard
-
-```sh
-$ cd ./output
-
-$ ./manager-api
-# 或后台常驻
-$ nohup ./manager-api &
-```
-
-4. 在未修改配置的情况下，访问 `http://127.0.0.1:9000` 以使用有前端界面的控制台，默认用户密码均为 `admin`。
-
-5. 停止 Dashboard
-
-```sh
-$ kill $(ps aux | grep 'manager-api' | awk '{print $2}')
-```
diff --git a/docs/develop.zh-CN.md b/docs/develop.zh-CN.md
deleted file mode 100644
index 44aac7b..0000000
--- a/docs/develop.zh-CN.md
+++ /dev/null
@@ -1,76 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-# 开发指南
-
-Dashboard 包含了 `manager-api` 与 `web` 两部分，因此需要分别启动开发环境。
-
-## 环境准备
-
-在开发前，请参考该[指南](./deploy.zh-CN.md#环境准备)以安装依赖。
-
-## 克隆项目
-
-```sh
-$ git clone -b v2.0 https://github.com/apache/apisix-dashboard.git
-```
-
-## 开始开发
-
-```sh
-$ cd apisix-dashboard
-```
-
-### manager-api
-
-1. 请在 `api/conf/conf.yaml` 中修改配置信息。
-
-2. 在根目录下，启动开发模式
-
-```sh
-$ make api-run
-```
-
-3. 在根目录下，关闭开发模式
-
-```sh
-$ make api-stop
-```
-
-4. 关于增加自定义插件或修改插件 schema 后在控制台显示异常的问题，请查阅 [FAQ 汇总](./FAQ.zh-CN.md)关于该问题的描述。
-
-### web
-
-1. 进入 `web` 目录。
-
-```sh
-$ cd ./web
-```
-
-2. 请在 `config/proxy.ts` 文件中修改 `manager-api` 地址。
-
-3. 启动开发模式
-
-```sh
-$ yarn install
-
-$ yarn start
-```
-
-4. 如编写 E2E 测试，请参考 [E2E 编写指南](../web/src/e2e/README.zh-CN.md)
diff --git a/web/src/e2e/README.zh-CN.md b/web/src/e2e/README.zh-CN.md
deleted file mode 100644
index e2f671b..0000000
--- a/web/src/e2e/README.zh-CN.md
+++ /dev/null
@@ -1,41 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-### 本地编写测试案例
-
-1. 安装依赖并运行本地开发环境
-
-```sh
-$ yarn install && yarn start
-```
-
-2. 在 `src/e2e` 文件夹增加新的测试案例文件
-3. 运行测试案例
-
-```sh
-$ yarn test
-```
-
-如果你想单独运行某一个测试文件，可以执行如下命令
-
-```sh
-$ yarn test ${yourFileName}.e2e.js
-```
-
-测试结果将会在控制台显示。