juzhiyuan commented on a change in pull request #729:
URL: https://github.com/apache/apisix-dashboard/pull/729#discussion_r520287676
##########
File path: docs/deploy.zh-CN.md
##########
@@ -17,7 +17,7 @@
#
-->
Review comment:
##########
File path: README.md
##########
@@ -21,21 +21,72 @@ English | [简体中文](./README.zh-CN.md)
# Apache APISIX Dashboard
-Dashboard for [Apache APISIX](https://github.com/apache/apisix)
+Apache APISIX Dashboard for [Apache APISIX](https://github.com/apache/apisix)
-## User Guide
+The goal of Apache APISIX Dashboard project is to let users to quickly
experience and learn Apache APISIX, but it still cannot be used directly in a
production environment.
-Please refer to [User Guide](./docs/USER_GUIDE.md)
+Its function is always a subset of Apache APISIX, and may lag behind the rapid
iteration of Apache APISIX.
+
+If you need to use the Apache APISIX Dashboard project in a production system,
you need to enhance user permissions, communication security, high availability
and other advanced features.
+
+## Install
+
+Support multiple ways to install Apache APISIX Dashboard
+
+### Docker
+
+Start a runnable version by the following method
+
+- [Deploy With Docker](./docs/deploy-with-docker.md)
+
+### Build from Source Code
+
+To build Apache APISIX Dashboard from source code, first make sure that your
`golang` version is 1.13 or greater.
+
+Also you need to make sure that node and yarn are installed.
+
+```sh
+$ git clone -b v2.0 https://github.com/apache/apisix-dashboard.git
+$ cd apisix-dashboard
+$ make build
+```
+
+Then you can find all files (configuration files, executable files, web static
resources) needed to run Apache APISIX Dashboard in the `./output` directory.
-## Deployment
+Start by the following commands.
-- [Deploy Manually](./docs/deploy.md)
-- [Deploy with Docker](./docs/deploy-with-docker.md)
+```sh
+$ cd ./output
+$ exec ./manager-api
+```
-## Development
+`makefile` provides the following commands.
-- [Apache APISIX](https://github.com/apache/apisix)
-- [Dashboard](./docs/develop.md)
+```text
+Makefile rules:
+
+ help: Show Makefile rules
+ build: Build Apache APISIX Dashboard, it contains web and
manager-api
+ api-test: Run the tests of manager-api
+ api-run: Run the manager-api
+ api-stop: stop manager-api
+ go-lint: Lint Go source code
+ license-check: Check Apache APISIX Dashboard source codes for Apache
License
+```
+
+For more detailed construction steps, see - [Build from source
code](./docs/deploy.md)
Review comment:
source codes
##########
File path: README.md
##########
@@ -23,19 +23,68 @@ English | [简体中文](./README.zh-CN.md)
Dashboard for [Apache APISIX](https://github.com/apache/apisix)
-## User Guide
+The goal of Apache APISIX Dashboard project is to enable everyone to quickly
experience and learn Apache APISIX, and it still cannot be used directly in a
production environment. its function point coverage is always a subset of
Apache APISIX, and may lag behind the rapid iteration of Apache APISIX.
-Please refer to [User Guide](./docs/USER_GUIDE.md)
+If you need to use the Dashboard project in a production system, you need to
enhance user permissions, communication security, high availability and other
advanced features.
+
+## Install
Review comment:
hmm then it should be `Installation`
----------------------------------------------------------------
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:
[email protected]
