add exp/resources description in generalities #42
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
and bump sphinx versions because it doesn't work with python 3.13 otherwise
sjkoke
approved these changes
Jan 8, 2025
sjkoke
reviewed
Jan 8, 2025
|
|
||
| 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. |
There was a problem hiding this comment.
"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."
| 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, equipments, 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. |
There was a problem hiding this comment.
- 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"
|
|
||
| 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. |
There was a problem hiding this comment.
"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."
doc/generalities.rst
Outdated
|
|
||
| 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, equipments, 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). |
There was a problem hiding this comment.
"Resources correspond to things that are present in the lab. These could be plasmids, equipment, antibodies, chemical products, etc... Resources have different properties than experiments, although they are similar in many aspects. A Resource can be made bookable (so that it can be booked in the Scheduler) or procurable (so that a team member can order more of it).
NicolasCARPi
added a commit
that referenced
this pull request
Jan 8, 2025
* 'next' of github.com:elabftw/elabdoc: add exp/resources description in generalities (#42)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
and bump sphinx versions because it doesn't work with python 3.13 otherwise