General Docs Overhaul

content/support/accounts-and-roles/account-management.md

@@ -1,58 +1,68 @@
 title: Managing user accounts
 # Managing user accounts
 
-The **Users and Roles** section of the manager has various controls for
-different permission levels.
+The **Users and roles** section of the Manager dashboard has various controls for managing users and permissions. Who can manage what will depend on their role and permissions associated with it.
 
-Editors have control of:
--   User accounts at the journal level.
--   Account roles in the journal.
--   Account activation.
+**Editors** and **Journal managers** can:
 
-Staff have additional controls for:
--   Viewing all accounts for the Janeway installation, including their journal roles and activation status.
--   Merging user accounts.
-Both of these are only available at the press level.
+- Manage user accounts at the journal level.
+- Assign and remove roles for users on the journal.
+- View and update account activation status.
+
+**Staff** have additional controls for:
+
+- Viewing all accounts for the press (Janeway installation), including their journal roles and activation status.
+- Merging duplicate user accounts.
+
+These additional controls are only available at the press level.
 
 ## Journal users
-If you are an editor or staff member, you can manage user accounts for a
-journal via the **Journal Users** page.
+If you are an editor, journal manager or staff member, you can manage user accounts for a journal via the **Journal users** page.
+
+![The Journal Users page.](../images/journal-users.png)
 
-![The Journal Users page.](../images/journal_users.png)
+From this page you can:
 
-You can search by various fields, including name, email, ORCID,
-institution, and biography. You can filter by role and whether an account
-is active.
+- Search by name, email address, ORCID, institution, or biography.
+- Filter users by role and account activation status.
+- Add or remove journal roles.
+- Edit user account details.
+- Create new user accounts where required.
 
-You can also add and remove roles, edit accounts, and, if needed create
-accounts.
+Each user's assignment history (for example, editorial or review activity) is also available from this view.
 
-Each user's assignment history is also available from this view.
+This page cannot be used to delete accounts, only deactivate them. Accounts can only be deleting using through the **Admin area** <!-- missing hyperlink>.
 
-## All users
+## All press users
 
-If you are staff, you can see all users across a press (a.k.a. Janeway
-installation) - this view is only available from the Press Manager interface.
+Staff users can access a press-wide view of all accounts across press / the Janeway installation. This view is available from the **Press manager** interface only.
 
-![The All Users page at the press level.](../images/press_all_users.png)
+![The All Users page at the press level.](../images/press-all-users.png)
 
-At this level, you can filter by journal and staff-member status and
-manage roles across journals, in addition to the actions an editor can
-take.
+At press level you can:
+- Filter users by journal role and staff status.
+- Manage roles across multiple journals.
+- Perform all actions available to editors at journal level.
 
 ## Editing user accounts
 
-When clicking **Edit** next to a user, you will be taken to the Edit User interface, where you make changes to a user's details. There are a few things to note regarding permissions, see the Permissions page for more information <!-- missing hyperlink -->.
+Click **Edit** next to a user to open the **Edit user** interface, where you can update a user’s account details.
 
-TBC 
-- information about how editing an account won't affect metadata on articles that have already been accepted: to do that you'll need to edit the frozen author record on the article metadata page. 
+Some changes are restricted by permission level. For more information, see the **Permissions** page. <!--missing hyperlink-->
 
-## Merge users (Press manager only)
+>[!IMPORTANT]
+> Editing a user account does **not** change author metadata on articles that have already been accepted.  
+> To update author details on an accepted article, you must edit the *frozen author record* on the article’s metadata page.
 
-The press manager interface enables staff members to merge two accounts to eliminate duplicates. All associated objects, such as tasks, articles, roles, and files, will be moved from the source account to the destination account. The account profile remains unchanged, meaning any profile information in the source account will be lost.
+## Merge users (staff only)
+When users have multiple accounts (often due to different email addresses having been used), it may be helpful to merge accounts. Users with staff permission can merge two user accounts to remove duplicates, using the **Press manager interface**. When searching for users to merge, note that the user account in the left column (source account) will be merged into the user account in the right column (destination account). 
 
