Merge pull request #12006 from opf/Updating-help-system-guide-users-manage-users

Updating help system guide users manage users

docs/system-admin-guide/users-permissions/users/README.md

@@ -13,7 +13,7 @@ The user list provides an overview of all users in OpenProject. You can create n
 <div class="glossary">
 **User** is defined as a person (described by an identifier) who uses OpenProject. Users can become project members by assigning them a role and adding them via the project settings.
 </div>
-To manage users click on your avatar (top right corner) and select *Administration*. Select *Users and permissions -> Users*. The list of current users is shown.
+To manage users click on your avatar (top right corner) and select **Administration**. Select ***Users and permissions -> Users**. The list of current users is shown.
 
 In the Community edition there is no limit to the number of users. In Enterprise editions (cloud and on-premises) the user limit is based on your subscription. The number of users for your subscription is thus not bound to names. For example, if you block a user you can add a new one without upgrading. 
 
@@ -37,12 +37,13 @@ Column headers can be clicked to toggle sort direction. Arrows indicate sort ord
 
 ## Filter users
 
-At the top of the user list is a filter box. Filter by status or name, then click the blue **Apply** button to filter the list. Click the **Clear** button to reset the filter fields and refresh the list.
+At the top of the user list is a filter box. Filter by status. group or name, then click the blue **Apply** button to filter the list. Click the **Clear** button to reset the filter fields and refresh the list.
 
 * **Status** - select from Active, All or Locked Temporarily. Each selection shows the number of users.
+* **Group** - select from the list of existing groups.
 * **Name** - enter any text; this can contain a "%" wild card for 0 or more characters. The filter applies to user name, first name, last name and email address.
 
-![Filter users in OpenProject](image-20200115155456033.png)
+![Filter users in OpenProject](openproject_systemguide_filter_users.png)
 
 ## Lock and unlock users
 
