From 84c864ab725a82d123db401e18d9b0f642a577c2 Mon Sep 17 00:00:00 2001 From: Nicolas CARPi <3043706+NicolasCARPi@users.noreply.github.com> Date: Wed, 8 Jan 2025 14:44:32 +0100 Subject: [PATCH] add exp/resources description in generalities (#42) * add exp/resources description in generalities and bump sphinx versions because it doesn't work with python 3.13 otherwise * fix typo --- doc/generalities.rst | 12 +++++++----- requirements.txt | 4 ++-- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/doc/generalities.rst b/doc/generalities.rst index 81fb13e..cb42a2c 100644 --- a/doc/generalities.rst +++ b/doc/generalities.rst @@ -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 `). -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 ============= diff --git a/requirements.txt b/requirements.txt index 3c76ffc..8f346a4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -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