Merge branch 'next' of github.com:elabftw/elabdoc into next

* 'next' of github.com:elabftw/elabdoc:
  changes related to version 5.3 (#52)

Author: NicolasCARPi

doc/admin-guide.rst

@@ -3,23 +3,31 @@
 ***********
 Admin guide
 ***********
-This guide is intended for Admins of Teams. An Admin is a User in a Team with Admin rights, and access to the Admin Panel (accessed via the top right menu or the bottom left link). A Team can have several Admins and must have at least one.
+This guide is intended for Admins of Teams. An Admin is a User in a Team with Admin rights, and access to the Admin Panel (accessed via the top right menu). A Team can have several Admins and must have at least one.
+
+.. figure:: img/admin-panel-menu.png
+    :align: center
+    :alt: Admin panel menu link
+
+    Link to the Admin Panel
 
 How to become an Admin?
 =======================
 A User is automatically an Admin if they are the first User in a Team. An Admin can promote another User to the Admin level from the Admin Panel > Users tab. A Sysadmin can promote a User to the Admin level in the same way (from the Sysadmin Panel).
 
 General overview
 ================
-An Admin:
+From the Admin Panel, an Admin can:
+
+* generate a CSV report of usage per user
+* change settings related to the Team internal organization
+* setup onboarding email sent to new users
+* add an informative banner for new users
+* create groups of users
+* manage members of the team: validate accounts or change validity date
+* manage tags
+* execute actions in batch
 
-* Has access to the Admin Panel, where they can change the settings for their entire Team
-* Can validate/archive Users of their Team
-* Can edit available Categories and Status options for Experiments and Resources used by their Team
-* Can edit the default Experiment template
-* Can manage groups of Users within the Team (see below)
-* Can change the rightmost link in the main menu (default is Documentation)
-* Can archive a User, thus disabling login for that account, and locking all Experiments created by that account.
 
 Validating accounts
 ===================
@@ -33,72 +41,19 @@ If you do not wish to validate an account because that User does not belong to y
 
 TEAM tab
 ========
-The first tab in the Admin Panel contains various settings for the Team. This is where you can configure what Users can or cannot do in the Team, and define a default template for Experiments or change the last link in the main menu.
+The first tab in the Admin Panel contains various settings for the Team. This is where you can configure what Users can or cannot do in the Team, and settings related to new users.
 
-GROUPS tab
-==========
+USER GROUPS tab
+===============
 The Admin can create User Groups from the Admin Panel. Once a User Group is created, the Admin can add Users to this Group by typing their names in the input field and selecting the suggested Users. Users in a Group can set the permissions of a Resource/Experiment for that Group such that only members of the Group can see/edit an entry.
 
 Note that it is possible to add Users from other Teams to a User Group.
 
 USERS tab
 =========
-The Users tab allows you to modify User accounts in your Team. From this page, you can reset a password directly or "archive" a User. An "archived" User will no longer be able to login and all of their Experiments will be locked. If a User needs to leave one Team and join a different Team, that User should first be archived in the original Team. Then, a new account (same email) can be created for that User in the new Team. This way, the first Team keeps the data previously inputted by the User, and the User has a fresh account in the new Team using the same email address.
-
-You can also disable multifactor authentication for a particular User, if needed.
-
-From this page, you can also directly add a new User to your Team. The new User will need to activate the "Reset password" functionality to access their account.
-
-Reinitializing 2FA
-------------------
-
-In case a user lost their phone, they might need to re-initialize two factors authentication. This action can be done by an Admin or Sysadmin account. 
-
-.. image:: img/disable-2fa.png
-    :align: center
-    :alt: Disable 2FA
-
-CATEGORIES tab
-==============
-
-This menu allows you to define Categories for Experiments. Categories are very similar to status options: they have a name and a color.
+The Users tab allows limited modification of User accounts member of the Team. Double-click a row in the table to edit the "Valid until" parameter of a user account. If you were give the rights by the Sysadmin, you can possibly manage the association between users and teams, too.
 
-You can also define Categories for Resources. These are similar to Experiment templates because in addition to the name and color, you can define default text/Tags/links/fields.
-
-You can have as many as you want. For instance:
-
-* Antibody
-* Cell line
-* Microscope (you can make it bookable so it can be accessed in the Scheduler, found in the Team tab)
-* Protocol (or you could use a template for this)
-* Computer
-* Software
-* Project
-* Plasmid
-* ...
-
-Select a Category and click "Go" to load it, or click "Create" to add a new Category.
-
-.. image:: img/admin-panel-itemstypes.png
-    :align: right
-    :alt: resources categories tab
-
-
-When you create a new Category, use the default template of that type of item to add fields. For instance, for a Plasmid category you might want to have:
-
-**Concentration:**
-
-**Backbone:**
-
-**Resistance bacteria:**
-
-**Resistance mammalian:**
-
-You can also use :ref:`extra fields <metadata>` defined in the metadata json editor so that all items created in that Category will have these supplementary inputs.
-
-STATUS tab
-==========
-The Status options are editable and customizable. There is one set of Status options for Experiments and another one for Resources.
+From this page, you can also directly add a new User to your Team, if the Sysadmin allows it. The new User will need to activate the "Reset password" functionality to access their account.
 
 EXPORT tab
 ==========
@@ -107,3 +62,7 @@ This tab allows you to export Experiments, items, or scheduled bookings in vario
 TAG MANAGER tab
 ===============
 This interface allows an Admin to edit existing Tags. For instance, if you have Tags called "RPE1" and "RPE-1" and you want all of the Tags to be in the form "RPE-1", find the "RPE1" Tag, click on it to edit it to "RPE-1", and click the Deduplicate button.
+
+BATCH ACTIONS tab
+=================
+This tab allows you to execute actions on many items at once. For instance, changing the visibility of all experiments from a given user, or a given category.

doc/generalities.rst

@@ -9,12 +9,12 @@ Lexicon
 Let's define a few terms first:
 
 * **Instance**: a running eLabFTW service, for example: https://eln.example.org
-* **Team**: the main way to compartimentalize users
-* **Sysadmin**: a user with Sysadmin rights can modify the Instance configuration and create Teams, it is generally the same person that installed the Instance
-* **Admin**: a user with Admin rights for a given team has access to the Admin Panel and can manage settings related to their Team. A given user can be Admin in Team A and User in Team B
-* **User**: a user with an account on the Instance, belonging to at least one Team
+* **Team**: the main unit for a group of users
+* **Sysadmin**: technical role: a user with Sysadmin rights can modify the Instance configuration and create Teams, it is generally the same person that installed the Instance and manages the server.  See the :doc:`Sysadmin guide <sysadmin-guide>`.
+* **Admin**: a user with Admin rights for a given team has access to the Admin Panel and can manage settings related to their Team. A given user can be Admin in Team A and User in Team B. See the :doc:`Admin guide <admin-guide>`.
+* **User**: a user with an account on the Instance, belonging to at least one Team. See the :doc:`User guide <user-guide>`.
 
-We could also mention the role of **Instance Coordinator**, someone identified by the Users as the person to go to for all things eLab in the institution. It might be Research Data Managers, or a designated Researcher or Engineer that is very familiar with eLabFTW. This person could have access to managing the relationship between users and teams. They could animate the internal chat room related to eLabFTW usage.
+We could also mention the role of **Instance Coordinator**, someone identified by the Users as the person to go to for all things eLab in the institution. It might be Research Data Managers, or a designated Researcher or Engineer that is very familiar with eLabFTW. This person could have access to managing the relationship between users and teams. They could animate the internal chat room related to eLabFTW usage. See the :doc:`Instance Coordinator documentation page <coordinator-guide>`.
 
 General principles
 ==================