-![A press manager is merging Andy Byers' account into Katheryn Janeway's account.](../images/merge-users.gif)
+>[!WARNING]
+>An account merge **cannot** be undone. Only merge account when you are certain they can be merged.
 
-> [!WARNING]
-> When searching for users to merge, note that the user account in the left column will be merged into the user account in the right column.
+When accounts are merged:
+- All associated items (including articles, tasks, roles and files) are transferred from the source account to the destination account.
+- The destination account profile is retained.
+- Any profile information from the source account is permanently lost. <!--check how much of this is the case -->
 
+<!-- ![A press manager is merging Andy Byers' account into Katheryn Janeway's account.](../images/merge-users.gif) -->

content/support/accounts-and-roles/accounts-and-roles-index-placeholder.md

@@ -1,2 +1,24 @@
-title: Accounts and Roles
-# Accounts and Roles
+title: Accounts and roles
+# Accounts and roles
+
+This section explains how user accounts and permissions work in Janeway, including how roles are assigned and managed. Read the following pages for more information:
+
+<!--missing hyperlinks-->
+
+- Managing user accounts
+- Roles and permissions
+- Activating accounts
+- ORCID login
+- Single sign-on (SSO)
+
+## New accounts
+
+Account creation VS self-registration
+
+## Single sign-on (SSO) login
+
+Janeway supports single sign-on (SSO), allowing users to log in using their institutional credentials without creating a separate Janeway account.
+
+SSO must be configured by your system administrator. If you are interested in enabling SSO for your journal or press, contact your system administrator for further information.
+
+<!-- -Dev help needed -->

content/support/accounts-and-roles/activating-accounts.md

@@ -0,0 +1,52 @@
+title: Activating accounts
+# Activating accounts
+
+This page explains how to check whether a user account has been activated and how to activate inactive accounts. As users must activate their account before they can log in to Janeway, inactive accounts are a common cause of login issues.
+
+## Inactive users
+There are two places from which to check and manage the activation status of accounts:
+
+- **Journal users**
+- **Inactive users**.
+
+Both are found under **Users & roles** on the Manager dashboard. The **Journal users** page is available to editors and journal managers, where as the **Inactive users** page is accessible to staff only.
+
+To view inactive users:
+
+1. Open **Journal users**.
+2. Use the filter on the left-hand side.
+3. Set **Status** to **Inactive**.
+4. Click **Apply**.
+
+This will list all inactive users on the journal. You can also search by name or email address.
+
+The **Inactive users** page lists all inactive users across the press who have not yet activated their accounts.
+
+## Activating accounts
+Once you have identified an inactive account through either **Journal users** or **Inactive users**:
+1. Click **Edit** next to the user to open the account page.
+2. Under **Is active**, select **Yes**.
+3. Save your changes.
+
+![Account activation toggle.](../images/activate-account.png)
+
+The user will now be able to login into the journal.
+
+### Troubleshooting
+
+-Resending activation emails
+  Only from admin?
+
+Account activation should not trigger an email (check).
+
+Users usually activate through a link sent to them.
+
+/Does ORCID require activation?
+/Do author accounts automatically activate upon submission?
+/Do reviewer accounts with one-click review? -> check Mauro's suggested solution for the issue encountered.
+/Why can accounts be inactive? -> NEarly always because not activated. Rarely manually deactivated.
+
+## Authenticated users
+The **Authenticated users** page shows a list of users currently logged in to your Janeway installation.
+
+This page is only accessible to users with staff permission.

content/support/accounts-and-roles/janeway-roles-and-permissions.md

@@ -1,77 +1,93 @@
-title: Roles and Permissions on Janeway
-# Roles and Permissions on Janeway
+title: Roles and permissions on Janeway
+# Roles and permissions on Janeway
 
-**WIP**
-Needs some further work, checks and dev input on a few bits. Need to check out the granular permissions still.
+This page explains the different roles available in Janeway and how permissions are managed.
 
