[DOCS] Add bulk of general use documentation

docs/source/2-configuration.md

@@ -44,7 +44,7 @@ If desired, you can adjust the site's theming through the admin dashboard. All o
 - Change the heading font weight (i.e. thickness) by expanding the `Headings` section and replacing the content of the `Headings font weight` field.
 - Change the heading line height by expanding the `Headings` section and replacing the content of the `Headings line height` field.
 
-Then click save.
+Then click `Save`.
 
 ### Main Configuration Options
 
@@ -73,11 +73,11 @@ There are several general settings which must be configured. Open the admin dash
 21. `PARENT_PROJECT_NAME`: The name of the project's parent project, if one exists.
 22. `PROJECT_LEAD`: The project's lead person, organisation, or similar.
 23. `PROJECT_TAGLINE`: The project's tagline.
-24. `ALLOW_SIGNUPS`: Whether new users should be able to sign themselves up through the site.
+24. `ALLOW_SIGNUPS`: Whether new users should be able to sign themselves up through the site. This is useful for minimising the number of users that must be manually created, and it is recommended that this feature is disabled once all users have created their accounts.
 25. `ENABLE_GOOGLE_LOGIN`: Whether login through Google should be enabled. Only enable this if Google login has been configured. See [Google login](#google).
 25. `ENABLE_MICROSOFT_LOGIN`: Whether login through Microsoft should be enabled. Only enable this if Microsoft login has been configured. See [Microsoft login](#microsoft).
 
-Then click save.
+Then click `Save`.
 
 ### Questions
 
@@ -95,7 +95,7 @@ There are several types of questions, but they all have the same set of informat
 - Question choices
 	- Text: The main text of the option.
 	- Order: The priority order for the option to be displayed in. Lower priority options will be displayed earlier in the list of options.
-	- Is negative response: Only applicable for relationship questions. Whether the option indicates that there is no relationship with the individual or organisation. This allows automatic population of questions if there is no relationship to report. All options marked as negative responses will be selected when this button is pressed.
+	- Is negative response: Only applicable for relationship questions. Whether the option indicates the relationship is of the lowest level of closeness. This allows automatic population of questions if the relationship being reported is not at all close. All options marked as negative responses will be selected when this button is pressed.
 	- Delete?: Whether the option should be deleted when the question is saved.
 
 There are various types of questions, which can be added by clicking `Add` next to the appropriate section in the admin dashboard:
@@ -105,15 +105,39 @@ There are various types of questions, which can be added by clicking `Add` next
 - Person questions: Questions that are shown when creating a person or updating their details.
 - Relationship questions: Questions that are shown when reporting a relationship with a person.
 
+### Existing Questions
+
+Some "person questions" (i.e. questions about people) are preset, but require answers to be provided.
+
+1. In the admin dashboard, click `Person questions` under `PEOPLE`, then select each of the following questions in turn:
+
+	- Disciplines
+	- Research theme affiliation
+	- Role
+
+2. For each question, provide a set of possible answers as per the instructions [above](#questions).
+
+:::{note}
+At least one organisation must also exist for people to be able to create their profiles (unless the organisation question is removed). To create an organisation follow the instructions [below](#organisations).
+:::
+
 ### Organisations
 
-Organisations are created through the main site (not the admin dashboard). Go to the `Organisations` page, and click `New Organisation`. Answer the questions shown to create the organisation.
+Organisations are created through the main site (not the admin dashboard).
+
+1. Click `Organisations` in the banner at the top of the screen.
+2. Click `New Organisation` at the top of the page.
+2. Answer the questions shown.
+4. Finally click `Submit`.
 
 ### People
 
 Organisations are created through the main site (not the admin dashboard). People should only be created when it is known that the person will not have a login of their own to the site - e.g. for researchers logging data for multiple individuals.
 
-To create a person, go to the `People` page, and click `New Person`. Answer the questions shown to create the person.
+1. Click `People` in the banner at the top of the screen.
+2. Click `New Person` at the top of the page.
+2. Answer the questions shown.
+4. Finally click `Submit`.
 
 ## Federated Login
 
@@ -132,7 +156,7 @@ Then:
 - Enter the client secret from Google in the `Secret key` field.
 - Leave the `Key` field blank.
 - Click `Choose all` under the `Available sites` box, to enable Google login on this site.
-- Click save.
+- Click `Save`.
 
 Then enable Google login with the `ENABLE_GOOGLE_LOGIN` option in the `Config` section of the admin dashboard.
 
@@ -149,12 +173,16 @@ Then:
 - Enter the client secret value from Google in the `Secret key` field.
 - Leave the `Key` field blank.
 - Click `Choose all` under the `Available sites` box, to enable Google login on this site.
-- Click save.
+- Click `Save`.
 
 Then enable Microsoft login with the `ENABLE_MICROSOFT_LOGIN` option in the `Config` section of the admin dashboard.
 
-## Inviting Other Users
+## Inviting Users
 
 In the admin dashboard, click `Add` next to `Users`. Choose a username for them, enter their email address, and enter a temporary password. It does not matter what this password is, and you do not need to remember or store it, as the new user is automatically sent an email welcoming them to the platform and containing instructions for how to reset their password.
 
-If the user you wish to invite already has a `Person` created for them, they will already have an account with a random username and login disabled. To find this account, go to `People` (in the `People` section) in the admin dashboard and select the appropriate person. Then click the blue eye icon next to the `User` field. This will take you to the user, and you can then change their username along with add a first name, last name, and email address. Note that a welcome email will not be sent to the user in this case, so you will have to let them know that their account is active and what their username is. They can use the *forgot password* option when logging in to set their password.
+If the user you wish to invite already has a `Person` created for them, they will already have an account with a random username and login disabled. To find this account, go to `People` (in the `People` section) in the admin dashboard and select the appropriate person. Then click the blue eye icon next to the `User` field.
+
+![Person's user relation with blue eye icon](images/2-person-user.png "Person's user relation with blue eye icon")
+
+This will take you to the user, and you can then change their username along with add a first name, last name, and email address. Note that a welcome email will not be sent to the user in this case, so you will have to let them know that their account is active and what their username is. They can use the *forgot password* option when logging in to set their password.

docs/source/3-admin-usage.md

@@ -0,0 +1,74 @@
+# Admin Usage
+
+You will need to log in with an administrator account to perform these actions.
+
+:::{important}
+Admin dashboard: this is the admin section of the site, accessed by clicking `Admin` on the navigation bar at the top.
+:::
+
+## Inviting Users
+
+Please see [Configuration](2-configuration#inviting-users).
+
+## Deleting Users
+
+If you wish to permanently delete a user and their data:
+
+1. Open the admin dashboard and click `Users`, in the `PEOPLE` section.
+2. Locate and click the user you wish to delete.
+3. Scroll to the bottom of the page and click `Delete`.
+
+## Disable Login for a User
+
+If you wish to disable login for a user but retain their data (relationships and personal details):
+
+1. Open the admin dashboard and click `Users`, in the `PEOPLE` section.
+2. Locate and click the user you wish to delete.
+3. Under `Permissions`, disable `Active`.
+4. Scroll to the bottom and click `Save`.
+
+To allow the user to log in again, perform the same actions but enable the `Active` option.
+
+## Promoting a User to Administrator
+
+The user you wish to make an administrator must already exist. Then:
+
+1. Open the admin dashboard and click `Users`, in the `PEOPLE` section.
+2. Locate and click the user you wish to delete.
+3. Under `Permissions`, enable `Staff status` and `Superuser status`.
+4. Scroll to the bottom and click `Save`.
+
+## Edit an Activity
+
+1. Open the admin dashboard and click `Activities`, in the `ACTIVITIES` section.
+2. Locate and click the activity you wish to update.
+3. Update the fields appropriately.
+4. Finally click `Save`.
+
+## View a Map of People and Organisations
+
+To view an interactive map showing people and organisations that have recorded their locations, click `Map` in the banner at the top of the screen. You can toggle the visibility of people and organisations with the buttons at the top of the page.
+
+Nodes for people on the map have the same colour as the buttons at the top of the page. Nodes can be clicked the name of the person or organisation they represent, and this can be clicked to view their profile.
+
+:::{note}
+This page is only available to administrators.
+:::
+
+## View a Graph of the Network
+
+The network mapper provides an interface to view the network as a graph. To access it, click `Network` in the banner at the top of the screen. This graph can be customised with various filters as shown on the page. Setting the date will show the state of the network as it was on the given date. People and organisations can be anonymised, organisations can be hidden, and the graph can be downloaded as an image. These options are all available as buttons on the page.
+
+The graph can also be manipulated with the mouse.
+
+:::{note}
+This page is only available to administrators.
+:::
+
+## Export Data
+
+All data relating to the network can be exported as CSV files. To do this, click `Export` in the banner at the top of the screen, then click `Export` next to the data you wish to export. This can then be manipulated as a spreadsheet or with a tool like R to perform more complex data analysis than is available natively in the network mapper.
+
+:::{note}
+This page is only available to administrators.
+:::

docs/source/4-general-usage.md

@@ -0,0 +1,92 @@
+# General Usage
+
+## Create Your Profile
+
+Until you have created your profile, you will be prompted to do so. You cannot add relationships until this has been done. To create your profile:
+
+1. Click `Profile` in the banner at the top of the screen.
+
+	![Profile banner](images/4-profile-banner.png "Profile banner")
+
+2. Fill in your name and continue to the next step.
+3. Provide consent for your data to be stored and continue to the next step.
+4. Fill in the questions shown, and find your location on the map at the bottom of the page (if available). Click your location to select it.
+5. Finally click `Save`.
+
+## Update Your Profile
+
+Click the `Profile` button in the navigation bar at the top of the screen. If you have not yet provided consent for your data to be stored, you will first be asked for this. You will then be presented with your profile.
+
+1. Click `Update`
+2. Update your answers to the questions, and optionally update your location on the map at the bottom of the page (if available). Click your location to select it.
+3. Finally click `Save`.
+
+## Add a Relationship
+
+1. Click `People` in the banner at the top of the screen.
+2. Locate the person you wish to record a relationship with and click `Add Relationship` next to their name.
+3. If you have no relationship with this person, you can click the `Autofill` button at the top of the page to automatically fill in appropriate responses. Otherwise, fill in the listed questions.
+4. Finally click `Submit`.
+
+
+## Update a Relationship
+
+1. Click `People` in the banner at the top of the screen.
+2. Locate the person you wish to update your relationship with and click `Update Relationship` next to their name.
+3. If you have an existing but very limited relationship with this person, you can click the `Autofill` button at the top of the page to automatically fill in appropriate responses. This will default your relationship to the lowest level of closeness. Otherwise, fill in the listed questions.
+4. Finally click `Submit`.
+
+## End a Relationship
+
+1. Click `People` in the banner at the top of the screen.
+2. Locate the person you wish to record a relationship with and click `Profile` next to their name.
+4. Click `End Relationship` at the top of the page.
+
+## Create an Activity
+
+1. Click `Activities` in the banner at the top of the screen.
+2. Click `New Activity` at the top of the page.
+2. Answer the questions shown.
+4. Finally click `Submit`.
+
+:::{note}
+Activities can only be edited by administrators once they have been created.
+:::
+
+## Record Activity Attendance
+
+Once an activity has been created, users should record their attendance.
+
+1. Click `Activities` in the banner at the top of the screen.
+2. Locate the activity you wish to record attendance for and click `Details` next to its name.
+3. At the top of the page, click `Attend`.
+
+## Cancel Activity Attendance
+
+Once an activity has been created, users should record their attendance. They can also remove their attendance after previously registering it.
+
+1. Click `Activities` in the banner at the top of the screen.
+2. Locate the activity you wish to record attendance for and click `Details` next to its name.
+3. At the top of the page, click `Cancel Attendance`.
+
+## Manage Your Account Details
+
+To manage your account details, click your username in the top right corner of the screen, next to the `Log Out` button.
+
+![Click your username to open your account details](images/4-open-account-details.png)
+
+Alternatively, you can manage your account by going to your profile (click `Profile` in the banner at the top of the screen), then clicking `Account Details`.
+
+## Enable Login With Google or Microsoft
+
+1. Open your account details by following [the steps above](#manage-your-account-details).
+2. Under `Federated Login`, click `Manage`.
+3. Click `Google` or `Microsoft` to link your account.
+
+
+## Remove a Linked Google or Microsoft Account
+
+1. Open your account details by following [the steps above](#manage-your-account-details).
+2. Under `Federated Login`, click `Manage`.
+3. Under `Account Connections`, click the radius button next to the account you wish to remove.
+4. Click `Remove`.