From f3bb932c1b7f09fd4bffef2ef403c11008f9fcb0 Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Tue, 18 Jul 2017 22:32:22 +0100 Subject: [PATCH] Switch from baseurl to using relative_url. Latest GitHub pages converts baseurl of '/' to ''. --- 404.md | 4 +- _config.yml | 1 - _includes/footer.html | 8 +-- _layouts/default.html | 4 +- _layouts/page.html | 68 +++++++++--------- customising/boundaries.md | 44 ++++++------ customising/checklist.md | 38 +++++----- customising/cobrand-module.md | 4 +- customising/config.md | 40 +++++------ customising/css.md | 18 ++--- customising/fms_and_mapit.md | 30 ++++---- customising/geocoder.md | 6 +- customising/index.md | 22 +++--- customising/integration.md | 14 ++-- customising/language/index.md | 4 +- customising/logo.md | 2 +- customising/send_reports.md | 4 +- directory_structure.md | 16 ++--- feeding-back.md | 2 +- glossary.md | 100 +++++++++++++------------- how-it-works.md | 52 +++++++------- index.md | 14 ++-- install/ami.md | 6 +- install/database.md | 2 +- install/fixmystreet-with-sms.md | 12 ++-- install/index.md | 10 +-- install/install-script.md | 2 +- install/manual-install.md | 30 ++++---- install/troubleshooting.md | 12 ++-- install/vagrant.md | 8 +-- overview.md | 2 +- running/admin_manual.md | 114 +++++++++++++++--------------- running/bodies_and_contacts.md | 14 ++-- running/example_press_releases.md | 2 +- running/index.md | 2 +- running/promotion.md | 8 +-- running/surveys.md | 22 +++--- training/admins.md | 34 ++++----- training/citizens.md | 34 ++++----- training/index.md | 10 +-- training/staff.md | 22 +++--- 41 files changed, 420 insertions(+), 421 deletions(-) diff --git a/404.md b/404.md index 60514b881ea..269a5eb1e88 100644 --- a/404.md +++ b/404.md @@ -8,5 +8,5 @@ title: Not Found

I am afraid we could not find the page you were looking for.

-

Please try the front page or the -main documentation. +

Please try the front page or the +main documentation. diff --git a/_config.yml b/_config.yml index 04b1e6ebeca..b65d0852b27 100644 --- a/_config.yml +++ b/_config.yml @@ -1,4 +1,3 @@ -baseurl: / permalink: pretty exclude: [ node_modules, bower_components ] paginate: 10 diff --git a/_includes/footer.html b/_includes/footer.html index ad1a317f327..25ffa94a760 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -14,10 +14,10 @@

FixMyStreet Platform

diff --git a/_layouts/default.html b/_layouts/default.html index 2abbe22a89e..6233347fc39 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -3,7 +3,7 @@ {{ page.title }} | FixMyStreet Platform | mySociety - + @@ -32,7 +32,7 @@
-

FixMyStreet: Platform

 +

FixMyStreet: Platform
diff --git a/_layouts/page.html b/_layouts/page.html index 30c9b6fa2af..639fed4e820 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -50,66 +50,66 @@ diff --git a/customising/boundaries.md b/customising/boundaries.md index 97265bb2e68..6e307521358 100644 --- a/customising/boundaries.md +++ b/customising/boundaries.md @@ -8,7 +8,7 @@ title: Admin boundaries

When you set up FixMyStreet, you usually need to provide admin boundaries for each of the - bodies + bodies you'll be sending reports to. If you're lucky, the boundaries might already be available. If not, you'll have to make them. This page explains your options. @@ -25,7 +25,7 @@ been put somewhere that is *not* covered by any bodies.

We've written a separate page about - how FixMyStreet uses MapIt, + how FixMyStreet uses MapIt, which is the service that determines which area any point (pin) is within. It's helpful to understand how that works — because it also explains how FixMyStreet determines which categories of problem can be reported at any @@ -36,7 +36,7 @@ been put somewhere that is *not* covered by any bodies. FixMyStreet finds all the bodies that are associated with the area (or areas) that the pin is inside -- those are the bodies to whom the report might be sent. Which of these bodies is actually chosen depends on the -category +category the user selects when they complete their problem report. ## Boundaries are independent of your maps! @@ -59,7 +59,7 @@ list when you create or edit the body. If the bodies you are going to be sending reports to are local government departments, it's possible that this data already exists. We use the admin boundary data from -OpenStreetMap, +OpenStreetMap, and many countries' data is already available. If that's the case for you, then this is going to be easy! You just have to identify the areas you need, and tell FixMyStreet to ignore all the others. @@ -120,7 +120,7 @@ Use this type of boundary if: The advantage of using the boundary "Everywhere" is that it's very easy to set up. The disadvantage is that your FixMyStreet will accept clicks *anywhere* on the map. This may be acceptable if you are limiting your -geocoder +geocoder to a very specific area.
@@ -130,14 +130,14 @@ to a very specific area.

This is the default setup of a new FixMyStreet installation (if you used the - installation script or the - AMI install). + installation script or the + AMI install).

Set - MAPIT_URL + MAPIT_URL to be blank, and set - MAPIT_TYPES + MAPIT_TYPES to the special value ZZZ. FixMyStreet will use a fake MapIt that always returns "Everywhere" as the only area that contains the point — for any location. @@ -176,18 +176,18 @@ Use this type of boundary if you: like this, so — especially if you are just doing this as a probationary trial — we may be able to host this for you (note though that we do rate-limit calls to MapIt). Either send us - KML shape files, + KML shape files, or if you can't do that, maybe a clear image of the map with the boundary drawn on it for us to copy.

In your conf/general.yml, you must set - MAPIT_URL + MAPIT_URL to either your MapIt or our custom one, and set - MAPIT_TYPES + MAPIT_TYPES to the areas you want (the actual values will depend on what that particular MapIt is returning). You should also set - MAPIT_ID_WHITELIST + MAPIT_ID_WHITELIST to the ID of the single area you want. 

MAPIT_URL: 'http://mapit.example.com'
@@ -219,13 +219,13 @@ Use this type of boundary if you:
     

       Same as previous example: either set up your own instance of MapIt, or ask to
       have your boundaries added to our custom one. If you want us to host it, we'll
-      need KML shape files
+      need KML shape files
       or a graphic showing the boundary clearly shown so we can copy it. 
     

     

       Note that now there may be more than one type of area, and you'll need to explicitly
       nominate every area you're interested in with
-      MAPIT_ID_WHITELIST 
+      MAPIT_ID_WHITELIST 
       (unless you want *all* the areas this MapIt returns for the given type, in
       which case you can set it to be empty).
     

@@ -258,7 +258,7 @@ Use this type of boundary if:
   
   

     

-      Start by finding the lat-long of some of the places you want to cover,
       and look them up on global
       MapIt (or maybe the UK one).
@@ -308,7 +308,7 @@ Use this type of boundary if:
           Specifically, you need the Administrative Boundary
           Levels (which will look like O04 or
           O05), which are the values for your 
-          MAPIT_TYPES.
+          MAPIT_TYPES.
           Remember this data is boundary data from OpenStreetMap —
           if the boundaries you need are not shown, you may have to set up your
           own (described below). You can also click on any of the boundaries
@@ -318,7 +318,7 @@ Use this type of boundary if:
       
  • 
         
    
           The individual area_ids are also useful, because you put
-          them into the MAPIT_ID_WHITELIST.
+          them into the MAPIT_ID_WHITELIST.
         
    
       
    • 
     
@@ -354,7 +354,7 @@ Use this type of boundary if:
   
    
     
    
       In your conf/general.yml file, point 
-      MAPIT_URL
+      MAPIT_URL
       at the global MapIt server.
     
    
     
    
@@ -383,9 +383,9 @@ Use this type of boundary if:
       Finally, limit your installation to the specific areas you're interested
       in (otherwise you'll be getting areas from the whole world). Identify the
       specific areas you want to use, and list them explicitly in
-      MAPIT_ID_WHITELIST.
+      MAPIT_ID_WHITELIST.
       You should also set
-      MAPIT_GENERATION, 
+      MAPIT_GENERATION, 
       so that your areas can still be found when we update the global MapIt data.
     
    
 
    MAPIT_URL: 'http://global.mapit.mysociety.org'
@@ -435,7 +435,7 @@ this data into a MapIt server and use that.
       But if you can't do that, or the boundary data you have is not
       definitive, you can create your own. Use any good GIS software to plot
       the boundaries accurately, and then export it as
-      KML shape files.
+      KML shape files.
       MapIt can import these, so you can then either run your own MapIt
       instance, or ask us to add it to our custom one.
     
    
diff --git a/customising/checklist.md b/customising/checklist.md
index 12358858c3b..1086113be4d 100644
--- a/customising/checklist.md
+++ b/customising/checklist.md
@@ -24,7 +24,7 @@ at the same time as others -- but if you're not sure then just work through the
   
   
    
     You need a name for your
-    cobrand
+    cobrand
     right at the start because that's the name you'll use for the directories
     where your own resources and templates go.
     
    
@@ -58,14 +58,14 @@ at the same time as others -- but if you're not sure then just work through the
   
    
     If FixMyStreet doesn't already have translations for the language(s) you
     need, you can start work on that right away — see 
-    more about languages.
+    more about languages.
   
    
   
    
     
    Install the software on the server
    
   
    
   
    
     There are several different ways of doing this — see 
-    installation instructions.
+    installation instructions.
     
    
       Even if you're not hosting the site yourself, you might want to install
       the software in order to see how your customisation looks before putting
@@ -88,7 +88,7 @@ at the same time as others -- but if you're not sure then just work through the
     
    Change the colour scheme
    
   
   
    
-    See changing colour and CSS
+    See changing colour and CSS
     for detailed instructions.
     
    
       You can just change the colour variables without needing to touch any other
@@ -105,7 +105,7 @@ at the same time as others -- but if you're not sure then just work through the
     dropping in a graphics file.
     
    
       We'll be adding instructions later, but meanwhile see the page
-      about changing the CSS.    
+      about changing the CSS.    
     
    
   
    
   
    
@@ -120,7 +120,7 @@ at the same time as others -- but if you're not sure then just work through the
       templates/web/base/about/faq-en-gb.html
     
    
     
    
-      See more about templates.
+      See more about templates.
     
    
   
    
   
    
@@ -129,9 +129,9 @@ at the same time as others -- but if you're not sure then just work through the
   
    
     When someone enters a place name, you only want your FixMyStreet to look
     for it in the place your site covers. This is controlled by the
-    GEOCODING_DISAMBIGUATION
+    GEOCODING_DISAMBIGUATION
     setting.
-    See more about the geocoder.
+    See more about the geocoder.
     
    
       We've listed this separately from the other config settings because it
       may take a little bit of testing to see what options work best —
@@ -143,10 +143,10 @@ at the same time as others -- but if you're not sure then just work through the
   
   
    
     You need to decide what kind of boundary data you'll be using — see
-    more about boundaries.
+    more about boundaries.
     
    
       As part of that work, you'll need to set 
-      MAPIT_URL
+      MAPIT_URL
       and the other MapIt config settings to match the service you're using.
     
    
   
    
@@ -155,15 +155,15 @@ at the same time as others -- but if you're not sure then just work through the
   
   
    
     Many of the  
-    configuration settings
+    configuration settings
     can be left with their defaults, but some you must change. 
     
    
       As well as system settings (for example, 
-      FMS_DB_NAME),
+      FMS_DB_NAME),
       every new site needs custom
