Chever-John commented on code in PR #305: URL: https://github.com/apache/apisix-docker/pull/305#discussion_r871177432
########## README.md: ########## @@ -1,8 +1,23 @@ -**Docker images are not official ASF releases but provided for convenience. Recommended usage is always to build the source.** +## Summary +This repo includes: +1. docker images for APISIX and APISIX dashboard (on alpine and centos). +2. examples that show how to get APISIX and APISIX dashboard up and running. +3. a list of commands that allow users to easily build, save, and tar the docker images. -## How To Build Image +## How To Build Images -**The master branch is for the version of Apache APISIX 2.x. If you need a previous version, please build from the [v1.x](https://github.com/apache/apisix-docker/releases/tag/v1.x) tag.** +**Note**: Docker images are not official ASF releases but provided for convenience. Recommended usage is always to build the source. \ Review Comment: Why are there two Notes? And a `\` at the end? ########## README.md: ########## @@ -1,8 +1,23 @@ -**Docker images are not official ASF releases but provided for convenience. Recommended usage is always to build the source.** +## Summary +This repo includes: +1. docker images for APISIX and APISIX dashboard (on alpine and centos). Review Comment: No indent at the end ########## README.md: ########## @@ -117,6 +154,18 @@ docker run -d \ -v `pwd`/all-in-one/apisix-dashboard/conf.yaml:/usr/local/apisix-dashboard/conf/conf.yaml \ apache/apisix-dashboard:whole ``` +## Useful commands + +Below are some useful commands which build, push, and tar your updated images. +As an example, these are the commands for apisix-centos images: + +- ```make build-on-centos``` : Build apache/apisix:xx-centos image. + +- ```make push-on-centos```: Build and push apache/apisix:xx-centos image. + +- ```make save-centos-tar```: Save apache/apisix:xx-centos image to a tar archive located at ```./package``` . Review Comment: Some questions here? Please note that the indentation remains consistent -- 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]
