Merge pull request #390 from nens/StevenHosper-patch-1

Update m_managers_threedi.rst

source/d_guide_management_portal.rst

@@ -1,3 +1,5 @@
+.. _threedi_management:
+
 3Di Management
 ==============
 

source/d_overview_management_portal.rst

@@ -66,12 +66,114 @@ When you click the *Personal API Key* tile in the overview, you will be presente
 
 Users
 =====
-When you click the *Users* tile in the overview, you will access a list of all the users associated with your organisation along with their respective roles:
 
-- *Viewer*: This role is capable of reading data and monitoring simulations.
-- *Simulation Runner*: This role has the authority to read data and execute simulations.
-- *Creator*: Users with this role possess the ability to read data and make modifications such as adding, altering, or removing schematizations and 3Di models.
-- *Manager*: Users holding this role are empowered to manage users by performing tasks such as addition, modification, or removal.
+You only have access to this functionality if you have the *Manager* role.
+
+In this screen, you can:
+
+1. :ref:`Invite new users<inviting_new_users>`
+2. :ref:`Adjust existing rights<adjusting_existing_rights>`
+
+.. _inviting_new_users:
+
+Inviting new users
+------------------
+
+By default the new user is granted a 'Viewer' role. At least one role is required when inviting a new user.  
+Press the 'Save' button to finish the invitation process, which results in an invitation email sent to the (new) user. An existing user can use the invitation link to accept the invitation. 
+A new user can create an account by using the :ref:`a_singing_up` guide. When accepted, the user will appear in the User Management overview.
+
+If a new user needs access to 3Di from the organisation, this can be granted by the Manager.
+This is done as follows:
+
+3. Click `+ NEW USER` at the top right of the screen (image 1).
+4. Type the user's email in the 'email' field (image 2).
+5. Select the roles the user will have (see :ref:`roles`)
+6. Click *SAVE*.
+7. Success! The invitation has been sent and will be in the new user's mailbox within 5 minutes.
+
+.. tip:: Clicking `need help?` will also show you an overview of the roles and the rights associated with them.
+
+.. tip:: If the email does not appear in the inbox after 5 minutes, first check your spam folder. If the invitation is not there either, you can always contact the `servicedesk <mailto:[email protected]>`_.
+
+.. figure:: /image/m_threedi_overzicht_rechten.png
+    :scale: 50%
+    :alt: Overview of the 3Di management page with multiple users.
+
+    Image 1: An overview of the user section in the management screen of 3Di.
+
+
+.. figure:: /image/m_threedi_uitnodiging_rechten.png
+    :scale: 50%
+    :alt: Invitation screen for new users of 3Di. Enter an email and select the roles for the new user.
+
+    Image 2: The invitation screen for new users. You select the roles by clicking on them.
+
+.. _adjusting_existing_rights:
+
+Adjusting existing rights
+-------------------------
+
+In the *User rights* overview screen, you can manage the rights of existing users.
+Here you see the following information of users who have rights for your organisation:
+
+1. Username
+2. Roles
+3. Email
+
+By clicking on the plus sign next to the roles of a user, you can start adjusting the rights.
+The plus button will then change to *SAVE*. Once the rights are as desired, click *SAVE* to confirm.
+
+.. figure:: /image/m_threedi_rechten_bestaande.png
+
+
+.. _removing_users:
+
+Removing users
+--------------
+
+You can remove a user from your organisation by removing all the user's roles. 
+This will not delete the account of the user, but just revoke that user's right to your organisation. If you want to entirely deactivate a user's account, contact the :ref:`servicedesk`.
+
+You cannot revoke your own *Manager* role.	
+
+
+.. _roles:
+User roles
+----------
+
+Each user is assigned one or more *Roles*, which give them the rights to perform certain sets of actions.
+
+Viewer
+^^^^^^
+
+As a viewer, you can read data from the API of the respective organisation, and you can follow simulations of others.
+These users cannot start or create simulations themselves.
+
+Simulation runner
+^^^^^^^^^^^^^^^^^
+
+With this role, users can start simulations themselves with 3Di models provided by the organisation.
+This role always goes in combination with the *Viewer* role to ensure that the user can also follow the simulation.
+
+Creator
+^^^^^^^
+
+Creator rights are needed to provide new schematisations and models to 3Di. Creators can also change or remove schematisations and 3Di models, and read data from the API.
+To run simulations, the *Simulation runner* role is necessary, also if you already have the *Creator* role.
+
+Manager
+^^^^^^^
+
+*Managers* give and take roles from other users.
+A manager can also revoke the rights of another manager.
+So, make sure to only give manager role to trusted parties.
+
+.. tip:: In some situations, organisations are created for specific projects.
+    If the data within this project falls under your organisation and you want to appoint a manager for this, 
+    please contact the `servicedesk <mailto:[email protected]>`_.
+
+
 
 .. _3di_management_simulations:
 