-      EMAIL_DOMAIN
+      EMAIL_DOMAIN
       and
-      EXAMPLE_PLACES
+      EXAMPLE_PLACES
       settings. Make sure the example places you choose really do work if you enter them 
       as the location on the front page.
     
    
@@ -178,13 +178,13 @@ at the same time as others -- but if you're not sure then just work through the
   
   
    
     Once your site is running log into the admin and 
-    add the bodies.
+    add the bodies.
     
    
       You should have set up the
-      admin boundaries
+      admin boundaries
       by this stage, because you need to associate each body with the area it covers.
       For more information, see
-      how FixMyStreet uses MapIt.
+      how FixMyStreet uses MapIt.
     
    
   
    
   
    
@@ -194,7 +194,7 @@ at the same time as others -- but if you're not sure then just work through the
     Once you've created the bodies to whom reports will be sent, you can add
     their problem categories (for example, "Potholes", "Streetlights"). At the
     same time, add the contact email addresses for each one — see more about
+    href="{{ "/running/bodies_and_contacts/" | relative_url }}">more about
     contacts and categories.
    @@ -204,7 +204,7 @@ at the same time as others -- but if you're not sure then just work through the Remember that this just covers the key parts of a custom installation. There's a lot more you can change — for example, you can write custom Perl code -for the Cobrand +for the Cobrand module if you want to override specific behaviour not covered by config variables. diff --git a/customising/cobrand-module.md b/customising/cobrand-module.md index ff17b929856..3160e61adee 100644 --- a/customising/cobrand-module.md +++ b/customising/cobrand-module.md @@ -72,10 +72,10 @@ name. * send_questionnaires - By default, FixMyStreet [sends questionnaires]({{site.baseurl}}running/surveys) + By default, FixMyStreet [sends questionnaires]({{ "/running/surveys" | relative_url }}) (sometimes called _surveys_) four weeks after a user submitted a report. The questionnaire encourages them to update the - state + state of the report. Return 0 to disable this feature so that surveys are never sent. diff --git a/customising/config.md b/customising/config.md index ea2823f9061..2639f625fef 100644 --- a/customising/config.md +++ b/customising/config.md @@ -21,7 +21,7 @@ the Configuration page of your administration interface, at The FixMyStreet code ships with an example configuration file: `conf/general.yml-example`. -As part of the [installation process]({{ site.baseurl }}install ), the example +As part of the [installation process]({{ "/install " | relative_url }}), the example file gets copied to `conf/general.yml`. You **must** edit this file to suit your needs. @@ -215,8 +215,8 @@ The following are all the configuration settings that you can change in `conf/ge
    Is this site a - staging - (or development) + staging + (or development) site?

    On a staging site, templates/CSS modified times aren't cached. Staging @@ -230,7 +230,7 @@ The following are all the configuration settings that you can change in `conf/ge

    • If this is your live - production + production server:

      STAGING_SITE: 0 @@ -252,7 +252,7 @@ The following are all the configuration settings that you can change in `conf/ge

      There is a safety mechanism on staging sites (where STAGING_SITE is 1): - your staging site will send reports to a convenient email + your staging site will send reports to a convenient email address instead of the relevant body's contact address. This is very useful for testing!

      @@ -271,10 +271,10 @@ The following are all the configuration settings that you can change in `conf/ge

    Note that this setting is only relevant on a - staging + staging server. On your - production + production server (where STAGING_SITE is 0) it will be ignored. @@ -345,13 +345,13 @@ The following are all the configuration settings that you can change in `conf/ge Remember that if you want your site to run in languages other than English, you'll also need to check that the translations are available, and your system supports the appropriate - locales. + locales.

    Just adding a language here does not necessarily mean FixMyStreet will always use it (for example, a language coded subdomain name or browser preference may be considered). See this page about - languages and FixMyStreet for more information. + languages and FixMyStreet for more information.

    Example:

    @@ -421,7 +421,7 @@ LANGUAGES:
    FixMyStreet uses the external service MapIt to map locations (points) to administrative areas: see this - explanation of MapIt. + explanation of MapIt.

    You must provide the URL of a MapIt server, and nominate what types of @@ -522,7 +522,7 @@ LANGUAGES: should also specify the generation of MapIt data you are using, especially if you are using our global MapIt service.

    - Global MapIt uses OpenStreetMap data. From time to time we import the latest data in order to pull in newly-added boundaries, or reflect changes to existing ones. When this happens, the area IDs may change, which means the values in your @@ -554,7 +554,7 @@ LANGUAGES: MapIt's generation 4 for Thailand's national border (hence 507455 and - area type O02): + area type O02): 

    MAPIT_URL: http://global.mapit.mysociety.org/
 MAPIT_TYPES: ['O02']
 MAPIT_ID_WHITELIST: [507455]
@@ -600,18 +600,18 @@ MAPIT_ID_GENERATION: 4
     GEOCODER
   
   
    
-    Which geocoder service to use to look up results, for
+    Which geocoder service to use to look up results, for
     example, from front page "Enter your location" searches.
     
    
     Possible choices are 
     Google, Bing, or OSM.
     By default, FixMyStreet will use OSM, the 
-    OpenStreetMap 
+    OpenStreetMap 
     geocoder.
     
    
     
    
       For more information, see the
-      page about geocoding.
+      page about geocoding.
     
    
     
    
     
    
@@ -673,7 +673,7 @@ MAPIT_ID_GENERATION: 4
   
   
    
     This setting provides parameters that are included in 
-    geocoding requests, to hopefully
+    geocoding requests, to hopefully
     return more useful results. The options that will be applied vary depending
     on which geocoder you are using (although unwanted options will be ignored,
     so you can specify all of them, which might be convenient if you change
@@ -729,7 +729,7 @@ GEOCODING_DISAMBIGUATION:
   
    
     The type of map you want to use. If left blank, the default is 
     OSM for 
-    OpenStreetMap.
+    OpenStreetMap.
     Other options are GoogleOL for Google Open Layers,
     and other UK-specific values, including FMS
     for UK FixMyStreet.
@@ -752,7 +752,7 @@ GEOCODING_DISAMBIGUATION:
   
   
    
     FixMyStreet uses a templating 
-    cobrand
+    cobrand
     system to provide different looks (and behaviour) for
     different installations. For example, if you create a cobrand
     called moon, then FixMyStreet will look for templates in the
@@ -808,7 +808,7 @@ ALLOWED_COBRANDS:
     
    
       If you're running a site with multiple cobrands, you'll never want to
       serve the Default cobrand on your 
-      production
+      production
       server, so make sure you've set ALLOWED_COBRANDS correctly.
     
    
     
    
@@ -980,7 +980,7 @@ ALLOWED_COBRANDS:
     not usually use this, so you can leave it blank.    
     
    
       Providing a URL does not automatically enable the service — your cobrand
+      href="{{ "/glossary/#cobrand" | relative_url }}" class="glossary__link">cobrand
       must be explicitly coded to use it. Contact us if you need to use Message
       Manager with your FixMyStreet site.
     
    
diff --git a/customising/css.md b/customising/css.md
index 9a195290247..3fc7d083f16 100644
--- a/customising/css.md
+++ b/customising/css.md
@@ -50,7 +50,7 @@ site** but most of this page shows how to set your own colours *without adding
 any new HTML or CSS*. We know that you'll want to change more than just the
 default colours: but this is the best way to start.
 
-Once you've done this, you'll have your own cobrand, and can start changing other stylesheets and
 templates in the same way.
 
@@ -104,14 +104,14 @@ it's FixMyStreet's internal name for it.
 You need to tell FixMyStreet to use your cobrand instead of the default one.
 
 FixMyStreet uses the 
-ALLOWED_COBRANDS
+ALLOWED_COBRANDS
 config variable to decide which cobrand to use. In `conf/general.yml`, set it to your new cobrand like this:
 
     ALLOWED_COBRANDS:
       - fixmypark
 
 In fact, `ALLOWED_COBRANDS` is 
-[a little more complex that it looks]({{ site.baseurl }}customising/config/#allowed_cobrands).
+[a little more complex that it looks]({{ "/customising/config/#allowed_cobrands" | relative_url }}).
 If you give it a list of cobrands, it will decide which one to use depending on string
 matches on the incoming URL *for every request*  But for most cases you don't want it to switch.
 So if you just specify just one cobrand like this, FixMyStreet will simply use it.
@@ -268,7 +268,7 @@ FixMyStreet include the changes.
 Remember that *all* you've done here is change the colours, **using the
 existing default CSS and HTML**. Of course any and all of this can be
 overridden (by overriding CSS files and overriding the bits of HTML that you
-want to change in the templates) but this is just so you can get going.
 
 # Directionality
@@ -280,12 +280,12 @@ straightforward and involves two steps:
   so that the `$direction` variable is set to `right`.
 * Secondly, create a copy of the `templates/web/base/header.html` in
   your own cobrand if you haven’t already (see
-  [template customising]({{ site.baseurl }}customising/templates/) for more
+  [template customising]({{ "/customising/templates/" | relative_url }}) for more
   details) and uncomment the `SET` line that sets `dir="rtl"`.
 
 That’s it; recompile your CSS, reload your site and you will find that
 FixMyStreet has switched to a right-to-left layout. Your next step will
-probably be to [change the language]({{ site.baseurl }}customising/language/)
+probably be to [change the language]({{ "/customising/language/" | relative_url }})
 used by your site.
 
 # Next steps...
@@ -293,11 +293,11 @@ used by your site.
 If you want to customise the logo, [we have a tutorial for that](../logo/).
 
 Now you have your own cobrand, adding your own HTML templates is straightforward.
+href="{{ "/glossary/#template" | relative_url }}" class="glossary__link">templates is straightforward.
 
-Please see our separate page on [customising templates]({{ site.baseurl }}customising/templates/).
+Please see our separate page on [customising templates]({{ "/customising/templates/" | relative_url }}).
 
 ### Feeding back changes
 
 Finally, when you've finished creating your cobrand you should consider
-[feeding it back to us]({{site.baseurl}}feeding-back) so it becomes part of the FixMyStreet repository.
+[feeding it back to us]({{ "/feeding-back" | relative_url }}) so it becomes part of the FixMyStreet repository.
diff --git a/customising/fms_and_mapit.md b/customising/fms_and_mapit.md
index 9b6695f003c..c0260940401 100644
--- a/customising/fms_and_mapit.md
+++ b/customising/fms_and_mapit.md
@@ -7,30 +7,30 @@ author: dave
 # How FixMyStreet assigns reports to bodies
 
 
    
-  When you add a body
-  to FixMyStreet, you specify which areas
+  When you add a body
+  to FixMyStreet, you specify which areas
   it covers. The areas are typically defined by administrative boundaries: these
   are not part of FixMyStreet, but are made available through our
-  service called MapIt.
+  service called MapIt.
 
    
 
 Note that MapIt tells FixMyStreet what administrative boundaries a point lies
 within: it does not actually draw the maps (by default, FixMyStreet uses
-OpenStreetMap for that).
+OpenStreetMap for that).
 
 ## How this works
 
 When someone places a pin on the FixMyStreet
-map
+map
 to report a problem, FixMyStreet sends the 
-lat-long
+lat-long
 coordinates of that position to MapIt. MapIt responds with a list of the areas
 that the pin lies within. FixMyStreet then looks in its own database to find
 all the bodies that cover that area, and the
-contacts
+contacts
 (which are usually email addresses) that you have added for each of
 those bodies. Because each contact is associated with a
-category
+category
 of problem (for example, "Potholes" or "Graffiti"), FixMyStreet can build a
 list of all the problem categories that *can* be reported at this location. In
 fact, this list appears as the drop-down menu ("Pick a category") on the
@@ -42,7 +42,7 @@ world. [See below](#boundaries) for more about setting this up.
 
 ## Detailed flow: location → map pin → drop-down menu
 
-![FMS bodies and contacts]({{ site.baseurl }}assets/img/fms_bodies_and_contacts.png)
+![FMS bodies and contacts]({{ "/assets/img/fms_bodies_and_contacts.png" | relative_url }})
 
  
 
@@ -51,13 +51,13 @@ world. [See below](#boundaries) for more about setting this up.
 The type of boundary data you need depends on a number of factors, but will
 probably be one of these:
 
-   * ["Everywhere"]({{ site.baseurl }}customising/boundaries/#everywhere) -- you can run FixMyStreet without a specific boundary
-   * [Simple approximate area]({{ site.baseurl }}customising/boundaries/#approx-area) -- that is, just one area around the place you need
-   * [Simple approximate areas]({{ site.baseurl }}customising/boundaries/#approx-areas) -- as above, but for multiple areas
-   * [Accurate OpenStreetMap data]({{ site.baseurl }}customising/boundaries/#mysociety-mapit) -- the preferred option
-   * [Accurate data that isn't on OSM]({{ site.baseurl }}customising/boundaries/#accurate) -- if you have your own boundary data, for example
+   * ["Everywhere"]({{ "/customising/boundaries/#everywhere" | relative_url }}) -- you can run FixMyStreet without a specific boundary
+   * [Simple approximate area]({{ "/customising/boundaries/#approx-area" | relative_url }}) -- that is, just one area around the place you need
+   * [Simple approximate areas]({{ "/customising/boundaries/#approx-areas" | relative_url }}) -- as above, but for multiple areas
+   * [Accurate OpenStreetMap data]({{ "/customising/boundaries/#mysociety-mapit" | relative_url }}) -- the preferred option
+   * [Accurate data that isn't on OSM]({{ "/customising/boundaries/#accurate" | relative_url }}) -- if you have your own boundary data, for example
 
 If you're not sure which is for you, read through the 
-[whole page about admin boundaries]({{ site.baseurl }}customising/boundaries/).
+[whole page about admin boundaries]({{ "/customising/boundaries/" | relative_url }}).
 
 
diff --git a/customising/geocoder.md b/customising/geocoder.md
index ad82c011f12..4dc44b5077f 100644
--- a/customising/geocoder.md
+++ b/customising/geocoder.md
@@ -16,19 +16,19 @@ near the start of the process, before maps, MapIt boundaries or bodies enter
 the picture.
 
 The geocoder takes a string -- for example, the name of a place or a street --
-and converts it into a [lat-long]({{ site.baseurl }}glossary/#latlong) location.
+and converts it into a [lat-long]({{ "/glossary/#latlong" | relative_url }}) location.
 
 The geocoder defaults to OpenStreetMap's [Nominatim](http://nominatim.openstreetmap.org).
 FixMyStreet also contains Bing and Google based geocoders, and can use
 custom geocoders too.
 
 You can customise the geocoding by providing limiting parameters in
-GEOCODING_DISAMBIGUATION.
+GEOCODING_DISAMBIGUATION.
 You typically need to do this so the geocoder only considers places in the area
 your FixMyStreet site is serving. For example, you may want to limit results to
 a specific country or city.
 
-The options vary [depending on which geocoder you use]({{ site.baseurl }}customising/config/#geocoding_disambiguation).
+The options vary [depending on which geocoder you use]({{ "/customising/config/#geocoding_disambiguation" | relative_url }}).
 
 ## Detailed flow: location → map pin → drop-down menu
 
diff --git a/customising/index.md b/customising/index.md
index 7e0103c34d3..610e44ae354 100644
--- a/customising/index.md
+++ b/customising/index.md
@@ -16,12 +16,12 @@ title: Customising
 ## Your own cobrand
 
 Whatever you change, you'll almost certainly need to create a
-cobrand,
+cobrand,
 which is the mechanism FixMyStreet uses to let you deviate from its default
 appearance and behaviour.
 
 As well as the
-[configuration settings]({{ site.baseurl }}customising/config/) you specify in
+[configuration settings]({{ "/customising/config/" | relative_url }}) you specify in
 the `conf/general.yml` file, a cobrand is made up of a set of templates, CSS,
 and an *optional* Cobrand module that contains custom Perl code. There are
 defaults for all of these, so the cobrand only needs to override things that are
@@ -41,20 +41,20 @@ things like directory names). The default cobrand is called Default (`default`).
 
 There's a lot you can customise on your own FixMyStreet site.
 
-We've prepared a [customisation checklist]({{ site.baseurl }}customising/checklist/)
+We've prepared a [customisation checklist]({{ "/customising/checklist/" | relative_url }})
 which covers all the key things you should work through when installing your own 
 site.
 
 But if you just want to see what's possible, here are some of the
 aspects of FixMyStreet that you can customise:
 
-* [how to translate or change FixMyStreet's language]({{ site.baseurl }}customising/language/)
-* [how FixMyStreet assigns reports to bodies]({{ site.baseurl }}customising/fms_and_mapit/)
-* [how to customise the geocoder]({{ site.baseurl }}customising/geocoder/)
-* [how to change the design]({{ site.baseurl }}customising/css/)
-* [how to customise templates]({{ site.baseurl }}customising/templates/)
-* [how reports are sent by FixMyStreet]({{ site.baseurl }}customising/send_reports/)
-* [all the config settings]({{ site.baseurl }}customising/config/)
+* [how to translate or change FixMyStreet's language]({{ "/customising/language/" | relative_url }})
+* [how FixMyStreet assigns reports to bodies]({{ "/customising/fms_and_mapit/" | relative_url }})
+* [how to customise the geocoder]({{ "/customising/geocoder/" | relative_url }})
+* [how to change the design]({{ "/customising/css/" | relative_url }})
+* [how to customise templates]({{ "/customising/templates/" | relative_url }})
+* [how reports are sent by FixMyStreet]({{ "/customising/send_reports/" | relative_url }})
+* [all the config settings]({{ "/customising/config/" | relative_url }})
 
 Note that none of the above require you to know or write any Perl (the language 
 FixMyStreet is mostly written in). 
@@ -79,4 +79,4 @@ and CSS you may not feel you have to, but it's likely you'll have needed to
 make actual code changes for your particular environment, and feeding these
 back means it is easier to update the code from upstream in future to gain new
 features and bugfixes.
-See [more about feeding back changes]({{ site.baseurl }}feeding-back/).
+See [more about feeding back changes]({{ "/feeding-back/" | relative_url }}).
diff --git a/customising/integration.md b/customising/integration.md
index 36fabce4cb1..95806a039c4 100644
--- a/customising/integration.md
+++ b/customising/integration.md
@@ -15,10 +15,10 @@ author: dave
 
 ## Integrate if you can!
 
-Often bodies,
+Often bodies,
 especially if they are local government bodies, already have databases and
 back-end systems for tracking problems they are fixing. FixMyStreet works fine
-if you just use the default send method, which is email, but it's *much better* if you
 can integrate with the body's back-end systems.
 
@@ -27,7 +27,7 @@ cooperation they offer FixMyStreet. In general, once FixMyStreet is integrated
 it's *easier* for the body's staff to use.
 
 Our experience with FixMyStreet in the UK is that councils that integrate with
-FixMyStreet also choose to run it as a cobrand (that is, branded and on their own website). In
 fact, cobranding and integrating are not dependent on each other, so if you do
 one it is not necessary to do the other.
@@ -62,7 +62,7 @@ one it is not necessary to do the other.
 
 Although you can approach each of these levels of integration as custom
 programming tasks, we *strongly recommend* you use the
-Open311
+Open311
 open standard when you can.
 
 Strictly speaking it's possible to implement any of these levels independently
@@ -73,7 +73,7 @@ previous one.
 
 You can integrate with just one body (while the others continue to use email).
 You can even just integrate certain
-categories
+categories
 for a body — for example, "Potholes" and "Fallen trees" could be
 submitted by Open311, while "Streetlighting" problems are sent by email.
 
@@ -92,7 +92,7 @@ into back-end:
 
 
 
-If the body's server is already Open311 compliant, you can switch on the first stage
 of integration -- which puts the problem report directly into the body's
 back-end system instead of emailing it -- just by setting the send method (for
@@ -108,7 +108,7 @@ address.
 
 If you want to have the problem reports for some categories to be integrated
 into their body's back-end, but continue to send others by email, you can
-devolve
 choosing the send method to the contacts. Set the body's send method as above,
 but also enable **contacts can be devolved**. Now you can set specific
diff --git a/customising/language/index.md b/customising/language/index.md
index 921d3b8fbcd..f998127efd4 100644
--- a/customising/language/index.md
+++ b/customising/language/index.md
@@ -12,7 +12,7 @@ run a site in multiple languages. Work in progress.
    
 ## Setup
 
 The translations for most FixMyStreet strings are stored as standard 
-gettext
+gettext
 files, in `FixMyStreet.po` files under `locale//LC_MESSAGES/`. A
 few full pages, such as the FAQ, and emails, are stored separately in the
 templates directory and should be translated by creating new templates in your
