Skip to content

Commit

Permalink
Merge branch 'next' of github.com:elabftw/elabdoc into next
Browse files Browse the repository at this point in the history
* 'next' of github.com:elabftw/elabdoc:
  add exp/resources description in generalities (#42)
  • Loading branch information
NicolasCARPi committed Jan 8, 2025
2 parents f2cbb0e + 84c864a commit 8c4558a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
12 changes: 7 additions & 5 deletions doc/generalities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,16 @@ Every Team has one or several Admin, who can change many settings affecting user

Teams are created by the Sysadmin from the Sysconfig page (:ref:`see documentation <configure-teams>`).

Entities and permissions
========================
Experiments and Resources
=========================

An Entity is an entry, which can be an Experiment, a Resource or an experiment Template.
There are two main types of records that exist: **Experiments** and **Resources**. They are listed in their corresponding page, accessible from the main top menu.

By default, Experiments and Resources are restricted to a team. But users can choose to extend this to all registered users or even anonymous users if enabled by the Sysadmin.
**Experiments** are the main aspect of the ELN: it is where users log their results.

Experiments belong to a user (owner), while Resources are common to the team and can be edited by anyone from the team (with default permissions).
**Resources** correspond to a repository of *things* present in the lab, generally physical things, such as plasmids, equipment, antibodies, chemical products, etc... They have different properties than experiments, although both objects are similar in many aspects. A Resource can be made bookable (so they can be booked in the Scheduler) or procurable (so we can order more of it).

By default, Experiments and Resources are restricted to a team. But users can choose to extend this to all registered users or even anonymous users if enabled by the Sysadmin. An extensive fine-grained permission system is available for both types of records and their corresponding templates to have complete control on who get to read/write what.

User accounts
=============
Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
sphinx==6.1.3
sphinx_rtd_theme==1.2.0rc3
sphinx==8.1.3
sphinx_rtd_theme==3.0.2
sphinxcontrib-jquery

0 comments on commit 8c4558a

Please sign in to comment.