add comments to docker templates

ckan · Jul 10, 2017 · d415b0d · d415b0d
1 parent 7e75ec0
commit d415b0d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/contrib/docker/.env.template b/contrib/docker/.env.template
@@ -1,15 +1,16 @@
-# Variables in this file will be substituted in docker-compose.yml
+# Variables in this file will be substituted into docker-compose.yml
+# Save a copy of this file as .env and insert your own values.
 # Verify correct substitution with "docker-compose config"
-# After changing these variables, delete and rebuild the images:
+# If variables are newly added or enabled, please delete and rebuild the images to pull in changes:
 # docker-compose down
 # docker rmi -f docker_ckan docker_db
 # docker rmi $(docker images -f dangling=true -q)
 # docker-compose build
 # docker-compose up -d
-# docker-compose restart (a few times until ckan starts up nicely)
+# docker-compose restart (run a few times until ckan starts up nicely)
 
 # Image: ckan
-# When developing on AWS, your CKAN_SITE_URL is the output of:
+# On AWS, your CKAN_SITE_URL is the output of:
 # curl -s http://169.254.169.254/latest/meta-data/public-hostname
 CKAN_SITE_URL=http://ec2-xxx-xxx-xxx-xxx.ap-southeast-2.compute.amazonaws.com
 # When developing locally, your CKAN_SITE_URL can be

diff --git a/contrib/docker/postgresql/Dockerfile b/contrib/docker/postgresql/Dockerfile
@@ -9,5 +9,5 @@ ENV POSTGRES_USER ckan
 ARG POSTGRES_PASSWORD
 ENV POSTGRES_DB ckan
 
-# Output variables when building for the first time, will not run if using cached image
+# Output variables when building for the first time. Will not run if using cached image.
 RUN echo "Building postgres:9.6 with user $POSTGRES_USER, pw $POSTGRES_PASSWORD, db $POSTGRES_DB"