@@ -20,7 +20,7 @@ cobrand.
 
 
 Firstly, set the
-LANGUAGES
+LANGUAGES
 configuration option to the languages your site uses. This is an array of
 strings specifying what language or languages your installation uses. For
 example, if your site is available in English, French, and German, you would
diff --git a/customising/logo.md b/customising/logo.md
index 32c261b2ef2..14c9a5051b8 100644
--- a/customising/logo.md
+++ b/customising/logo.md
@@ -13,7 +13,7 @@ author: matthew
 ## Background
 
 Do make sure you have followed the
-[initial CSS guide]({{ site.baseurl }}customising/css/) first to set up the
+[initial CSS guide]({{ "/customising/css/" | relative_url }}) first to set up the
 initial CSS for your own cobrand. There are a few ways you can have your own
 logo on your cobrand, which we will go through below. We first talk about
 replacing the image itself, and then changing the size.
diff --git a/customising/send_reports.md b/customising/send_reports.md
index 46fafa27add..22d46034d9a 100644
--- a/customising/send_reports.md
+++ b/customising/send_reports.md
@@ -52,7 +52,7 @@ it successfully.
 Although by default FixMyStreet sends reports by email, it's possible to inject reports *directly* into some
 bodies' databases or back-end systems. This is usually much better than using email because it's more convenient
 for the staff working at the receiving end. See
