Merge branch 'various-manual-updates'

8 files changed, 94 insertions, 41 deletions

diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md
index 765e96370..ac9e81f9e 100644
--- a/docs/_includes/admin-tasks-content.md
+++ b/docs/_includes/admin-tasks-content.md
@@ -4,9 +4,11 @@
 
 <img alt="When you're logged in as an administrator the 'admin' button is in the navigation menu" src="/assets/img/pro-user-guide/navigating-as-pro-staff.png" class="admin-screenshot" />
 
-If your Administrator has already given you staff permissions, you’ll see additional admin button
-on the top menu when you’re logged in. If not, your Administrator can add these permissions at
-any time: see ‘[Creating a Staff Account](#adminstrating-staff-accounts)’.
+If your Administrator has already given you staff permissions, you may see
+additional admin button on the top menu when you’re logged in. If not, your
+access may be only in the frontend (e.g. moderation does not require any
+backend admin access), or your Administrator can add these permissions at any
+time: see ‘[Creating a Staff Account](#adminstrating-staff-accounts)’.
 </div>
 
 <div class="admin-task" markdown="1" id="viewing-reports-your-area">
@@ -18,14 +20,15 @@ any time: see ‘[Creating a Staff Account](#adminstrating-staff-accounts)’.
 If you want to view everything that’s been reported within the council area, here’s the quickest
 way.
 
-Click on ‘all reports’ in the top menu. You’ll see the boundaries of your council area on the map,
-and a list of all reports listed, with the most recent reports at the top, on the left hand panel.
+Click on ‘all reports’ in the top menu. You’ll see the boundaries of your
+council area on the map, and a list of all reports listed, with the most
+recently updated reports at the top, in the left hand panel.
 
 <img alt="Click all reports in the top menu to view all reports in an area" src="/assets/img/pro-user-guide/viewing-reports-your-area.png" class="admin-screenshot" />
 
 Note that staff members can be allocated one or more category (e.g. potholes, streetlights, etc) by
 the Administrator — see ‘[Creating a Staff Account](#adminstrating-staff-accounts)’ for more details. When logged in, these staff
-members will see reports within these categories by default.
+members will only see reports within those categories by default.
 
 </div>
 
@@ -111,25 +114,16 @@ to access the full report admin editing page.
 
 <div class="admin-task" markdown="1" id="search-user">
 
-### Searching for a user
+### User admin
 
 <span class="admin-task__permissions">Permissions required: User must be marked
 as staff; “Edit users' details/search for their reports” must be ticked</span>
 
-Click on ‘admin’ in the top menu bar.
-
-Enter any part of the user’s name or email address in the ‘Search users’ box.
-
-</div>
-
-<div class="admin-task" markdown="1" id="editing-users-information">
-
-### Editing a user’s information
-
-<span class="admin-task__permissions">Permissions required: User must be marked as staff; "Edit users' details/search for their reports" must be ticked.</span>
-
-Click on ‘Edit’ beside any user to view or change their account details.
-Or, click the user’s email address to view a list of all reports and updates made by that user.
+In the admin, enter any part of the user’s name or email address in the ‘Search
+users’ box. You may click on ‘Edit’ beside any user to view or change their
+account details, click the user’s email address to view a list of all reports
+and updates made by that user, or click ‘Timeline’ to see a timeline of that
+user’s activities on the site.
 
 </div>
 
@@ -528,6 +522,17 @@ staff user only deals with reports of a specific type.
 To remove an account, the Administrator-level member of staff should make contact with
 mySociety.
 
+#### Two-factor authentication
+
+Any staff user can choose to set up two-factor authentication on their account.
+To do this, they will need an app on their phone that can generate time-based
+authentication keys, such as Google Authenticator or a password manager. Then.
+they can visit their account page on the site and select ‘Activate two-factor
+authentication’ to receive a QR code to scan with the app.
+
+If you wish your organisation to have mandated two-factor authentication,
+please get in touch.
+
 </div>
 
 <div class="admin-task" markdown="1" id="creating-editing-categories">
@@ -538,9 +543,11 @@ mySociety.
 
 #### Note
 
-If your FixMyStreet Pro installation has been integrated with a CRM system, this
-section does not apply. In such cases, categories are managed from within the CRM, and
-FixMyStreet will be set up to work with these.
+If your FixMyStreet Pro installation has been integrated with a CRM system,
+this section might not fully apply; it is possible categories are managed from
+within the CRM, and FixMyStreet will be set up to work with these. Some
+installations only integrate on some categories, and some sections such as form
+disabling can still be used on top of an integration.
 
 </div>
 
@@ -572,6 +579,15 @@ for information on <a
 href="#creating-editing-notices">creating/editing extra notices and
 questions</a> for a category.
 
+You may also be able to configure categories to allow anonymous
+reporting if you have this option available. If this is not available then
+contact us to discuss it.
+
+Categories can be made ‘staff only’, where they are only available to logged-in
+members of staff, not members of the public. This could be used for e.g.
+contact centre staff to leave reports in categories that you still want to be
+phoned in.
+
 You can set up as many or as few categories as you like, and each category can have its own email
 address attached to it, so for example, reports about potholes may go to one council email
 address, while reports about road signs go to another. More than one category may share the
@@ -770,12 +786,13 @@ above, ‘Creating a template’. Additionally you can delete the template from
 
 <span class="admin-task__permissions">Permissions required: User must be marked as staff</span>
 
-When you first log in to the Admin area, you’ll see some top-level stats at the foot of the page,
-including the number of reports published on the site, the number of updates, the number of
-alerts set up and the number of user questionnaires sent out. This can be useful for a quick
-snapshot of activity.
+When you log in to the Admin area and click Stats in the admin navigation,
+you’ll see some top-level statistics, including the number of reports published
+on the site, the number of updates, and the number of alerts set up. This can
+be useful for a quick snapshot of activity.
 
-For a more detailed breakdown, visit the stats dashboard. This can be accessed by typing
+For a more detailed breakdown, visit the stats dashboard. This can be accessed
+by going to "Summary statistics" from the admin stats page, or by typing
 ‘/dashboard’ on the end of your FixMyStreet url.
 
 From here, you can access statistics on:
@@ -797,6 +814,16 @@ You can also group the results by:
 Android device or via an iOS device).
 
 These statistics can be downloaded as a CSV document, suitable for use in a spreadsheet program
-such as Excel.
+such as Excel or your own reporting tools.
+
+#### Heatmap
+
+Also accessible from the admin stats page is our heatmap. This can provide an
+overview of reporting in your area, filtered by state, category, or ward, for a
+particular date range:
+
+<img alt="Screenshot of Bromley heatmap showing clusters in the north and north west."
+    src="https://user-images.githubusercontent.com/4776/72752804-0eb6b700-3bbb-11ea-915b-5afde5235014.png">
+
 
 </div>
diff --git a/docs/_layouts/pro.html b/docs/_layouts/pro.html
index d79163989..d04446a6e 100644
--- a/docs/_layouts/pro.html
+++ b/docs/_layouts/pro.html
@@ -95,8 +95,7 @@
                       <li><a href="/pro-manual/admin-tasks/#filtering-sorting-reports">Filtering and sorting reports</a></li>
                       <li><a href="/pro-manual/admin-tasks/#view-single-report">Viewing a single report</a></li>
                       <li><a href="/pro-manual/admin-tasks/#search-report">Searching for a report</a></li>
-                      <li><a href="/pro-manual/admin-tasks/#search-user">Searching for a user</a></li>
-                      <li><a href="/pro-manual/admin-tasks/#editing-users-information">Editing a user’s information</a></li>
+                      <li><a href="/pro-manual/admin-tasks/#search-user">User search/edit</a></li>
                       <li><a href="/pro-manual/admin-tasks/#view-reports-non-staff-user">Viewing reports as a non-staff user</a></li>
                       <li><a href="/pro-manual/admin-tasks/#create-reports-behalf-user">Creating reports on behalf of another user</a></li>
                       <li><a href="/pro-manual/admin-tasks/#deal-undesirable-content">Dealing with undesirable content</a></li>
@@ -110,7 +109,7 @@
                       <li><a href="/pro-manual/admin-tasks/#creating-editing-notices">Creating and editing category notices/questions</a></li>
                       <li><a href="/pro-manual/admin-tasks/#creating-editing-priorities">Creating and editing priorities</a></li>
                       <li><a href="/pro-manual/admin-tasks/#creating-editing-response-templates">Creating and editing response templates</a></li>
-                      <li><a href="/pro-manual/admin-tasks/#view-statistics">Viewing statistics</a></li>
+                      <li><a href="/pro-manual/admin-tasks/#view-statistics">Viewing statistics/heatmap</a></li>
                     </ul>
                   </li>
               </ul>
diff --git a/docs/assets/img/pro-user-guide/edit-category-page.png b/docs/assets/img/pro-user-guide/edit-category-page.png
index db84bbb70..f78b00a1c 100755
--- a/docs/assets/img/pro-user-guide/edit-category-page.png
+++ b/docs/assets/img/pro-user-guide/edit-category-page.png
diff --git a/docs/install/manual-install.md b/docs/install/manual-install.md
index 5ddf8a30f..408b419cb 100644
--- a/docs/install/manual-install.md
+++ b/docs/install/manual-install.md
@@ -177,6 +177,13 @@ $ script/server
 The server will be accessible as <http://localhost:3000/>, and will
 automatically restart if you update the code or `general.yml`.
 
+If you need to run the server under HTTPS, to e.g. develop the service worker
+or geolocation, then you can run `script/server --listen :3000:ssl
+--ssl-cert=my.crt --ssl-key=my.key --Reload perllib,conf` where my.crt and
+my.key point to a key and self-signed certificate you have generated using
+something like `openssl req -x509 -newkey rsa:4096 -sha256 -nodes -keyout
+my.key -out my.crt -subj "/CN=My local CA" -days 3650`.
+
 ### Post-install: Things you might want to change
 
 #### Next Steps
diff --git a/docs/install/vagrant.md b/docs/install/vagrant.md
index 55b7802ac..1c335ab5d 100644
--- a/docs/install/vagrant.md
+++ b/docs/install/vagrant.md
@@ -69,6 +69,13 @@ The username and password to access the admin (at address
 `http://fixmystreet.127.0.0.1.xip.io:3000/admin/`) will have been shown at the
 end of the `vagrant up` output.
 
+If you need to run the server under HTTPS, to e.g. develop the service worker
+or geolocation, then you can run `script/server --listen :3000:ssl
+--ssl-cert=my.crt --ssl-key=my.key --Reload perllib,conf` where my.crt and
+my.key point to a key and self-signed certificate you have generated using
+something like `openssl req -x509 -newkey rsa:4096 -sha256 -nodes -keyout
+my.key -out my.crt -subj "/CN=My local CA" -days 3650`.
+
 ## Editing a cobrand
 
 If you're working on a cobrand in an external repository, you will want that
diff --git a/docs/pro-manual/admin-tasks.md b/docs/pro-manual/admin-tasks.md
index d4f48a5eb..7beefab31 100644
--- a/docs/pro-manual/admin-tasks.md
+++ b/docs/pro-manual/admin-tasks.md
@@ -22,7 +22,5 @@ via a role) for you to be able to perform this task.
 
 - 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).
+- For any technical problems and queries, Administrators may contact the
+  FixMyStreet team by raising a ticket through their helpdesk system.
diff --git a/docs/pro-manual/citizens-experience.md b/docs/pro-manual/citizens-experience.md
index f47c2a124..5e7bfd0f7 100644
--- a/docs/pro-manual/citizens-experience.md
+++ b/docs/pro-manual/citizens-experience.md
@@ -22,13 +22,17 @@ When a citizen sees a problem and wishes to report it, they can do so in one of
 <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
-
+- On [FixMyStreet.com](https://www.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.
 
+The FixMyStreet website, and the council’s branded version, can also be
+installed as a ‘web app’ – providing a logo on their homescreen that users can
+treat like a native app without the hassle of app stores. If that’s something
+that would be of interest for your installation, please get in touch.
+
 <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>
@@ -101,4 +105,4 @@ and you’ll be offered a range of options: you can subscribe to every report ma
 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
+aware of issues as they arise.
diff --git a/docs/pro-manual/staff-user-accounts.md b/docs/pro-manual/staff-user-accounts.md
index 37997ada2..3efa4f41f 100644
--- a/docs/pro-manual/staff-user-accounts.md
+++ b/docs/pro-manual/staff-user-accounts.md
@@ -35,6 +35,17 @@ Your password must contain 6 or more characters, and must not be one of the most
 used combinations (such as ‘Password’ or ‘123456’). Your council may also have password policies
 which you are expected to abide by.
 
+### Two-factor authentication
+
+Any staff user can choose to set up two-factor authentication on their account.
+To do this, they will need an app on their phone that can generate time-based
+authentication keys, such as Google Authenticator or a password manager. Then.
+they can visit their account page on the site and select ‘Activate two-factor
+authentication’ to receive a QR code to scan with the app.
+
+If you wish your organisation to have mandated two-factor authentication,
+please get in touch.
+
 ### How to log out
 
 Click on ‘Your account’ in the top menu, then click ‘Sign out’.