-## Janeway roles 
-- Author
-    - When someone registers with the journal or submits an article, they are given this role. 
+<!-- Role VS permissions
+
+Needs some further work, checks and dev input on a few bits. Need to check out the granular permissions still.-->
+
+## Janeway roles
+
+Janeway has a variety of roles available that can be assigned to users, some of which will affect the permissions of the user. Roles do not exclude each other, e.g. having one role will not prevent you another one.
+
+- Author  
+   Assigned automatically when a user registers with a journal or submits an article. This can be considered the 'base role'.
 - Reviewer
-- Editor
-  - Handles processing of articles and assignment of tasks
-- Journal Manager
-    - Has a similar level of permission to the editor role but can be given extra access (see below)
-- Section Editor
+- Editor  
+   Editors handle processing of articles and assignment of tasks. An editor has access to the journal workflow, manager dashboard and journal settings, certain plugins and is able to do general journal management.
+   An editor does not have access to the admin area, press level settings and certain plugins.
+- Journal manager  
+   Journal managers have a similar level of permission to the editor role, but can be given additional access (see below).
+- Section editor  
+   Section editors have access only to the workflow elements of articles assigned to them. They cannot access any articles not assigned to them, journal settings or plugins. This role is well-suited for (guest) editors who only need to handle specific articles within the journal.
 - Copyeditor
 - Typesetter
 - Proofreader
 - Reader  
   - This is not a role as such, but it is used to indicate whether a user is signed up for article publication notifications. For more information, see Email notifications <!-- missing hyperlink -->
 
 > [!NOTE] 
-> Whilst the Production Manager and Proofing Manager are still assignable in Janeway, they have been deprecated in 1.4 and are no longer in use.
+> Whilst the Production manager and Proofing manager are still assignable in Janeway, they have been deprecated in 1.4 and are no longer in use.
 
 ## Permissions
 
-In addition to the roles and their respective permissions, separate permission levels can be assigned. Editors also have specific permissions associated with their roles.
-
-### Editor permission 
+In addition to the roles and their respective permissions, separate permission levels can be assigned for certain settings for journal managers and editors. Editors also have specific permissions associated with their roles.
 
-Editors have permissions that allow:
+### Editor permission
 
-- Managing roles within their journal.
-- Viewing and editing the account activation status of journal users.
-- Editing basic account information on behalf of journal users.
-- Viewing a user's history (review/editorial/proofing etc. assignments).
+Editors can:
+- Manage roles within their journal.
+- View and edit account activation status for journal users.
+- Edit basic account information on behalf of users.
+- View a user’s assignment history (editorial, review, proofing, etc.).
   - The user history page also displays emails sent directly to the user - excluding 'automated' emails such as reminders, notifications and invitations. 
 
 ### Staff permission
-The ‘Staff’ permission should only be given to Journal Managers/Publishers and can only be assigned by other users with the Admin and/or Superuser permission. Staff have additional controls for:
+Staff permission should only be assigned to press-level users (for example, publishers or system administrators). It can only be granted by another user with staff permission.
 
-- The same controls as editors, but for all the journals belonging to the press.
-- Merging duplicate user accounts (available at the press level).
+Staff users can:
+- Perform all editor-level actions across all journals in the press.
+- Merge duplicate user accounts at press level.
+- Use all installed plugins.
+- View additional manager pages (for example: inactive users, authenticated users).
+- View the **All articles** page. <!-- check-->
+- Access the **Admin area**. <!--missing hyperlink-->
 
 ### Superusers permission
-- ‘Superuser’ will assign a user all roles across the system.
+‘Superuser’ will assign a user all roles across the system.
 
-### Admin permission
-- ‘Admin’ grants access to Janeway's admin data layer.
-
-## Granular Manager Permissions
-
-In version 1.5, we introduced more granular manager permissions. Initially, these roles were centred around journal manager and editor roles. We are introducing a new setting group, "Permission", and within this group, we will be adding new permission controllers starting with:
+## Granular manager permissions
+<!-- Note to self: this needs images -->
 
+Janeway allows more granular permissions for journal managers and editors, using the **Permissions** setting group. This can be used on the configuration of licences and sections as following:
 - Licenses  
