[GitHub] [apisix-dashboard] membphis commented on a change in pull request #592: feat: docs improvment

[GitBox <gi...@apache.org>]

membphis commented on a change in pull request #592:
URL: https://github.com/apache/apisix-dashboard/pull/592#discussion_r510636131



##########
File path: docs/deploy.zh-CN.md
##########
@@ -0,0 +1,90 @@
+<!--
+#
+# 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.
+#
+-->
+
+# 手动部署
+
+## 克隆项目
+
+```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"
+```
+
+如果有多个实例，请使用英文逗号分隔，如：
+
+```
+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`。

Review comment:
       Do we still need `Nginx` now?

##########
File path: docs/USER_GUIDE.zh-CN.md
##########
@@ -0,0 +1,50 @@
+<!--
+#
+# 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.
+#
+-->
+
+# 用户指南
+
+请在浏览器内访问[http://139.217.190.60/](http://139.217.190.60/)以预览 Apache APISIX 的控制台。如下是部分模块的截图：
+
+## 监控
+
+![metrics-en](./images/metrics-en.png)
+
+## 路由
+
+The Route module aims to control routes by UI instead of calling APIs.

Review comment:
       Chinese

##########
File path: docs/deploy.zh-CN.md
##########
@@ -0,0 +1,90 @@
+<!--
+#
+# 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.
+#
+-->
+
+# 手动部署
+
+## 克隆项目
+
+```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"
+```
+
+如果有多个实例，请使用英文逗号分隔，如：
+
+```
+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`。

Review comment:
       Golang Admin API + Dashboard, is it enough?

##########
File path: docs/develop.md
##########
@@ -14,14 +15,22 @@
 # 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:

Review comment:
       Incomplete?




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org