-[more about integration]({{ site.baseurl }}customising/integration/) for details.
+[more about integration]({{ "/customising/integration/" | relative_url }}) for details.
 
 ## Technical investigation
 
@@ -67,7 +67,7 @@ But if you want to see what's going on, you can use these options:
 
    * the `--verbose` option prints out a summary of reports that did not get
      sent. Incidentally, this option is useful even in
-     production,
+     production,
      because it causes cron to send a logging email containing this summary of
      failed-to-send reports if anything goes wrong.
 
diff --git a/directory_structure.md b/directory_structure.md
index dd469c685a3..e4089201a2f 100644
--- a/directory_structure.md
+++ b/directory_structure.md
@@ -56,7 +56,7 @@ you're doing is [customising your installation](/customising).
       The primary configuration file is general.yml. This file isn't in the git
       repository (since it will contain information specific to your installation, including
       the database password), but example files are.
-      See  details of all
+      See  details of all
       configuration settings.
     
    
   
    
@@ -75,7 +75,7 @@ you're doing is [customising your installation](/customising).
       The db directory contains SQL for creating the tables and seeding some of the data —
       for example, schema.sql contains the full database structure, and you use this when
       you first create the database (see 2. Create a new PostgreSQL database in the
-      installation instructions if you're installing manually).
+      installation instructions if you're installing manually).
     
    
     
    
       By convention, we also put "migration" SQL in here, so if the schema has changed since you installed and
@@ -101,7 +101,7 @@ you're doing is [customising your installation](/customising).
       The translation strings are stored in .po files in directories specific to
       the locale and encoding. For example, nn_NO.UTF-8/ contains the translations
       for the Norwegian site. See more about
-      translating FixMyStreet.
+      translating FixMyStreet.
    @@ -161,10 +161,10 @@ you're doing is [customising your installation](/customising). Cobrand
    - Contains the Cobrand modules, which you + Contains the Cobrand modules, which you can use if you need to add custom behaviour beyond that provided by config and template changes. - See more abobut customising your site. + See more abobut customising your site.
    DB @@ -197,7 +197,7 @@ you're doing is [customising your installation](/customising).

    In addition to email and Open311, this is where the custom - back-end integrations + back-end integrations are found.

    @@ -211,7 +211,7 @@ you're doing is [customising your installation](/customising).

    - code for implementing FixMyStreet's Open311 functionality + code for implementing FixMyStreet's Open311 functionality

    @@ -249,7 +249,7 @@ you're doing is [customising your installation](/customising). default/. In this way, cobrands only need to override templates that differ from FixMyStreet's default — it's feasible for your cobrand's template directories to be empty. - See more abobut customising your site. + See more abobut customising your site.

    diff --git a/feeding-back.md b/feeding-back.md index cc18ceb6cb6..a52b030a3b4 100644 --- a/feeding-back.md +++ b/feeding-back.md @@ -8,7 +8,7 @@ title: Feeding back your changes

    We want people using the code to keep it as up to date as they can, so that they gain the benefits of any changes made to the code by us or by other users. To do this, we need your help when you are making changes to the code, feeding -the changes back to us and updating your code.

    +the changes back to us and updating your code.

    **If you haven't done this, don't panic!** Everything is solvable, and we fully understand that what little diff --git a/glossary.md b/glossary.md index 500c2b65e22..fd23738d351 100644 --- a/glossary.md +++ b/glossary.md @@ -78,7 +78,7 @@ technical information, see

    More information:

    @@ -92,7 +92,7 @@ technical information, see An administrator is a user who has access to the back-end admin (so can do things like add or edit bodies, modify problem reports, and manage + class="glossary__link">problem reports, and manage users). An administrator should also have access to the email account to which user support emails are sent.

    @@ -110,7 +110,7 @@ technical information, see href="#body" class="glossary__link">body.

  • - See the Administrator's Manual for + See the Administrator's Manual for details of what an administrator does.
    • @@ -149,7 +149,7 @@ technical information, see shapefiles from other mapping applications.

    The - MAPIT_ID_WHITELIST + MAPIT_ID_WHITELIST config setting can explicitly list the only areas your installation will recognise — alternatively, you can limit them by area type @@ -159,11 +159,11 @@ technical information, see

    More information:

    @@ -294,7 +294,7 @@ technical information, see

    More information:

    @@ -325,15 +325,15 @@ technical information, see @@ -355,15 +355,15 @@ technical information, see password). Instead, there is an example file, cong/general.yml-example you can copy and edit. If you install using the - installation script - or the AMI, this file will + installation script + or the AMI, this file will automatically be created for you.

    More information:

    @@ -1091,7 +1091,7 @@ technical information, see
    @@ -1164,7 +1164,7 @@ technical information, see @@ -1249,7 +1249,7 @@ technical information, see

    More information:

    • - See About users for more about managing + See About users for more about managing users.
    • diff --git a/how-it-works.md b/how-it-works.md index da2113f64bd..5e6bf699bf4 100644 --- a/how-it-works.md +++ b/how-it-works.md @@ -13,19 +13,19 @@ title: How to FixMyStreet FixMyStreet makes it easy for anyone to report a problem without worrying about the correct authority to send it to. FixMyStreet takes care of that using the -problem's location and category, and sends a -report, -by email or using a web service such as report, +by email or using a web service such as Open311, to the department or body responsible for fixing it. But FixMyStreet doesn't just send problem reports — it makes the reports visible to everyone. Anyone can see what's already been reported, leave updates, or -subscribe to updates, or +subscribe to alerts. We help prevent duplicate reports and offer -additional features for staff users working for the authorities who are actually fixing problems. @@ -45,16 +45,16 @@ If you want to get FixMyStreet up and running, this is what you need to do: @@ -69,9 +69,9 @@ If you want to get FixMyStreet up and running, this is what you need to do:
      @@ -85,12 +85,12 @@ If you want to get FixMyStreet up and running, this is what you need to do:
      • you'll need to get the - boundary data + boundary data for the area you're covering (and the borders of any authorities within it)
      • you must find - email addresses + email addresses for each of the departments responsible for each category of problem, in each of the bodies responsible for the areas you're covering
        • @@ -101,29 +101,29 @@ If you want to get FixMyStreet up and running, this is what you need to do:
      There's lots you can do to - customise the site: + customise the site: @@ -136,10 +136,10 @@ If you want to get FixMyStreet up and running, this is what you need to do: Actually setting up a FixMyStreet project is just the beginning — you need to be committed for the long term to see the site grow and succeed. There will be - user support + user support to do, marketing and press to handle, liaison with the authorities you're sending the reports to, and perhaps even - integration + integration (because email is the easiest, but not necessarily the best, way to send those reports).

      @@ -148,15 +148,15 @@ If you want to get FixMyStreet up and running, this is what you need to do: We've written a clear guide for anyone who's thinking about [setting up and -running FixMyStreet]({{ site.baseurl }}The-FixMyStreet-Platform-DIY-Guide-v1.1.pdf). +running FixMyStreet]({{ "/The-FixMyStreet-Platform-DIY-Guide-v1.1.pdf" | relative_url }}). If you're thinking of running such a project, you **must** read it first -- it explains why these sites work, and what you need to think about before you start. If you still want to be involved, we welcome questions about how it works -[on our mailing list]({{ site.baseurl }}community/). +[on our mailing list]({{ "/community/" | relative_url }}). Or, if you're outside the UK, email international@mysociety.org. -There's also the [FixMyStreet blog]({{ site.baseurl }}blog/) where we post version release +There's also the [FixMyStreet blog]({{ "/blog/" | relative_url }}) where we post version release information and other progress reports. And we often post FixMyStreet news on the mySociety blog too. diff --git a/index.md b/index.md index bb76f58ebbd..753490ffb2c 100644 --- a/index.md +++ b/index.md @@ -6,10 +6,10 @@ title: Welcome @@ -108,8 +108,8 @@ title: Welcome

      Learn more

      Get your FixMyStreet
      site up and running

      @@ -120,8 +120,8 @@ title: Welcome diff --git a/install/ami.md b/install/ami.md index af09ca9e93e..6ad9464af5a 100644 --- a/install/ami.md +++ b/install/ami.md @@ -12,7 +12,7 @@ title: AMI for EC2 EC2 instance.

      -Note that this is just one of [four ways to install FixMyStreet]({{ site.baseurl }}install/). +Note that this is just one of [four ways to install FixMyStreet]({{ "/install/" | relative_url }}). ## Installing on Amazon's Web Services @@ -42,9 +42,9 @@ file to set a couple of parameters. That configuration file is fms@ip-10-58-191-98:~/fixmystreet$ nano conf/general.yml You should set -CONTACT_EMAIL +CONTACT_EMAIL and -DO_NOT_REPLY_EMAIL +DO_NOT_REPLY_EMAIL or whatever you wish to use. postfix is installed so that outgoing email will work, but this may need further configuration. diff --git a/install/database.md b/install/database.md index 5390cd5f617..f282c8985be 100644 --- a/install/database.md +++ b/install/database.md @@ -33,4 +33,4 @@ Then you should be able to access the database with: ## Configuration When you've got everything working, you'll need to update the -[database config settings]({{ site.baseurl }}customising/config/#fms_db_host). +[database config settings]({{ "/customising/config/#fms_db_host" | relative_url }}). diff --git a/install/fixmystreet-with-sms.md b/install/fixmystreet-with-sms.md index 12f631e4248..4d6ce943607 100644 --- a/install/fixmystreet-with-sms.md +++ b/install/fixmystreet-with-sms.md @@ -7,7 +7,7 @@ title: Using FixMyStreet with SMS

      We're sometimes asked about running FixMyStreet with - SMS. + SMS. With SMS, users can report problems by text message instead of using the web interface. This page describes how it can work, and what you must consider before going ahead. @@ -26,7 +26,7 @@ SMS are, and why we always recommend you establish and run your site on the web ### Main issues: duplicate reports, no location information One important aspect to FixMyStreet is that most -problem reports are about problems with specific locations. On the web, this +problem reports are about problems with specific locations. On the web, this means we can present the user with a map to click on. This interface, encouraging people to click on a map, serves a couple of functions: @@ -34,7 +34,7 @@ This interface, encouraging people to click on a map, serves a couple of functio * it deters duplicate reports being sent for the same problem, because it's obvious if a problem has already been reported (a pin will already be there) * it provides an accurate - lat-long + lat-long position of the location of the problem The main problem with SMS — although there are others — is that @@ -72,7 +72,7 @@ below) first. In both cases, you start by advertising a number (possibly a shortcode which is easier for people to remember) for people to send SMS reports to. This means you should -[customise your templates]({{ site.baseurl }}customising/templates), because (when it's running live) the number should presumably appear on the website +[customise your templates]({{ "/customising/templates" | relative_url }}), because (when it's running live) the number should presumably appear on the website too. ## Method 1: use a mobile phone (yes, really!) @@ -110,8 +110,8 @@ of the reporter. We have a web application called -Message Manager that accepts incoming messages from an SMS gateway, and makes them available to -staff users +Message Manager that accepts incoming messages from an SMS gateway, and makes them available to +staff users within the FixMyStreet website. A staff user on a FixMyStreet site that is using Message Manager can see incoming SMS reports, reply to them, and turn them into reports by clicking on the map. This effectively integrates SMS diff --git a/install/index.md b/install/index.md index d12e08cff74..117279cfd16 100644 --- a/install/index.md +++ b/install/index.md @@ -13,16 +13,16 @@ title: Installing ## Four ways to install -* [Use an install script for Debian or Ubuntu servers]({{ site.baseurl }}install/install-script/) -* [Use a FixMyStreet AMI for Amazon EC2]({{ site.baseurl }}install/ami/) -* [Vagrant installation]({{ site.baseurl }}install/vagrant/), for development -* [Install the software manually]({{ site.baseurl }}install/manual-install/) +* [Use an install script for Debian or Ubuntu servers]({{ "/install/install-script/" | relative_url }}) +* [Use a FixMyStreet AMI for Amazon EC2]({{ "/install/ami/" | relative_url }}) +* [Vagrant installation]({{ "/install/vagrant/" | relative_url }}), for development +* [Install the software manually]({{ "/install/manual-install/" | relative_url }}) FixMyStreet is a web application written in Perl, using the Catalyst framework. Installation deploys the core code and also manages its dependencies. If you're not technical, this can be a little daunting — if you haven't -already done so, [get in touch]({{ site.baseurl }}community) and ask for help. +already done so, [get in touch]({{ "/community" | relative_url }}) and ask for help. Please also see the instructions for [updating your code](/updating/) once it's installed. diff --git a/install/install-script.md b/install/install-script.md index afe94991a49..8f4c9d9862c 100644 --- a/install/install-script.md +++ b/install/install-script.md @@ -11,7 +11,7 @@ title: Install script FixMyStreet on your server.

      -Note that this is just one of [four ways to install FixMyStreet]({{ site.baseurl }}install/). +Note that this is just one of [four ways to install FixMyStreet]({{ "/install/" | relative_url }}). ## Warning: installation changes your setup! diff --git a/install/manual-install.md b/install/manual-install.md index f399338c2b9..3ac14b82560 100644 --- a/install/manual-install.md +++ b/install/manual-install.md @@ -11,7 +11,7 @@ title: Installing but the other installation options may be easier:

      Note that this is just one of -[four ways to install FixMyStreet]({{ site.baseurl }}install/) +[four ways to install FixMyStreet]({{ "/install/" | relative_url }}) (the other ways are easier!). @@ -132,7 +132,7 @@ $ {% endhighlight %} You should be able to connect to the database with `psql -U fms fms` -- if not, -you will need to investigate [how to allow access to your PostgreSQL database]({{ site.baseurl }}install/database). +you will need to investigate [how to allow access to your PostgreSQL database]({{ "/install/database" | relative_url }}). #### 5b. Install database schema @@ -157,22 +157,22 @@ $ cp conf/general.yml-example conf/general.yml The bare minimum of settings you will need to fill in or update are: -* [FMS_DB_PASS]({{ site.baseurl }}customising/config/#fms_db_pass) -- this is the password for the database. (Also obviously change any other database settings you did differently here.) -* [BASE_URL]({{ site.baseurl }}customising/config/#base_url) -- for using the development server, set to `'http://localhost:3000/'`. This is the URL of the homepage of your FixMyStreet installation. -* [MAPIT_URL]({{ site.baseurl }}customising/config/#mapit_url) -- for the development server, set to `'http://localhost:3000/fakemapit/'`. This would be the URL of a MapIt installation, as and when you use one. +* [FMS_DB_PASS]({{ "/customising/config/#fms_db_pass" | relative_url }}) -- this is the password for the database. (Also obviously change any other database settings you did differently here.) +* [BASE_URL]({{ "/customising/config/#base_url" | relative_url }}) -- for using the development server, set to `'http://localhost:3000/'`. This is the URL of the homepage of your FixMyStreet installation. +* [MAPIT_URL]({{ "/customising/config/#mapit_url" | relative_url }}) -- for the development server, set to `'http://localhost:3000/fakemapit/'`. This would be the URL of a MapIt installation, as and when you use one. Some others you might want to look at, though the defaults are enough for it to run: -* [EMAIL_DOMAIN]({{ site.baseurl }}customising/config/#email_domain) -- the email domain that emails will be sent from -* [CONTACT_EMAIL]({{ site.baseurl }}customising/config/#contact_email) -- the email address to be used on the site for the contact us form. -* [DO_NOT_REPLY_EMAIL]({{ site.baseurl }}customising/config/#do_not_reply_email) -- the email address to be used on the site for e.g. confirmation emails. -* [STAGING_SITE]({{ site.baseurl }}customising/config/#staging_site) -- if this is 1 then all email (alerts and reports) will be sent to the contact email address. Use this for development sites. -* [UPLOAD_DIR]({{ site.baseurl }}customising/config/#upload_dir) -- this is the location where images will be stored when they are uploaded. It should be accessible by and writeable by the FixMyStreet process. -* [GEO_CACHE]({{ site.baseurl }}customising/config/#geo_cache) -- this is the location where Geolocation data will be cached. It should be accessible by and writeable by the FixMyStreet process. +* [EMAIL_DOMAIN]({{ "/customising/config/#email_domain" | relative_url }}) -- the email domain that emails will be sent from +* [CONTACT_EMAIL]({{ "/customising/config/#contact_email" | relative_url }}) -- the email address to be used on the site for the contact us form. +* [DO_NOT_REPLY_EMAIL]({{ "/customising/config/#do_not_reply_email" | relative_url }}) -- the email address to be used on the site for e.g. confirmation emails. +* [STAGING_SITE]({{ "/customising/config/#staging_site" | relative_url }}) -- if this is 1 then all email (alerts and reports) will be sent to the contact email address. Use this for development sites. +* [UPLOAD_DIR]({{ "/customising/config/#upload_dir" | relative_url }}) -- this is the location where images will be stored when they are uploaded. It should be accessible by and writeable by the FixMyStreet process. +* [GEO_CACHE]({{ "/customising/config/#geo_cache" | relative_url }}) -- this is the location where Geolocation data will be cached. It should be accessible by and writeable by the FixMyStreet process. If you are using Bing or Google maps you should also set one of -[BING_MAPS_API_KEY]({{ site.baseurl }}customising/config/#bing_maps_api_key) or -[GOOGLE_MAPS_API_KEY]({{ site.baseurl }}customising/config/#google_maps_api_key). +[BING_MAPS_API_KEY]({{ "/customising/config/#bing_maps_api_key" | relative_url }}) or +[GOOGLE_MAPS_API_KEY]({{ "/customising/config/#google_maps_api_key" | relative_url }}). ### 7. Set up some required data @@ -225,7 +225,7 @@ base for your own user crontab. ### Deployment -For production +For production use of FixMyStreet, we suggest you use Apache or nginx, and FastCGI. It should also be possible to run it using Plack/PSGI, if that is preferable. @@ -274,7 +274,7 @@ our developers and on mySociety's servers. ## Problems? -See some [troubleshooting hints]({{ site.baseurl }}install/troubleshooting/) if +See some [troubleshooting hints]({{ "/install/troubleshooting/" | relative_url }}) if something's not working for you. ## When you've finished diff --git a/install/troubleshooting.md b/install/troubleshooting.md index 69cfce3066a..54475c69459 100644 --- a/install/troubleshooting.md +++ b/install/troubleshooting.md @@ -7,11 +7,11 @@ title: Installation troubleshooting

      If you've installed FixMyStreet using the - installation script + installation script or the - AMI, you should be good to go. + AMI, you should be good to go. However, if you've done a - manual install, + manual install, sometimes you might bump into a problem if your system is different from what FixMyStreet expects. These hints might help.

      @@ -32,7 +32,7 @@ title: Installation troubleshooting ### locale: must be installed By default, FixMyStreet uses the `en_GB.UTF-8` -locale. +locale. If it is not installed then it may not start. You need this locale on your system even if you're planning on running your site in a different language. @@ -49,7 +49,7 @@ Check to see what locales your system currently supports with: ### Template caching FixMyStreet caches compiled -templates +templates alongside the source files, so the `templates/web/` directory needs to be writable by the process that is running FixMyStreet. @@ -97,7 +97,7 @@ aren't showing up, do `bin/make_css` to create them. ### Bad YAML format in config settings: no response or 500 error -When you change any of the [config settings]({{ site.baseurl }}customising/config/) +When you change any of the [config settings]({{ "/customising/config/" | relative_url }}) in `conf/general.yml` (which you will do!), make sure you don't break the YAML format. If FixMyStreet can't read that file cleanly, it may time out, causing fastcgi to eventually respond with a 500 Internal Server Error. diff --git a/install/vagrant.md b/install/vagrant.md index 3cb404682ae..c9d95ef364e 100644 --- a/install/vagrant.md +++ b/install/vagrant.md @@ -9,16 +9,16 @@ title: Vagrant Vagrant provides an easy method to set up virtual development environments — for further information see the Vagrant website. We bundle an example Vagrantfile in the repository, which runs the -install script for you. +install script for you.

      -Note that this is just one of [four ways to install FixMyStreet]({{ site.baseurl }}install/). +Note that this is just one of [four ways to install FixMyStreet]({{ "/install/" | relative_url }}).
      Vagrant is only suitable for use as a - development + development server — do not use it in - production! + production!
      This pages describes how to use Vagrant to create a development environment diff --git a/overview.md b/overview.md index c29caf89f04..1d759fb1e4c 100644 --- a/overview.md +++ b/overview.md @@ -72,7 +72,7 @@ Could your location use a FixMyStreet site? We've written a clear guide for anyone who's thinking about [setting up and -running FixMyStreet]({{ site.baseurl }}The-FixMyStreet-Platform-DIY-Guide-v1.1.pdf). Anyone +running FixMyStreet]({{ "/The-FixMyStreet-Platform-DIY-Guide-v1.1.pdf" | relative_url }}). Anyone thinking of running such a project **must** read it first -- it explains why these sites work, and what you need to think about before you start. diff --git a/running/admin_manual.md b/running/admin_manual.md index 5d9b7157d66..83cb717236a 100644 --- a/running/admin_manual.md +++ b/running/admin_manual.md @@ -32,20 +32,20 @@ questions as you need to. ## Other helpful documents * **Before** you decide to run FixMyStreet, you should read the - ["Can we fix it?" DIY Guide]({{ site.baseurl }}The-FixMyStreet-Platform-DIY-Guide-v1.1.pdf). + ["Can we fix it?" DIY Guide]({{ "/The-FixMyStreet-Platform-DIY-Guide-v1.1.pdf" | relative_url }}). * If you are hosting FixMyStreet yourself, you **must** read the [installation instructions](/install) first. Once you've done that, you'll probably need the information about [customising your site](/customising) too. * This guide is just one of several useful pages for administrators in the + href="{{ "/glossary/#administrator" | relative_url }}" class="glossary__link">administrators in the section about [running FixMyStreet](/running). This document is the most general, so is a good place to start. ## Find your administrator -Every FixMyStreet site needs an administrator. Even when the site is running smoothly, your users will need help, and there will be regular administrative tasks to perform. So, sooner rather than later, you will need to think about who will @@ -68,8 +68,8 @@ developer** and **one administrator** who can work on the site. At the beginning you'll be quite busy. You'll be doing a lot of things, like customising your site, collecting the email addresses your users' problem reports will be sent to, -and perhaps [promoting your project]({{ site.baseurl }}running/promotion/). +href="{{ "/glossary/#report" | relative_url }}" class="glossary__link">problem reports will be sent to, +and perhaps [promoting your project]({{ "/running/promotion/" | relative_url }}). **Once your site is up and running**, you can manage with just **one administrator**. @@ -119,11 +119,11 @@ The Admin interface is divided into the following sections. You can access them by clicking on the link at the top of any admin page: * **Summary page**
      The summary page shows the number of live reports, updates, alerts, sent - questionnaires and - bodies' contacts. + href="{{ "/glossary/#report" | relative_url }}" class="glossary__link">reports, updates, alerts, sent + questionnaires and + bodies' contacts.

      This page is useful when the media ask how many reports your site has @@ -131,7 +131,7 @@ them by clicking on the link at the top of any admin page: to official bodies.

      -* **Bodies**
      Bodies are the +* **Bodies**
      Bodies are the authorities that your site sends reports to. Each body has its own page in the admin, listing the categories of problem that they accept (eg, potholes, street lights, etc) and the email address associated with the category. @@ -139,15 +139,15 @@ them by clicking on the link at the top of any admin page:

      Bodies sometimes change their email addresses, and dealing with this is a regular task for an administrator. You can add or edit bodies from these - pages. You can also add or edit their categories and categories and contact email addresses. Bodies are associated with - one or more areas. More information on bodies. + one or more areas. More information on bodies.

      * **Reports**
      The reports page lets you search for, and edit problem reports and updates. + href="{{ "/glossary/#report" | relative_url }}" class="glossary__link">problem reports and updates.

      You will need to do this often - for example, when a user has emailed to @@ -172,7 +172,7 @@ them by clicking on the link at the top of any admin page: updates, status changes, and so on. * **Survey**
      By default, FixMyStreet sends out surveys (also called + href="{{ "/glossary/#survey" | relative_url }}" class="glossary__link">surveys (also called questionnaires) to users four weeks after they reported a problem.

      @@ -184,13 +184,13 @@ them by clicking on the link at the top of any admin page:

      If you don't want your FixMyStreet site to send out surveys, you can switch off this behaviour in a cobrand module. + href="{{ "/customising/cobrand-module/" | relative_url }}">cobrand module.

      * **Users**
      You can [manage users](/running/users) from this section. - For example you can edit a user's - email address, or flag or - ban or abusive one. + For example you can edit a user's + email address, or flag or + ban or abusive one.

      Each user has an individual page in the admin, and it is sometimes quicker @@ -203,23 +203,23 @@ them by clicking on the link at the top of any admin page: this page.

      -* **Flagged**
      You can You can flag any report or user. This does not ban the user or delete the + href="{{ "/glossary/#abuse-list" | relative_url }}" class="glossary__link">ban the user or delete the report - it is just a way of marking a person or a situation as potentially troublesome. Note that you can only flag a report or user from the report or page.

      This can be useful if your team has more than one administrator. More information about managing users. + href="{{ "/glossary/#administrator" | relative_url }}" class="glossary__link">administrator. More information about managing users.

      * **Stats**
      The stats page lets you analyse the number and types of report over a particular date + href="{{ "/glossary/#report" | relative_url }}" class="glossary__link">report over a particular date range. Optionally, you can restrict it to report on a single body. + href="{{ "/glossary/#body" | relative_url }}" class="glossary__link">body.

      You might use this if you want to know how many reports have been sent @@ -234,8 +234,8 @@ them by clicking on the link at the top of any admin page: ## Report states -A problem report can be in -one of these states: +A problem report can be in +one of these states:

      @@ -256,7 +256,7 @@ one of these its creator was already logged in when the report was created, or
    • - an administrator confirms it (by searching in Reports and changing the state by clicking edit). @@ -271,7 +271,7 @@ one of these An open report is one that has not been fixed or closed. This generally means that the body has not yet attended to the problem. Also, this implies that the report is not unconfirmed (see above). Staff users can set + href="{{ "/glossary/#staff-user" | relative_url }}" class="glossary__link">Staff users can set problems to have alternative "open" states:

      @@ -315,9 +315,9 @@ one of these

      - A staff user + A staff user associated with the report's body (or an administrator) can + href="{{ "/glossary/#administrator" | relative_url }}" class="glossary__link">administrator) can mark a report as closed without declaring it to be fixed. Possible states are:

      @@ -333,10 +333,10 @@ one of these

      - Reports can be hidden by an , or (if the cobrand allows it) by a staff user associated + href="{{ "/glossary/cobrand" | relative_url }}" class="glossary__link">cobrand allows it) by a staff user associated with the body to which it was sent.

      @@ -347,7 +347,7 @@ one of these

      Remember that a hidden report will probably have been sent to the body responsible (so it can + href="{{ "/glossary/#body" | relative_url }}" class="glossary__link">body responsible (so it can still be fixed) — hiding a report simply prevents it being displayed.

      @@ -356,7 +356,7 @@ one of these ## Types of Tasks There are two main types of tasks for FixMyStreet administrators. +href="{{ "/glossary/#administrator" | relative_url }}" class="glossary__link">administrators. * **Maintenance** tasks can be fixed through the FixMyStreet admin interface. @@ -371,12 +371,12 @@ experience with the UK site.

      - When FixMyStreet sends a problem report to the problem report to the body responsible, sometimes that email bounces - back. This usually means the contact email address you've got for that body (and - that category) is + that category) is wrong, or has changed.

      @@ -555,9 +555,9 @@ FixMyStreet site.

      In the UK, it's common for each body to have multiple contacts (usually email + href="{{ "/glossary/#contact" | relative_url }}" class="glossary__link">contacts (usually email addresses) — for more information, see About bodies and contacts. Your + href="{{ "/running/bodies_and_contacts/" | relative_url }}">About bodies and contacts. Your site may be the same.

      @@ -601,11 +601,11 @@ FixMyStreet site. queries directly on the database.

      - Staff users can see - the dashboard for + Staff users can see + the dashboard for their own body by going to /dashboard when they are logged into the public site. If they don't have a staff user set up, offer to - do this for them: see managing users. + do this for them: see managing users.

      @@ -736,11 +736,11 @@ FixMyStreet site.

      - FixMyStreet constructs the list of categories of report (for example, "Pothole" or "Graffiti") based on what services the body (or bodies) in that area provide. See Managing bodies and contacts to + href="{{ "/glossary/#area" | relative_url }}" class="glossary__link">area provide. See Managing bodies and contacts to see how this works.

      @@ -761,7 +761,7 @@ FixMyStreet site.

      To understand more about about this, see Managing bodies and contacts. + href="{{ "/running/bodies_and_contacts/" | relative_url }}">Managing bodies and contacts.

      @@ -781,7 +781,7 @@ FixMyStreet site.

      This problem may indicate that the boundary data you are using is either incorrect, or not accurate enough — for more information, see How FixMyStreet uses MapIt. + href="{{ "/customising/fms_and_mapit/" | relative_url }}">How FixMyStreet uses MapIt.

      @@ -810,7 +810,7 @@ FixMyStreet site.

      Your FixMyStreet installation will normally be using maps from an - external source — by default this is OpenStreetMap.

      @@ -962,6 +962,6 @@ We wish you all the best with your FixMyStreet problem reporting site. If you're running an installation outside the UK please let us know by emailing international@mysociety.org. If you have any questions, don't -hesitate to contact us and we'll get back to you as +hesitate to contact us and we'll get back to you as soon as possible with an answer. diff --git a/running/bodies_and_contacts.md b/running/bodies_and_contacts.md index a5190db36db..c07e2c52a46 100644 --- a/running/bodies_and_contacts.md +++ b/running/bodies_and_contacts.md @@ -7,9 +7,9 @@ author: dave # Managing bodies and contacts in FixMyStreet

      A body is the authority to which problem -reports will be sent. Each body needs one or more contacts +reports will be sent. Each body needs one or more contacts (typically these are email addresses) to which particular -categories of problem are sent.

      +categories of problem are sent.

      For [FixMyStreet in the UK](https://www.fixmystreet.com/), bodies are councils (county, district, and metropolitan). @@ -22,7 +22,7 @@ Click on **Bodies** and fill in the form. Normally, you _must_ provide a name and pick at least one area it covers. See [How FixMyStreet uses MapIt](/customising/fms_and_mapit) for more information on how these areas are chosen. -You can specify a send method. This is *how* FixMyStreet will send the +You can specify a send method. This is *how* FixMyStreet will send the problem reports to this body. If you leave it blank, **send method will default to email**. @@ -98,13 +98,13 @@ possible if the body to which you are trying to send reports supports them. Some do; many do not. See -[more about integration]({{ site.baseurl }}customising/integration/) +[more about integration]({{ "/customising/integration/" | relative_url }}) to understand the different ways this can work. The first stage of integration is injecting problem reports directly into the body's back-end system. We like -Open311, +Open311, which is an open standard for submitting problem reports to a body automatically (by sending the data directly to a webservice that consumes it). FixMyStreet also has a number of @@ -127,10 +127,10 @@ it](https://www.mysociety.org/blog/open311-explained). In fact, if you're working on an installation that can connect to bodies using a method other than email, not *all* of a body's contacts need to be sent the same way. It's possible to specify a different -send method +send method for an individual contact. To do this you need to tell FixMyStreet that, for this body, the decision of which send method to use can be -devolved +devolved to the contacts. You'll need to edit the body (in `/admin`) and check the box marked "Contacts can be devolved". Then mark each of the contacts that are not using the body's send method (which by default is email) as "devolved", and diff --git a/running/example_press_releases.md b/running/example_press_releases.md index 221bd137534..9a68cfd87b6 100644 --- a/running/example_press_releases.md +++ b/running/example_press_releases.md @@ -14,7 +14,7 @@ Adapt the wording so that it’s suitable for your project — or of course, you may wish to write your own press releases from scratch. Then send it to your media contacts, as described in our -[guide to promoting FixMyStreet]({{site.baseurl}}running/promotion). +[guide to promoting FixMyStreet]({{ "/running/promotion" | relative_url }}). It’s best to copy and paste the text into the body of an email, rather than send it as an attachment: journalists say that they are far more likely to read diff --git a/running/index.md b/running/index.md index 1fd8baf6136..a2a2fa40dde 100644 --- a/running/index.md +++ b/running/index.md @@ -27,7 +27,7 @@ installation at `/admin`. When you first deploy your installation of FixMyStreet, this is just a public directory. Obviously, for a -production +production server you should **restrict access to authorised users only**. For example, if you're running the Apache webserver, you can use `htaccess` to do this. diff --git a/running/promotion.md b/running/promotion.md index 54abdb0c01c..b0ba3caff71 100644 --- a/running/promotion.md +++ b/running/promotion.md @@ -168,7 +168,7 @@ Send details of your launch to any outlet you think will cover it. Be clear and concise: explain what the site is for and how it benefits users. Not sure how to write a press release? -[We’ve provided a template here]({{ site.baseurl }}running/example_press_releases). +[We’ve provided a template here]({{ "/running/example_press_releases" | relative_url }}). You may wish to send out two types of press release: @@ -264,8 +264,8 @@ Set up accounts on whichever social media is most used in your country: in the UK, we have FixMyStreet accounts on Twitter and Facebook. You have the option to set up links to your social media accounts in the site’s footer, report pages, etc: you can -[read more about customising your FixMyStreet site here]({{ site.baseurl }}customising/) -— or [contact us]({{ site.baseurl }}community/) if you need more help. +[read more about customising your FixMyStreet site here]({{ "/customising/" | relative_url }}) +— or [contact us]({{ "/community/" | relative_url }}) if you need more help. You’ll need to monitor your accounts daily, in case people ask you questions that need a prompt reply. The easiest way is to set up your accounts so that @@ -446,7 +446,7 @@ events, blog posts, news stories - you will already have content for your newsletter; you’ll just need to link to it. Make sure you invite users to sign up to your newsletter. Check our -[documentation on customising your site]({{ site.baseurl }}customising/), +[documentation on customising your site]({{ "/customising/" | relative_url }}), or mySociety can help you include a message about the newsletter at various key points, like: diff --git a/running/surveys.md b/running/surveys.md index a319bafb004..37db39c5a14 100644 --- a/running/surveys.md +++ b/running/surveys.md @@ -11,16 +11,16 @@ author: dave email inviting that user to complete a survey (which we also sometimes call a questionnaire). The survey is presented as a page on the site that asks the user about the current - state + state of the problem (for example, it may have been fixed), and lets them add an - update + update too.

      We recommend that you keep this feature enabled, because it gives you useful data about the problems that have been reported on your site, and an indication of the performance of the -bodies +bodies that should be fixing them. Some users will report a problem and then won't really think about it after that. We're happy with this, because it's how the site is supposed to work — reporting a problem is easy and doesn't demand @@ -58,9 +58,9 @@ only because the user agreed to this. The email that is sent out is made using the `questionnaire.txt` template. The default is in `/templates/email/default/`. Of course, you should override this in your own -cobrand +cobrand — see more about -[customising email templates]({{site.baseurl}}customising/templates/#emails). +[customising email templates]({{ "/customising/templates/#emails" | relative_url }}). The email message contains a link to the survey page that includes a token that authenticates the user who submitted the report (this is possible because it is @@ -90,10 +90,10 @@ text of the report that was submitted. ## What's in the survey? The default survey invites the user to make an -update +update to the problem report: - * change the state + * change the state — for example, to _fixed_, because it's been fixed (unless it was already in that state) * add a comment or description (optional) @@ -108,7 +108,7 @@ It also asks: The default template is defined in `/templates/web/default/questionnaire/*`, with the questions in `index`. As with all templates, you can override these with your own cobrand — for details, see -[customising templates]({{site.baseurl}}customising/templates/#emails). +[customising templates]({{ "/customising/templates/#emails" | relative_url }}). Note that if you want to collect other data in your survey, you'll need to update the source code to handle this. @@ -120,7 +120,7 @@ comment is not optional. ## How to see the results You can see the collected results of surveys by logging in as an -administrator +administrator and visiting `admin/questionnaire` in the admin (or click on **Survey** in the admin menu bar). If we are hosting the site for you and you don't have admin access, ask us to send you the results. @@ -158,10 +158,10 @@ had not previously engaged with authorities to do so? How complex these results are will depend to some extent on the states that your site allows. For example, if you've allowed -staff users +staff users to have more detailed states to choose from than the public (such as "fixed — council", or "in progress"), then you'll have more combinations to -deal with. See the [admin manual]({{site.baseurl}}running/admin_manual/) for more +deal with. See the [admin manual]({{ "/running/admin_manual/" | relative_url }}) for more information about the report states that are available to staff users. ## How to turn questionnaire-sending off diff --git a/training/admins.md b/training/admins.md index b8d233b9624..39a3bca9ddc 100644 --- a/training/admins.md +++ b/training/admins.md @@ -16,19 +16,19 @@ Training notes for new administrators

      Basic training notes like these are available for
      - citizens, - staff, and - administrators. + citizens, + staff, and + administrators.

      - Refer to the full documentation + Refer to the full documentation for more detailed information!

      Remember that every FixMyStreet installation is different, and can both look and behave differently, depending on how it has been -[customised]({{site.baseurl}}customising/). +[customised]({{ "/customising/" | relative_url }}). @@ -110,7 +110,7 @@ When a user clicks on the map to report a problem... ## There might be lots of categories! -![example showing many categories]({{ site.baseurl }}assets/img/training/fms-many-categories.png) +![example showing many categories]({{ "/assets/img/training/fms-many-categories.png" | relative_url }}) ## Getting help in the admin @@ -126,7 +126,7 @@ to list all the bodies in your system. * **click on each body's name to see and edit the details** -![example showing many categories]({{ site.baseurl }}assets/img/training/admin-bodies.png) +![example showing many categories]({{ "/assets/img/training/admin-bodies.png" | relative_url }}) ## Configuring bodies and contacts @@ -149,7 +149,7 @@ The key things you need to provide: ## Add a body -![example showing many categories]({{ site.baseurl }}assets/img/training/admin-add-a-body.png) +![example showing many categories]({{ "/assets/img/training/admin-add-a-body.png" | relative_url }}) ### You must specify an area @@ -195,7 +195,7 @@ You need to add contacts to each body. ### Adding a contact -![add a contact/category]({{ site.baseurl }}assets/img/training/admin-add-contact.png) +![add a contact/category]({{ "/assets/img/training/admin-add-contact.png" | relative_url }}) ### Confirm your contacts! @@ -292,7 +292,7 @@ Click on **Reports** -- there's a search box at the top. ### Searching reports -![search reports]({{ site.baseurl }}assets/img/training/admin-search-reports.png) +![search reports]({{ "/assets/img/training/admin-search-reports.png" | relative_url }}) ## What the different timestamps mean @@ -398,7 +398,7 @@ of the page. You can click **Edit** next to any of those to edit them. You can see this on the public site: -![sent yet?]({{ site.baseurl }}assets/img/training/mmi-18-show-when-sent.png) +![sent yet?]({{ "/assets/img/training/mmi-18-show-when-sent.png" | relative_url }}) ..but it's also shown as the "Sent" field if you look at the report in the admin. @@ -422,11 +422,11 @@ To access the users in the admin, click **Users**. The page only list _staff users_ by default. To see other users, use the search box to search across email or name. -![show user]({{ site.baseurl }}assets/img/training/admin-users.png) +![show user]({{ "/assets/img/training/admin-users.png" | relative_url }}) ## Editing a user -![edit user]({{ site.baseurl }}assets/img/training/admin-edit-user.png) +![edit user]({{ "/assets/img/training/admin-edit-user.png" | relative_url }}) ### Change a user's name or email address @@ -480,7 +480,7 @@ when you click **Users**. ### Flagged reports and users -![flagged things]({{ site.baseurl }}assets/img/training/admin-flagged-reports-users.png) +![flagged things]({{ "/assets/img/training/admin-flagged-reports-users.png" | relative_url }}) ## Banning a user: the abuse list @@ -494,15 +494,15 @@ to have access to your site).
      when you are **editing a _report_ or _update_** they submitted -![ban a user]({{ site.baseurl }}assets/img/training/admin-ban-a-user.png) +![ban a user]({{ "/assets/img/training/admin-ban-a-user.png" | relative_url }}) ## Getting statistics -![getting stats]({{ site.baseurl }}assets/img/training/admin-stats-enter-dates.png) +![getting stats]({{ "/assets/img/training/admin-stats-enter-dates.png" | relative_url }}) ## Example of statistics -![output stats]({{ site.baseurl }}assets/img/training/admin-stats.png) +![output stats]({{ "/assets/img/training/admin-stats.png" | relative_url }}) ## Other administration tasks diff --git a/training/citizens.md b/training/citizens.md index 6bd913e7098..fb19a266f9d 100644 --- a/training/citizens.md +++ b/training/citizens.md @@ -15,19 +15,19 @@ Training notes for citizens

      Basic training notes like these are available for
      - citizens, - staff users, and - administrators. + citizens, + staff users, and + administrators.

      - Refer to the full documentation + Refer to the full documentation for more detailed information!

      Remember that every FixMyStreet installation is different, and can both look and behave differently, depending on how it has been -[customised]({{site.baseurl}}customising/). +[customised]({{ "/customising/" | relative_url }}). @@ -65,7 +65,7 @@ click on "Report a problem" anywhere on the site to get started. ## Enter location... -![front page]({{ site.baseurl }}assets/img/training/mmi-01-front-page.png) +![front page]({{ "/assets/img/training/mmi-01-front-page.png" | relative_url }}) ## Start with a general location @@ -80,7 +80,7 @@ click on "Report a problem" anywhere on the site to get started. ## Click on the map... -![click on map]({{ site.baseurl }}assets/img/training/mmi-02-click-on-map.png) +![click on map]({{ "/assets/img/training/mmi-02-click-on-map.png" | relative_url }}) ## Click the map (a pin appears!) @@ -93,7 +93,7 @@ click on "Report a problem" anywhere on the site to get started. ## Enter details... -![enter details]({{ site.baseurl }}assets/img/training/mmi-03-enter-details.png) +![enter details]({{ "/assets/img/training/mmi-03-enter-details.png" | relative_url }}) ## Enter details @@ -114,7 +114,7 @@ click on "Report a problem" anywhere on the site to get started. ## Enter your _own_ details -![enter user details]({{ site.baseurl }}assets/img/training/mmi-04-user-details.png) +![enter user details]({{ "/assets/img/training/mmi-04-user-details.png" | relative_url }}) ## Provide your email address @@ -176,7 +176,7 @@ the same for you, either way. You can see this on the public site: -![sent yet?]({{ site.baseurl }}assets/img/training/mmi-18-show-when-sent.png) +![sent yet?]({{ "/assets/img/training/mmi-18-show-when-sent.png" | relative_url }}) * **the report has not been sent yet** if there's no "Sent to..." sentence @@ -186,7 +186,7 @@ You can see this on the public site: ## Add an update... -![add an update]({{ site.baseurl }}assets/img/training/mmi-05-update.png) +![add an update]({{ "/assets/img/training/mmi-05-update.png" | relative_url }}) ## Add an update to a report @@ -213,7 +213,7 @@ The administrators will be alerted and can hide the report. ## The "report abuse" link -![report abuse]({{ site.baseurl }}assets/img/training/mmi-06-report-abuse.png) +![report abuse]({{ "/assets/img/training/mmi-06-report-abuse.png" | relative_url }}) ## Find problems nearby @@ -227,7 +227,7 @@ If you're looking at a problem report... ## Ask to be notified... -![the get-updates link]({{ site.baseurl }}assets/img/training/mmi-07-get-updates-link.png) +![the get-updates link]({{ "/assets/img/training/mmi-07-get-updates-link.png" | relative_url }}) ## Get email updates @@ -246,7 +246,7 @@ for programmers/other apps. ## Getting updates... -![get updates]({{ site.baseurl }}assets/img/training/mmi-08-get-updates.png) +![get updates]({{ "/assets/img/training/mmi-08-get-updates.png" | relative_url }}) ## Use your account @@ -266,11 +266,11 @@ When you are logged in: ## Signing in... -![sign in screen]({{ site.baseurl }}assets/img/training/mmi-09-login.png) +![sign in screen]({{ "/assets/img/training/mmi-09-login.png" | relative_url }}) ## Your reports -![your reports]({{ site.baseurl }}assets/img/training/mmi-12-your-reports.png) +![your reports]({{ "/assets/img/training/mmi-12-your-reports.png" | relative_url }}) ## Share what you've done! @@ -289,7 +289,7 @@ When you are logged in:
      it always appears somewhere near the top of the screen when you're logged in -![sign out]({{ site.baseurl }}assets/img/training/mmi-17-logout.png) +![sign out]({{ "/assets/img/training/mmi-17-logout.png" | relative_url }}) diff --git a/training/index.md b/training/index.md index 677561d4006..9fcaee9df79 100644 --- a/training/index.md +++ b/training/index.md @@ -16,18 +16,18 @@ FixMyStreet training notes Basic training notes like these are available for

      - Refer to the full documentation + Refer to the full documentation for more detailed information!

      Remember that every FixMyStreet installation is different, and can both look and behave differently, depending on how it has been -[customised]({{site.baseurl}}customising/). +[customised]({{ "/customising/" | relative_url }}). diff --git a/training/staff.md b/training/staff.md index 65d771edf60..0216bd62fbf 100644 --- a/training/staff.md +++ b/training/staff.md @@ -16,19 +16,19 @@ Training notes for new staff users

      Basic training notes like these are available for
      - citizens, - staff, and - administrators. + citizens, + staff, and + administrators.

      - Refer to the full documentation + Refer to the full documentation for more detailed information!

      Remember that every FixMyStreet installation is different, and can both look and behave differently, depending on how it has been -[customised]({{site.baseurl}}customising/). +[customised]({{ "/customising/" | relative_url }}). @@ -108,7 +108,7 @@ need an administrator to convert your account to a *staff account*. ## Signing up -![sign in screen]({{ site.baseurl }}assets/img/training/mmi-09-login.png) +![sign in screen]({{ "/assets/img/training/mmi-09-login.png" | relative_url }}) ## How to log in @@ -150,7 +150,7 @@ in! ### Add an update... -![add an update]({{ site.baseurl }}assets/img/training/mmi-05-update.png) +![add an update]({{ "/assets/img/training/mmi-05-update.png" | relative_url }}) ## Change a report's state @@ -173,13 +173,13 @@ When you're logged in with a staff account, you can ### More states available to a staff user -![staff states]({{ site.baseurl }}assets/img/training/mmi-15-staff-states.png) +![staff states]({{ "/assets/img/training/mmi-15-staff-states.png" | relative_url }}) ## This is what a fixed problem looks like The problem report has a green tag marked "fixed"! -![it is fixed]({{ site.baseurl }}assets/img/training/mmi-16-woo-it-is-fixed.png) +![it is fixed]({{ "/assets/img/training/mmi-16-woo-it-is-fixed.png" | relative_url }}) ## Hiding reports @@ -195,7 +195,7 @@ can report a problem report if it contains offensive or inappropriate material. ## The "remove from site" link -![remove from site]({{ site.baseurl }}assets/img/training/mmi-13-staff-remove-from-site.png) +![remove from site]({{ "/assets/img/training/mmi-13-staff-remove-from-site.png" | relative_url }}) ## View all reports for your body @@ -232,7 +232,7 @@ People are happy to know you're reporting problems when you find them. * be extra careful: **do not to leave a staff account logged in!** -![sign out]({{ site.baseurl }}assets/img/training/mmi-17-logout.png) +![sign out]({{ "/assets/img/training/mmi-17-logout.png" | relative_url }})