-  - Controls whether users can access the licenses control pages based on their roles, defaulting to Editor and Journal Manager.
+    Permissions control whether users can access the licenses control pages based on their roles, defaulting to Editor and Journal Manager.
 
 - Sections  
-  - Controls whether a user can access the sections control pages based on their roles, defaults to Editor and Journal Manager.
+   Permissions control whether a user can access the sections control pages based on their roles, defaults to Editor and Journal Manager.
+
+### Editing granular permissions (staff only - advanced)
 
-Currently, there is no interface for updating the roles that can access these pages and the setting is JSON stored in the database.
+>[!NOTE]
+>The following sections contain information on configuring granular permissions. This requires more advanced technical knowledge, though you are unlikely to need this (often).
+
+There is no interface for updating the roles that can access these pages and the setting is JSON stored in the database. If you are not comfortable or able editing this, contact your system administrator.
 
 > [!WARNING]
-> You should only edit the Permission settings if you are sure about the change you are making.
+> Only modify granular permissions if you are confident in the change you are making.
 
 By default, both settings read `["editor", "journal-manager"]`. If, for example, you wanted to stop editors from editing licenses, you could change it to read `["journal-manager"]`. Once saved, only users with the journal manager role will be able to access the licenses
 pages.
 
-### Granular settings permissions
+### Granular settings permissions (staff only - advanced)
 
-In version 1.5, we introduced permissions for granular settings. Staff can now determine which roles can edit any given setting object. This is done via the Django Admin panel (Core \> Settings), using the `editable_by` field. Staff can alter the roles that are allowed to see and edit a setting.
+Users with staff permission can control which roles can view and edit individual settings via the **Admin area** (Core \> Settings), using the `editable_by` field. 
 
-> [!NOTE]
-> If a setting is also displayed on a settings group page (for example, the General or Submission settings page) and a user does not have the appropriate permission to edit that setting, it will be filtered out of the form and not be visible.
+If a setting is displayed on a settings group page (for example, the **General** or **Submission settings** page) and a user does not have the appropriate permission to edit that setting, it will be hidden from the form.
 
 As with the manager permissions changes, the default to settings permission maintains the status quo, and by default, all settings are editable by editors and journal managers.
 
+By default, setting permissions are only editable by editors and journals. When upgrading to a Janeway version with the granular permissions, no changes will be made to the default.
+
+If you wish to make these changes and are not confident using the Admin interface, contact your system administrator.

content/support/accounts-and-roles/orcid-login-placeholder.md

@@ -1,22 +1,24 @@
 title: ORCID login
 # ORCID login
 
-**WIP**
+*Coming soon*
 
 Janeway supports ORCID login.
 - How to register
 - How to login
 
-<!-- General info - needs some input from dev -->
+<!-- - Is ORCID mutually exclusive with SSO?
 
+General info - needs some input from dev -->
+<!--
 ## Using ORCID to login to Janeway
-*If you don't have ORCID, you will need one. <!-- missing hyperlink -->
+*If you don't have ORCID, you will need one.  missing hyperlink
 
 Start with:
 
 ### Linking ORCID to an existing account
-
-## Technical information
+-->
+## Technical information 
 
 ### Enable ORCID login
 To enable ORIC login, you need to add the following to your settings file:

content/support/analytics/google-analytics-placeholder.md

@@ -1,18 +1,17 @@
 title: Google analytics
 # Google analytics
-
-**WIP**
+ *Coming soon*
+Allows you to measure activity on your web pages.
 
 - About Google analytics
-- If no Google analytics, where to get. Link to GA page.
-- GA 3 vs 4
+- Link to GA page
 - If issues, send email to support.
 
 Found through either general settings -> scroll down
 
-![" "](../../support/images/general-settings-google.png)
+!["Google analytics settings"](../../support/images/general-settings-google.png)
 
 Or through all settings:
 
-![" "](../../support/images/all-settings-google.png)
+!["Google analytics settings shown on the All settings page"](../../support/images/all-settings-google.png)