Skip to content

Commit d08c218

Browse files
committed
fix the coordinator page and add two sections
also remove the part about the archived entries being not duplicable/exportable. They are.
1 parent d126c0d commit d08c218

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

doc/coordinator-guide.rst

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ What is an Instance Coordinator
99

1010
An instance coordinator helps manage the users in an instance. For example, they may add and remove users from different teams, and help to implement exit strategies for users and data. More information about the utility of this role and helpful strategies will be added soon!
1111

12+
Training sessions
13+
=================
14+
15+
As an instance coordinator, it is a good idea to organize training sessions for users. You can either opt for Deltablot's training session or make one yourself. It can also just be a discussion with users about their use of the software and the difficulties they might have with it and how to adress them.
16+
17+
Internal exchange
18+
=================
19+
20+
In order to help users, we recommend making available a place for everyone to exchange on eLabFTW. It could be a Slack/Teams/Mattermost channel, or a forum or anything else that is easy to access for everyone involved. They can use this place to ask questions directly to the coordinator.
21+
1222

1323
Different strategies for managing users in teams
1424
================================================
@@ -18,11 +28,23 @@ When a user leaves a team
1828

1929
In eLabFTW, there are currently several options for handling the data of users who are about to leave a team. Here are four exit strategies to consider:
2030

21-
1. Archiving the user and their entries
31+
A. Archiving the user and their entries
32+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33+
34+
2235
If a person is only a member of one team, they can be archived. In this process, it's possible to choose whether their associated entries should also be locked and archived. This method ensures a clean separation, but it is only suitable if the person belongs to a single team. If the person is active in multiple teams, archiving them would also archive them in the other teams, which is usually not desired.
23-
2. Adjusting visibility and write permissions
36+
37+
B. Adjusting visibility and write permissions
38+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
39+
2440
Another exit strategy involves explicitly setting the visibility and write permissions of the entries for the team the person is leaving. To ensure that the entries remain visible to the team after the user’s departure, the corresponding permissions for all entries need to be updated. This can be done by a team admin as a bulk action through the admin control panel. This way, the team retains access to experiments and entries without the person remaining part of the team.
25-
3. Transferring ownership or duplicating entries
41+
42+
C. Transferring ownership or duplicating entries
43+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
44+
2645
Another option is to transfer ownership of the entries to another team member. Alternatively, relevant entries can be duplicated before the person is removed from the team. Once a person is removed from the team, their entries are no longer visible to the team, which also means that the original ownership becomes unclear. To avoid this, the name of the original creator can be added to the entry title or stored as a tag to make the data origin more transparent.
27-
4. Restricting the visibility of entries
46+
47+
D. Restricting the visibility of entries
48+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
49+
2850
Instead of removing the person from the team, they can remain a member while limiting the visibility of their entries. Access rights can be managed so that only the original owner and admins have access to certain entries. This ensures that the person leaving the team cannot access information irrelevant to them, while still technically remaining in the team.

doc/user-guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Archived experiments will now appear in the list, indicated by a small archive i
119119
Working with Archived Experiments
120120
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
121121

122-
While archived experiments remain viewable, they are read-only. To perform any actions such as editing, duplicating, or exporting, you must first unarchive the experiment.
122+
While archived experiments remain viewable, they are read-only. To edit it again, you must first unarchive the experiment.
123123

124124
You can multiselect experiments to unarchive them in bulk:
125125

@@ -137,7 +137,7 @@ Alternatively, you can open an individual archived experiment to review its cont
137137

138138
More options > unarchive
139139

140-
Once unarchived, the experiment will return to the active list and be fully editable and exportable again.
140+
Once unarchived, the experiment will return to the active list and be fully editable again.
141141

142142
.. _delete-experiments:
143143

0 commit comments

Comments
 (0)