source/f_authentication_user_management.rst

@@ -52,57 +52,44 @@ Existing users should use the same method as they used when signing in for the f
 
 .. _a_user_management:
 
-User management
----------------
+User management: tasks of the *Manager*
+---------------------------------------
 
+Users rights are managed by the person(s) in your organisation that have the *Manager* role. As *Manager*, you manage your organisation's 3Di account and its users. You grant or revoke rights for your organisation. A manager has two main tasks:
 
-.. figure:: /image/a_usermanagement1.png
-   :alt: The User Management interface.
+1. :ref:`maintaining_rights`
+2. :ref:`granting_rights`
 
-   The User Management interface.
+You can do this in the :ref:`Users<3di_management_users>` section of 3Di Management (`management.3di.live <management.3di.live>`_).
 
+.. _maintaining_rights:
 
-Users can be managed in the User Management interface. This interface can be reached via https://api.3di.live/management/users/.
-The example above shows the list of users in the example organisation '3Di Test', with for each user options for 4 roles. These role are desribed as: 
+Maintaining rights of existing users
+------------------------------------
 
-* A **Viewer**, who can only *read* data and *follow* simulations
-* A **Simulation runner**, who can *read* data and *run* simulations
-* An **Creator**, who can *read* data and can *add*, *change* or *delete* schematisations and 3Di models
-* A **Manager**, who can *manage* other roles in the organisation. A manager can not read or write data by default. This role should be appointed separately. 
+The rights of users under your organisation do not expire automatically.
+So, it is important that you regularly check whether users still need their rights.
+This can include employees leaving the organisation or projects coming to an end.
+Sometimes, not all rights need to be revoked; it is also possible to revoke only specific rights.
+It is up to you to determine how often you want to perform this check.
 
-The User Management interface gives you an overview of all users in your organisation. As manager you can distribute the roles to all users within the organisation.
-This is done by clicking the '+' next to the user and choose the roles you want to assign tot the user. Click “Save” to save the changes.
-If you are Manager of multiple organisations you can switch between organisations by using the selection menu next to your username.  
-
-
-.. note::
-    A manager role is required to access the User Management interface.
-    If you wish to obtain one for your organisation, please contact the application manager within your organisation or our :ref:`servicedesk` at [email protected].
-
-
-**Adding a new user**
-
-You can add a new user by clicking the “NEW USER” icon in the upper right corner. This will lead you to the screen to add a new user.
+.. _granting_rights:
 
+Granting rights to new users
+----------------------------
 
-.. figure:: /image/a_usermanagement2.png
-   :alt: The interface for adding a user.
+If a user needs rights for your organisation, you are responsible for granting them.
+For the smooth progress of a project, it is useful to handle such requests promptly.
+Granting rights does not have to be a lengthy task; rights can be granted in a minute.
+For instructions, see :ref:`inviting_new_users` and :ref:`adjusting_existing_rights`.
 
-   The interface for adding a user.
-
-
-By default the new user is granted a 'Viewer' role. At least one role is required when inviting a new user.  
-Press the 'Save' button to finish the invitation process, which results in an invitation email sent to the (new) user. An existing user can use the invitation link to accept the invitation. 
-A new user can create an account by using the :ref:`a_singing_up` guide. When accepted, the user will appear in the User Management overview.
-
-
-.. note::
-   * The invitation email might end up in your spam folder. 
-   * Deselecting all roles will remove the user from the organisation, but will not delete the account of the user.
-   * You cannot remove your own manager role.	
+.. tip:: Use a bookmark to go directly to 3Di Management. This way, you can give a user rights in no time.
 
+.. tip:: Ensure that rights are discussed and granted at the beginning of a project.
+    This prevents delays later due to someone waiting for their rights.
 
-
+.. tip:: Don't forget to remove users' rights after a project is completed.
+    This way, you actively maintain the user database and keep your data under control.
 
 Authorisation
 -------------