@@ -54,7 +55,7 @@ If you are using [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-g
 
 ![Lock users in OpenProject](open_project_system_admin_lock_user_permanently.png)
 
-If a user has repeated failed logins the user will be locked temporarily and a **Reset failed logins" link will be shown in the user list. Click the link to unlock it right away, or wait and it will be unlocked automatically. Have a look at the section [Other authentication settings](../../authentication/authentication-settings/#other-authentication-settings) for failed attempts and time blocked.
+If a user has repeated failed logins the user will be locked temporarily and a **Reset failed logins** link will be shown in the user list. Click the link to unlock it right away, or wait and it will be unlocked automatically. Have a look at the section [Other authentication settings](../../authentication/authentication-settings/#other-authentication-settings) for failed attempts and time blocked.
 
 ## Create users
 
@@ -71,17 +72,23 @@ Enter the email address, first name, and last name of the new user. Tick the box
 Note: the email field must be a valid format and be unique or it will be rejected on clicking the button.
 
 Click the **Create** button to add the user and show that user's details page. Click the **Create and continue** button to add the user and stay on the new user form to add another user. Either way, the new user will be invited via email.
-When adding the last of multiple users you can click on **Create** or click the **Users** link in the menu on the left. The Users list is shown. Click each user in turn to [edit their details](#set-initial-details).
+When adding the last of multiple users you can click on **Create** or click the **Users** link in the menu on the left. The **Users list** will be shown. Click on the name of  each user to [edit their details](#set-initial-details).
 
 ### Create user (via self-registration)
 
-To allow users to create their own user accounts allow self-registration in the [authentication settings](../../authentication/authentication-settings). A person can then create their own user from the home page by clicking on the **Sign in** button (top right), then on the **Create a new account** link in the sign in box. 
+To allow users to create their own user accounts enable self-registration in the [authentication settings](../../authentication/authentication-settings). A person can then create their own user from the home page by clicking on the **Sign in** button (top right), then on the **Create a new account** link in the sign in box. 
 
 Enter values in all fields (they cannot be left blank). The email field must be a valid email address that is not used in this system. Click the **Create** button. Depending on the [settings](../../authentication/authentication-settings) the account is created but it could be that it still needs to be activated by an administrator.
 
 #### Activate users
 
-Open the user list. If a user has created their own account (and it has not been activated automatically) it is shown in the user list with an **Activate** link on the right. Click this link and continue to add details to this user as below. There is also an **Activate** button at the top of the user's details page.
+Open the user list. If a user has created their own account (and it has not been activated automatically) it is shown in the user list with an **Activate** link on the right. Click this link and continue to add details to this user as below. 
+
+![Activate a user](activate user from the list.png)
+
+There is also an **Activate** button at the top of the user's details page.
+
+![Activate user in profile](activate user.png)
 
 ### Set initial details
 
@@ -101,35 +108,35 @@ In the top right, click the **Send invitation** button in order to send the emai
 
 ### Delete user invitations
 To invalidate or revoke a user's invitation click on the user name and then on **Delete** in the upper right corner. This will prevent the invited user from logging in. 
-Please note: This only works for users who haven't logged in yet. If the user is already active this will delete his/her whole profile and account. Deleting users can't be easily revoked.
+Please note: this only works for users who haven't logged in yet. If the user is already active this will delete his/her whole profile and account. Deleting users can't be revoked.
 
 ## Manage user settings
 
-You can manage individual user details if you click on the user name in the list. These settings will overwrite the individual user's settings set in their My Account settings.
+You can manage individual user details if you click on the user name in the list. These settings will overwrite the individual user's settings set in their **My Account** settings.
 
 ### General settings
 
-On the General tab the following fields are shown:
+![administration-user-settings-manage-user](User settings general tab.png)
+
+On the **General** tab the following fields are shown:
 
 1. User's master date
    - **Status** - this is set by the system.
    - **Username** - this defaults to the email address for a new user (unless the user used the self registration). It can be changed on this page. Users cannot change their own user name.
-   - **First name**, **Last name**, **Email** - these fields are filled from the New user page. Users can change them on their Profile page; they are mandatory.
-   - **Language** - this defaults from the [user settings](../settings/#default-preferences). Users can change this on their Profile page.
+   - **First name**, **Last name**, **Email** - these fields are filled from the **New user** page. Users can change them under their **Profile** page; they are mandatory.
+   - **Language** - this defaults from the [user settings](../settings/#default-preferences). Users can change this on their **Profile** page.
    - **Administrator** - activate or deactivate this global role. Users cannot change this.
-   - **Custom Fields** - if these have been created they are shown here. Use it for e.g. department or phone number.
-2. **User consent** - if this has been [configured](../settings/#user-consent) (i.e. if the box next to "Consent required" is ticked) the consent status is shown here.
+   - **Custom Fields** - if these have been created they are shown here. Use it for e.g. department or phone number. If not, this is how [custom fields](../../custom-fields/) can be created.
+   - **User consent** - if this has been [configured](../settings/#user-consent) (i.e. if the box next to "Consent required" is ticked) the consent status is shown here.
 3. **Authentication** - the content of this section depends on the type of [authentication method](#authentication) being used (e.g. password, OpenID, Kerberos, etc.)
-4. **Preferences** - users can change these on their Profile page. Time zone defaults from chosen language. "Auto-hide success notifications" means that notifications will automatically be removed after some seconds, not that there are no success notifications at all.
+4. **Preferences** - users can change these on their **Profile** page. Time zone defaults from chosen language. **Auto-hide success notifications** means that notifications will automatically be removed after some seconds, not that there are no success notifications at all.
 5. Do not forget to **Save** your changes.
 
-![administration-user-settings-manage-user](image-20210302092958881.png)
-
 #### Reset a user's password
 
-To create a new password for a user (e.g. if he/she lost it) navigate to the *Authentication* section of the *General* tab. You can either assign a random password (check the box on top) or set a new password manually and send it to them (preferably through secured communication). Consider checking the box next to "Enforce password change ...".
+To create a new password for a user (e.g. if he/she lost it) navigate to the **Authentication** section of the **General** tab. You can either **Assign a random password**(check the box on top) or set a new password manually and send it to them (preferably through secured communication). Consider checking the box next to **Enforce password change on next login**.
 
-![reset-user-password](image-20210429114602604.png)
+![reset-user-password](Authentication.png)
 
 ### Add users to a project
 
@@ -137,33 +144,47 @@ In order to see and work in a project, a user has to be a member of a project an
 
 On the **Projects** tab, select the new project from the drop-down list, choose the [**roles**](../roles-permissions) for this project and click the blue **Add** button.
 
-![Sys-admin-add-project](Sys-admin-add-project.gif)
+![Sys-admin-add-project](Sys-admin-add-project1.gif)
 
 ### Add users to groups
 
-On the **Groups** tab you can see the groups the user belongs to. If a group is shown, click the group name link. If no groups are shown (i.e. the user does not belong to any group, yet), click the **Manage groups** link to [edit groups](../groups).
+On the **Groups** tab you can see the groups the user belongs to. If a group is shown, click the group name link. 
+
+![open-projet-user-groups](user groups.png)
 
-![add-users-to-a-group](image-20210215185753826.png)
+If no groups are shown (i.e. the user does not belong to any group, yet), click the **Manage groups** link to [edit groups](../groups).
 
-**Please note**: The Groups tab is only shown if at least one user group exists in OpenProject.
+![manage-groups](Manage groups.png)
+
+**Please note**: The **Groups** tab is only shown if at least one user group exists in OpenProject.
 
 ### Global roles
 
-In order to add a global role to a user, at least one global role needs to be [created](../roles-permissions) in the system (a role with the "Global role" field ticked).
+In order to add a global role to a user, at least one global role needs to be [created](../roles-permissions) in the system (a role with the **Global role** field ticked).
 
 On the **Global roles** tab, select or de-select the global role(s) for this user. Click the **Add** button.
 
+![Openproject-user-add-global-roles](Add global roles.png)
+
+### Notification settings
+
+Under **Notification settings** tab you can edit the [notification settings](../../../user-guide/notifications/notification-settings/) for the user. Each user can adjust these settings under [My account](../../../getting-started/my-account) on their own.
+
+### Email reminders
+
+Under **Email reminders** tab you can edit the [email reminders settings](../../../getting-started/my-account/#email-reminders). Each user can adjust these settings under [My account](../../../getting-started/my-account) on their own.
+
 ### Rate history
 
-The rate history tab shows the hourly rates that have been defined for the user. The "Default rate" is applied to projects with no rate defined. All projects that the user is a member of are listed with the user's rates.
+The rate history tab shows the hourly rates that have been defined for the user. The **Default rate** is applied to projects with no rate defined. All projects that the user is a member of are listed with the user's rates.
 
-The "Valid from" date will effect the rate used when creating a [budget](../../../user-guide/budgets/) and when [logging time](../../../user-guide/time-and-costs/time-tracking/).
+The **Valid from** date will effect the rate used when creating a [budget](../../../user-guide/budgets/) and when [logging time](../../../user-guide/time-and-costs/time-tracking/).
 
 If you want to set a different hourly rate for the user on different projects, you can overwrite the default rate with a different rate below in the respective projects.
 
 To enter a new hourly rate, click on the **Update** icon next to the rate history. You can either set a **default hourly rate** or define a rate for a certain project.
 
-![set-hourly-rate-administration](image-20210413112220100.png)
+![set-hourly-rate-administration](rate history.png) 
 
 1. Enter a date from which the rate is **Valid from**.
 2. Enter the (hourly) **Rate**. The currency can only be changed in the [respective settings](../../time-and-costs).
@@ -171,7 +192,7 @@ To enter a new hourly rate, click on the **Update** icon next to the rate histor
 4. You can **add a rate** for a different time period.
 5. **Save** your changes.
 
-![Rate-history-change](Rate-history-change.png)
+![Rate-history-change](adjust rate history.png)
 
 ### Avatar
 
@@ -183,7 +204,7 @@ This tab shows whether a user has activated a device for two-factor authenticati
 
 ## Authentication
 
-The available authentication methods affect the content of the Authentication section in the General tab of the user details. 
+The available authentication methods affect the content of the **Authentication** section in the **General** tab of the user details. 
 
 Use the **self-registration** field to give the following controls over a new user's access.
 
@@ -191,9 +212,9 @@ Use the **self-registration** field to give the following controls over a new us
 
 The user details Authentication section has fields **Assign random password**, **Password**, **Confirmation** and **Enforce password change**.
 
-* If you are near the new user, you can enter a password and confirmation then tell the user what it is. They can then sign in. It is recommended that you also tick the enforce password change tickbox, so that the user is prompted to change their password after they sign in.
-* You can phone the new user or send them an email, not using OpenProject, to give them the password. In this case it is more important to tick the enforce password change tickbox.
-* Tick the Assign random password, and probably the enforce password change tickbox. When the details are saved OpenProject will send an email to the new user with their password.
+* If you are near the new user, you can enter a password and confirmation then tell the user what it is. They can then sign in. It is recommended that you also tick the enforce password change checkbox, so that the user is prompted to change their password after they sign in.
+* You can phone the new user or send them an email, not using OpenProject, to give them the password. In this case it is more important to tick the enforce password change checkbox.
+* Tick the Assign random password, and probably the enforce password change checkbox. When the details are saved OpenProject will send an email to the new user with their password.
 
 ### Account activation by email
 
@@ -202,15 +223,15 @@ Leave all fields blank. When the details are saved OpenProject will send an emai
 ## Delete users
 
 Two [settings](../settings/#user-deletion/) allow users to be deleted from the system:
-* **User accounts deletable by admins** - if ticked, a "Delete" button is shown on the user details page.
-* **Users allowed to delete their accounts** - if ticked, a "Delete account" menu entry is shown in the "My Account" page.
+* **User accounts deletable by admins** - if ticked, a **Delete** button is shown on the user details page.
+* **Users allowed to delete their accounts** - if ticked, a **Delete account** menu entry is shown in the **My Account** page.
 
 To delete another user's account open the [user list](#user-list). Click on the **user name** of the user which you want to delete. Click the **Delete** button at the top right.
 
-![Sys-admin-delete-user](Sys-admin-delete-user.png)
+![Sys-admin-delete-user](openproject_system_guide_delete_user.png)
 
 You will then be asked to type in the username in order to delete the user permanently from the system, then confirm this with your password.
 
-![delete user](image-20200115162533470.png)
+![delete user](delete-user-confirmation.png)
 
-> **Note**: Deleting a user account is an irreversible action and cannot be reversed. The previous activities from this user will still be displayed in the system but reassigned to "Deleted user". This is also true for the Time and cost and the Budget modules. Spent time will be still be visible for "Deleted user" inside a Work package. Time and cost reports will contain the entries with reference to "Deleted user". Labor budgets that have been setup for the user are displayed under "Deleted user", too. If you would like to keep track of the user's name in connection with the mentioned activities, the spent time and the budget, you are able to keep the user's name in the historical data by simply [locking the user](#lock-and-unlock-users).
+> **Note**: Deleting a user account is a permanent action and cannot be reversed. The previous activities from this user will still be displayed in the system but reassigned to **Deleted user**. This is also true for the Time and cost and the Budget modules. Spent time will be still be visible for **Deleted user** inside a Work package. Time and cost reports will contain the entries with reference to **Deleted user**. Labor budgets that have been setup for the user are displayed under **Deleted user**, too. If you would like to keep track of the user's name in connection with the mentioned activities, the spent time and the budget, you are able to keep the user's name in the historical data by simply [locking the user](#lock-and-unlock-users).