Move docs from gh-pages branch.

5 files changed, 389 insertions, 0 deletions

diff --git a/docs/pro-manual/admin-tasks.md b/docs/pro-manual/admin-tasks.md
new file mode 100644
index 000000000..3dd6e30e1
--- /dev/null
+++ b/docs/pro-manual/admin-tasks.md
@@ -0,0 +1,23 @@
+---
+layout: pro
+title: Administrator tasks
+order: 4
+user-guide: true
+---
+
+# Administrator tasks
+
+If you find that you cannot perform any of the tasks detailed below when logged into your FixMyStreet account, it is likely that your account has not been given the relevant permissions.
+
+Contact your account administrator to request these permissions. Accompanying each task covered in this document, you will see ‘permissions required’, listing the checkboxes an Administrator must tick on your account for you to be able to perform this task.
+
+{% include admin-tasks-content.md %}
+
+### Further help
+
+- If you’re a member of council staff using FixMyStreet Pro, questions should be addressed
+to your Administrator.
+- For technical problems and queries, Administrators may contact the FixMyStreet team on
+[bettercities@mysociety.org](mailto:bettercities@mysociety.org).
+- Is something not quite right, or missing from this documentation? Let us know on
+[bettercities@mysociety.org](mailto:bettercities@mysociety.org).
diff --git a/docs/pro-manual/citizens-experience.md b/docs/pro-manual/citizens-experience.md
new file mode 100644
index 000000000..f47c2a124
--- /dev/null
+++ b/docs/pro-manual/citizens-experience.md
@@ -0,0 +1,104 @@
+---
+layout: pro
+title: What is FixMyStreet Pro?
+order: 2
+user-guide: true
+category: user-guide
+---
+
+# The citizen’s experience
+
+Before we can fully explore FixMyStreet Pro’s tools for council staff, it’s important to understand
+the report-making process from the citizen’s point of view.
+
+Here’s a brief look at how a citizen’s experience when reporting an issue located within the
+boundaries of a council using FixMyStreet Pro.
+
+## Making a report
+
+### Where to report
+When a citizen sees a problem and wishes to report it, they can do so in one of three places:
+
+<img alt="Make a report on a council website, fixmystreet.com, or via the FixMyStreet app" src="/assets/img/pro-user-guide/all-the-sites.png" />
+
+- Through the council website, on the council’s branded FixMyStreet instance
+- On FixMyStreet.com, the UK-wide site
+- Via the FixMystreet app
+
+
+No matter which of these channels they use, the report will be visible in all three places. All
+FixMyStreet instances draw from the same database of reports.
+
+<div class="boxout" markdown="1">
+
+<h4 class="boxout__title">What if a user makes a report on the council site, but it’s the responsibility of a different authority?</h4>
+
+That’s fine: FixMyStreet will simply channel it to the correct authority. If it’s within your council boundaries (so, if you are within a two- or three-tier area, and the report category is handled by a different council) the report will still show on the map, but it won’t go into your workflow.
+
+If a user attempts to make a report in a location outside your council boundaries, they’re guided to the main FixMyStreet website.
+
+</div>
+
+### Identifying the report location 
+
+<img alt="The start page invites the resident to search for the location of their issue" src="/assets/img/pro-user-guide/home.png" class="admin-screenshot" />
+
+FixMyStreet’s start page invites the resident to search for the location of their issue, by entering any part of an address, for example a street name or postcode. Alternatively they can allow the site to identify their location automatically.
+
+They’re then taken to a map, centred on this location. The user can pan and zoom the map until they find the exact position of the issue they are reporting. Councils on the ‘Avenue’ price tier may
+choose to include GIS data showing assets such as streetlights or trees which may enable further accuracy.
+
+<img alt="Existing reports are visible to reduce the chance of duplicates" src="/assets/img/pro-user-guide/making-report-duplicates.png"  class="admin-screenshot"/>
+
+All reports are published online, so at this stage, citizens can see if their issue has already been reported. If they find an existing report they may choose to add an update instead of making their own report.
+
+If not, they place a pin on the map and make their report.
+
+<img alt="When a report is made the details are added via a web form" src="/assets/img/pro-user-guide/making-report.png" class="admin-screenshot" />
+
+They are asked for:
+
+- A category, selected from those provided by the council
+- A title
+- A description
+- Their contact details (if they have previously registered, these do not need to be
+    re-entered)
+- Any other information that the council has stipulated as a requirement, eg for potholes
+    you may add a field which asks for the dimensions.
+
+If the user is not registered or logged in, they may confirm their report by email.
+Note that although it is obligatory to include a name and contact details, the user may opt for their
+name not to be shown on the public report page. Of course, their other contact details are only
+sent to the council and are never made public.
+
+## Receiving a response
+
+<img alt="Reponses from the council via email and published on the report page" src="/assets/img/pro-user-guide/report-response.png" class="admin-screenshot" />
+
+Responses from the council come directly back to the user, via the email address they used to
+make the report. Where councils have opted for full integration with FixMyStreet Pro, responses
+may also be posted as automatic updates on the report. Responses may take the form of a request
+for further information or an update on the status of the issue.
+
+### Updates from other users
+
+FixMyStreet reports are public, and other users may also add updates. This creates an informal
+community forum, and also provides a useful way for the council to understand which issues have
+the highest visibility or create the most dissatisfaction among residents. Any updates on a report
+are sent by email to the report maker, unless they opt out.
+
+## Subscribing to alerts
+
+<img alt="Reponses from the council via email and published on the report page" src="/assets/img/pro-user-guide/local-alerts.png" class="admin-screenshot" />
+
+FixMyStreet users can sign up to receive an email every time a report is made within a specified
+area. This can be useful for anyone who wants to keep an eye on issues within their
+neighbourhood: it’s often used by councillors, community groups, journalists and neighbourhood
+policing teams, as well as by residents.
+
+To set up an email alert, click on ‘Local alerts’ in the top menu bar. Input a postcode or place name
+and you’ll be offered a range of options: you can subscribe to every report made within the entire
+council area; every report made within a particular ward; or within an area roughly covering a
+population of 200,000 people (the size of this area varies with population density).
+Staff need not normally do this, as they will be working in the reports interface daily, and will be
+aware of issues as they arise.
\ No newline at end of file
diff --git a/docs/pro-manual/index.md b/docs/pro-manual/index.md
new file mode 100644
index 000000000..85ed8377f
--- /dev/null
+++ b/docs/pro-manual/index.md
@@ -0,0 +1,61 @@
+---
+layout: pro
+title: What is FixMyStreet Pro?
+order: 1
+user-guide: true
+category: user-guide
+---
+
+# What is FixMyStreet Pro?
+
+## History & background
+
+<img alt="This is FixMyStreet Pro" src="/assets/img/pro-user-guide/all-the-sites.png" />
+
+FixMyStreet Pro is a service for councils, which grew out of the website FixMyStreet.com.
+Set up in 2007 by the not-for-profit organisation mySociety, and still running today,
+FixMyStreet.com ​makes it simple for any citizen to report a public street issue, such as graffiti,
+broken streetlights, unsafe paving, highways maintenance or potholes. It covers the whole of the
+UK.
+
+Reports made through FixMyStreet.com are published on the website and sent — primarily by
+email — to the correct UK council for resolution. Councils do not need to have purchased
+FixMyStreet Pro in order to receive these reports, but FixMyStreet Pro adds enhanced functionality
+for staff users, as well as the ability to integrate a tailored version of FixMyStreet on the council
+website as their fault reporting interface.
+
+FixMyStreet has a number of benefits for users. These include:
+-  A strong focus on usability, with an interface that practically anyone can use and
+understand;
+-  No knowledge required as to which council is responsible for a report: the website sends
+reports to the correct authority based on the category and location selected;
+-  Reports are published online, building up a picture of issues in the area, so it’s easy to see
+recurrent problems and resolution rates.
+There are benefits for councils, too:
+-  Reports are sent to the correct authority, based on category and location;
+-  Because reports are published online, residents can easily see if an issue has been
+reported before, helping cut down on duplicates;
+-  The site gives residents a clear illustration of the often otherwise hidden work the council
+has been doing to improve neighbourhoods and communities.
+
+In 2012, mySociety began to develop FixMyStreet as a tool which would be as useful for council
+staff as it is for citizens. FixMyStreet Pro is now a fully-featured cloud-based service which not only
+allows councils to place the report-making functionality on their own websites, but which also provides a number of tools to make report tracking, prioritising and resolution simpler. These have
+been developed in consultation with UK councils.
+
+## FixMyStreet Pro’s features for council staff
+
+FixMyStreet Pro offers enhanced features to client councils, including:
+-  A FixMyStreet instance for the council website, providing the council's fault-reporting
+interface, and branded to look like the rest of the site
+-  A variety of permissions which can be allocated to staff at a granular level
+-  Simple channels of communication with report makers, through status updates and
+template responses
+-  The ability to moderate, edit or remove reports
+-  Statistical breakdowns of reports
+Depending on which type of installation the council has opted for, there may also be access to:
+-  Integration with the council’s existing systems, including CRM tools
+-  The ability to view and update reports even when offline
+-  Workflow prioritisation and shortlist generation
+-  The integration of council-owned assets, such as bins or streetlights, into the map
+interface
\ No newline at end of file
diff --git a/docs/pro-manual/print.md b/docs/pro-manual/print.md
new file mode 100644
index 000000000..f69ebe9d6
--- /dev/null
+++ b/docs/pro-manual/print.md
@@ -0,0 +1,5 @@
+---
+layout: pro-print
+title: FixMyStreet Pro User Manual
+bodyclass: user-guide-print
+---
\ No newline at end of file
diff --git a/docs/pro-manual/staff-user-accounts.md b/docs/pro-manual/staff-user-accounts.md
new file mode 100644
index 000000000..3712dfcf5
--- /dev/null
+++ b/docs/pro-manual/staff-user-accounts.md
@@ -0,0 +1,196 @@
+---
+layout: pro
+title: FixMyStreet Pro staff user accounts
+order: 3
+user-guide: true
+categories: user-guide
+---
+
+# FixMyStreet Pro staff user accounts
+
+Now you know how FixMyStreet works from the residents’ point of view, it’s time to look at how
+staff can access and use the admin tools.
+
+## Logging in
+
+Council staff accounts are managed by Administrator-level users.
+
+Contact your Administrator/s if you encounter any problems logging in, or any other aspect of
+account management.
+
+### How to log in
+
+Go to your council’s FixMyStreet installation, click on ‘sign in’, and enter your council email
+address.
+
+You’ll be invited to enter your password if you already have one (i.e, if you have an existing
+FixMyStreet account associated with this email address). If not, go to ‘No, let me sign in by email’.
+
+Decide on a password and enter it in the password box, then click ‘sign in’. A confirmation email
+will be sent to the email address you provided.
+
+### Password security
+
+Your password must contain 6 or more characters, and must not be one of the most commonly
+used combinations (such as ‘Password’ or ‘123456’). Your council may also have password policies
+which you are expected to abide by.
+
+### How to log out
+
+Click on ‘Your account’ in the top menu, then click ‘Sign out’.
+If you are using a device or computer that is shared with others, we advise always logging out at
+the end of your session.
+
+## Changing your password
+
+You can change your password at any time by clicking on ‘Your account’ in the top menu bar.
+
+
+## Permissions
+
+Staff accounts can be assigned a variety of permissions, depending on each team member’s needs
+or responsibilities. Permissions can be combined in any way.
+
+Some common staff roles and the appropriate permissions are shown in the table below, but you
+can tailor your permissions to best reflect your team’s operations.
+
+
+<table class="table table--responsive">
+<thead>
+    <tr>
+        <th></th>
+        <th scope="col">Customer Services</th>
+        <th scope="col">Inspectors</th>
+        <th scope="col">Internal maintenance teams</th>
+        <th scope="col">Administrators</th>
+    </tr>
+</thead>
+<tbody>
+    <tr>
+        <th scope="row">View all reports across the council area</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">View a single report</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Acknowledge a report</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Provide an update on a report</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Create reports on another user’s behalf</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Prioritise a report</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Moderate a report</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Hide a report</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Update a report’s status</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Ask for more information</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Use template responses</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Create template responses</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Make a shortlist</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">View reports offline</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Manage staff accounts</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Set categories</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Access dashboard: summary, timeline, stats</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+    <tr>
+        <th scope="row">Set priority parameters</th>
+        <td data-label="Customer Services"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Inspectors"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Internal maintenance teams"><i class="boolean-icon boolean-icon--no">No</i></td>
+        <td data-label="Administrators"><i class="boolean-icon boolean-icon--yes">Yes</i></td>
+    </tr>
+</tbody>
+</table>