Refine docs

Author: patch0

.env.example

@@ -1,3 +1,20 @@
+################################
+# Stuff that you'll want to edit
+
+# Eventbrite API: See notes in the README about this.
+# Client secret 
+EVENTBRITE_SECRET_KEY=
+# API key 
+EVENTBRITE_PUBLIC_KEY=
+# Not sure what this does. Possibly a shared secret for use in the oauth process.
+EVENTBRITE_HASH_KEY=correct-horse-battery-staple
+
+# Get this from https://console.cloud.google.com/google/maps-apis/credentials
+GOOGLE_MAPS_KEY=
+
+###############################################
+# Probably don't need to edit stuff after here.
+
 CDF_ADMINS=[email protected],[email protected]
 CD_BADGES=badges
 CD_DOJOS=dojos
@@ -9,15 +26,6 @@ EMAIL_DEFAULT_FROM='The CoderDojo Team <[email protected]>'
 EMAIL_SERVICE=email
 EVENTS_SERVICE=events-service
 EVENT_URL=http://localhost:8000/events/
-# Eventbrite API: get these details from https://www.eventbrite.com/myaccount/apps/
-# Client secret 
-EVENTBRITE_SECRET_KEY=
-# API key 
-EVENTBRITE_PUBLIC_KEY=
-# Not sure what this does. Possibly a shared secret for use in the oauth process.
-EVENTBRITE_HASH_KEY=correct-horse-battery-staple
-# Get this from https://console.cloud.google.com/google/maps-apis/credentials
-GOOGLE_MAPS_KEY=
 ICS_EVENT_URL=http://localhost:8000/api/3.0/events/
 KUE_HOST=kue
 KUE_REQUIRED='true'

.gitignore

@@ -7,3 +7,4 @@ npm-debug.log
 *.log*
 cd-db/dumps/*
 !cd-db/dumps/.gitkeep
+.env

README.md

@@ -83,12 +83,22 @@ Note that the Forums and [Badges](installing-badgekit.md) will not be operable
 in local development mode, to run these, you need to install both
 [NodeBB](https://nodebb.org) and [BadgeKit](installing-badgekit.md) locally, which are a different problem.
 
-
-## Evironent settings
+## Environment settings
 
 All these are in the `.env.example` file, which should be copied to `.env`.
 Once copied, you'll want to fill in some of the details.  Currently you'll need
-keys for Google Maps and Eventbrite.
+keys for 
+[Google Maps](https://console.cloud.google.com/google/maps-apis/credentials)
+and [Eventbrite](https://www.eventbrite.ie/myaccount/apps/).
+
+When making changes to your `.env` file, you'll want to run 
+`docker-compose up -d` to ensure environment changes are propagated to the
+appropriate containers.
+
+**NB** when configuring your Eventbrite API key, you'll need to set the 
+*OAuth Redirect URI* on the Key Info page to
+`http://localhost:8000/dashboard/edit-dojo-eventbrite` otherwise you'll get a
+message about no `redirect_uri` parameter being supplied when connecting.
 
 ## Making code changes and working locally