VioletZhouECE commented on issue #300:
URL: https://github.com/apache/apisix-docker/issues/300#issuecomment-1128950201
Hi guys! I have some thoughts:
1. I think it's better to replace the `build` makefile commands with the
actual docker build command for 2 reasons:
1. From my understanding, most users will pull the docker hub image and
read the documentation from the docker hub. So to use the makefile commands,
they have to do the extra work of cloning the apisix-docker github repo and get
used to a different flow. Most users are used to the flow of `docker pull`,
`docker build`, `docker run`, `docker pull` (to get updeats), but not the flow
of `git clone`, `make <command>`, `git pull`(to fetch updates).
2. The actual build command is not much longer than the make command, so
I don't think there are a lot of benefits in having a shortcut.
For example, instead of:
```
# Assign Apache release version to variable `APISIX_VERSION`, for
example: 2.9.
# The latest release version can be find at
`https://github.com/apache/apisix/releases`
export APISIX_VERSION=2.9
# build alpine based image
make build-on-alpine
# build centos based image
make build-on-centos
```
We can have:
```
# Assign Apache release version to variable `APISIX_VERSION`, for
example: 2.9.
# The latest release version can be find at
`https://github.com/apache/apisix/releases`
export APISIX_VERSION=2.9
# build alpine based image
docker build -t $(ENV_APISIX_IMAGE_TAG_NAME)-alpine
# build centos based image
docker build -t $(ENV_APISIX_IMAGE_TAG_NAME)-centos
```
For developers, the make commands are easier because the developers work
with the apisix-docker repo anyway, but this might not be the case for the
users who do not work with the apisix-docker repo.
2. As we have APISIX and APISIX dashboard in two different places on the
docker hub, I think it'd be a good idea to have separate docs for APISIX and
APISIX dashboard. If we use the same documentation for both APISIX and APISIX
dashboard, the docs for APISIX dashboard will be buried in the docs for APISIX,
and the users will probably be confused about things like "why are they talking
about APISIX dashboard in the docs for APISIX?"
I understand that we can't use APISIX dashboard without APISIX, but I think
simply stating that "Before starting APISIX dashboard, please refer to this
guide to start APISIX" is better than mixing the two docs together.
Is it possible to have separate docs for APISIX and APISIX dashboard?
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
