membphis commented on a change in pull request #729:
URL: https://github.com/apache/apisix-dashboard/pull/729#discussion_r520244654
##########
File path: Makefile
##########
@@ -17,37 +17,79 @@
SHELL := /bin/bash -o pipefail
UNAME ?= $(shell uname)
+YARN_EXEC ?= $(shell which yarn)
+GO_EXEC ?= $(shell which go)
-### help: Show Makefile rules
+export GO111MODULE=on
+
+### help: Show Makefile rules
.PHONY: help
help:
@echo Makefile rules:
@echo
@grep -E '^### [-A-Za-z0-9_]+:' Makefile | sed 's/###/ /'
-export GO111MODULE=on
-### license-check: Check apisix-dashboard source codes for Apache License
-.PHONY: license-check
-license-check:
-ifeq ("$(wildcard .actions/openwhisk-utilities/scancode/scanCode.py)", "")
- git clone https://github.com/apache/openwhisk-utilities.git
.actions/openwhisk-utilities
- cp .actions/ASF* .actions/openwhisk-utilities/scancode/
+### build: build dashboard, it contains web and manager-api
Review comment:
bad indentation and name style.
##########
File path: Makefile
##########
@@ -17,37 +17,79 @@
SHELL := /bin/bash -o pipefail
UNAME ?= $(shell uname)
+YARN_EXEC ?= $(shell which yarn)
+GO_EXEC ?= $(shell which go)
-### help: Show Makefile rules
+export GO111MODULE=on
+
+### help: Show Makefile rules
.PHONY: help
help:
@echo Makefile rules:
@echo
@grep -E '^### [-A-Za-z0-9_]+:' Makefile | sed 's/###/ /'
-export GO111MODULE=on
-### license-check: Check apisix-dashboard source codes for Apache License
-.PHONY: license-check
-license-check:
-ifeq ("$(wildcard .actions/openwhisk-utilities/scancode/scanCode.py)", "")
- git clone https://github.com/apache/openwhisk-utilities.git
.actions/openwhisk-utilities
- cp .actions/ASF* .actions/openwhisk-utilities/scancode/
+### build: build dashboard, it contains web and manager-api
Review comment:
@gxthrj please fix this
##########
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.
Review comment:
`The goal of the Apache APISIX Dashboard project is to allow users to
quickly experience and learn Apache APISIX, but it still cannot be used
directly in a production environment.`
`Its function is always a subset of Apache APISIX, and may lag behind the
updates of Apache APISIX.`
##########
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
+
+Support multiple ways to install 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 from source code, first make sure that your `golang` version is 1.13
or greater.
+Also you need to follow the `node` and `yarn` in advance
Review comment:
I can not understand this line @gxthrj
----------------------------------------------------------------
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]
