Remove old test suite, and some unused config variables, tidying up config file.

1 files changed, 49 insertions, 27 deletions

diff --git a/conf/general.yml-example b/conf/general.yml-example
index 93b54a3e7..693a154c3 100644
--- a/conf/general.yml-example
+++ b/conf/general.yml-example
@@ -1,4 +1,4 @@
-# general-example.yml:
+# general.yml-example:
 # Example values for the "general" config file.
 #
 # Configuration parameters, in YAML syntax.
@@ -6,56 +6,67 @@
 # Copy this file to one called "general.yml" in the same directory.  Or
 # have multiple config files and use a symlink to change between them.
 
-# PostgreSQL database for FMS
+# PostgreSQL database details for FixMyStreet
 FMS_DB_HOST: 'localhost'
 FMS_DB_PORT: '5432'
 FMS_DB_NAME: 'fms'
 FMS_DB_USER: 'fms'
 FMS_DB_PASS: ''
 
+# The base URL of the install.
 BASE_URL: 'http://www.example.org'
+# Use the below if you're using the Catalyst development server
+#BASE_URL: 'http://localhost:3000'
 
+# Email domain used for emails, and contact name/email for admin use.
 EMAIL_DOMAIN: 'example.org'
 CONTACT_EMAIL: 'team@example.org'
-TEST_EMAIL_PREFIX: ''
-
 CONTACT_NAME: 'FixMyStreet'
+
+# Whether this is a live site or not.
 STAGING_SITE: 1
 
-UPLOAD_DIR: '/upload/'
-GEO_CACHE: '/cache/'
+# File locations for uploaded photos and cached geocoding results.
+UPLOAD_DIR: '../upload/'
+GEO_CACHE: '../cache/'
+
+# If you wish to use Google Maps or Bing Maps Geocoding, get and put the
+# relevant key here. Without a key, geocoding will use OSM's Nominatim.
 GOOGLE_MAPS_API_KEY: ''
 BING_MAPS_API_KEY: ''
-KASABI_API_KEY: ''
 
-LONDON_REPORTIT_URL: ''
-LONDON_REPORTIT_KEY: ''
-LONDON_REPORTIT_SECRET: ''
-
-MAPIT_URL: 'http://mapit.mysociety.org/'
+# Location of MapIt, to map points to administrative areas.
+# If left blank, a default area will be used everywhere.
+MAPIT_URL: ''
+# If using the Catalyst development server, set to
+# MAPIT_URL: 'http://localhost:3000/fakemapit/'
+# In the UK, you probably want:
+# MAPIT_URL: 'http://mapit.mysociety.org/'
+
+# The type of map you want to use. If left blank, the default is OpenStreetMap.
+# Other options are currently pretty UK specific, including "FMS" for UK
+# FixMyStreet.
 MAP_TYPE: 'OSM'
-EVEL_URL: 'http://services.mysociety.org/evel'
-GAZE_URL: 'http://gaze.mysociety.org/gaze'
-
-# Tracking
-TRACKING: 0   # off by default
-TRACKING_URL: 'http://path/to/web/bug'
-TRACKING_SECRET: 'really-secret-value'
-
-AUTH_SHARED_SECRET: ''
-HEARFROMYOURMP_BASE_URL: ''
 
+# If you wish to send email through a SMTP server elsewhere, change this
+# variable.
 SMTP_SMARTHOST: 'localhost'
 
-IPHONE_URL: ''
-
-# Log file (used in test harness, and later in admin scripts)
-HTTPD_ERROR_LOG: '/var/log/apache/error.log'
-
+# FixMyStreet uses a templating cobrand system to provide different looks for
+# different installations. If your site was at moon.example.org, and your templates
+# were in the templates/web/moon directory, you would use:
+# ALLOWED_COBRANDS:
+#   - moon: 'moon.example.org'
+# This also allows development servers to map to different cobrands if needed,
+# using DNS subdomains for example.
 ALLOWED_COBRANDS:
   - cobrand_one
   - cobrand_two: 'hostname_substring2'
 
+# Gaze is a world-wide service for population density lookups. You can leave
+# this as is.
+GAZE_URL: 'http://gaze.mysociety.org/gaze'
+
 # How many items are returned in the GeoRSS feeds by default
 RSS_LIMIT: '20'
 
@@ -64,3 +75,14 @@ AREA_LINKS_FROM_PROBLEMS: '0'
 
 # used to override the STAGING SERVER safety mechanism in send-reports
 TESTING_COUNCILS:
+
+# -----------------------------------------------------------------------
+
+# fixmystreet.com specific config variables. You won't need any of these.
+KASABI_API_KEY: ''
+LONDON_REPORTIT_URL: ''
+LONDON_REPORTIT_KEY: ''
+LONDON_REPORTIT_SECRET: ''
+AUTH_SHARED_SECRET: ''
+HEARFROMYOURMP_BASE_URL: ''
+