Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add exp/resources description in generalities #42

Merged
merged 2 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"There are two main types of entries in eLabFTW: Experiments and Resources. They are listed on separate index pages that are accessible from the main menu bar."


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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"However, users can extend access to other registered users... "

"Experiments are the main aspect of eLabFTW: this is where users document their procedures and 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The first sentence on line 64 is a repeat of line 60 - (I would delete this second one)
    "...both types of entries"
    "....complete control over read and write permissions"


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
Loading