diff --git a/docs/usage/user-guide/resources.md b/docs/usage/user-guide/resources.md index e8ecf92..831dd63 100644 --- a/docs/usage/user-guide/resources.md +++ b/docs/usage/user-guide/resources.md @@ -8,8 +8,14 @@ title: Resources Resources are similar to Experiments, but serve a different purpose: listing and organizing *things* that are used in Experiments. Many of the options on the Resource entry are the same as those for an Experiment entry. +
+ Resources menu +
Resources dropdown menu.
+
+ +## Resource Categories -Resources Categories can be defined at the team level from the "Resources Categories" page available in the Resources dropdown menu. You can for example have such categories: +Resource Categories can be defined at the team level from the "Resource Categories" page available in the Resources dropdown menu. You can, for example, define categories such as: * Antibodies * Microscopes @@ -19,79 +25,66 @@ Resources Categories can be defined at the team level from the "Resources Catego * Equipment * Projects -Once you have Resources Categories (which are simply composed of the name and a color), you can create a Resource Template with that category assigned. This allows you to have several Resources Templates for a given Category. +Once you have Resource Categories (which are composed of a name and a color), you can create a Resource Template with that category assigned. This allows you to have several Resource Templates for a given category. -For instance, in the Resource Category "Antibodies", you might want to have a Resource Template for "Primary Antibody" and one for "Secondary Antibody". It's also fine to keep a one-to-one relationship between Resources Templates and Resources Categories. +For instance, in the Resource Category "Antibodies", you might want a Resource Template for "Primary Antibody" and one for "Secondary Antibody". It's also fine to keep a one-to-one relationship between Resource Templates and Resource Categories. -Resources' default permissions allow anyone from the Team to edit them, but you are free to configure them differently from their Template. +Resources default permissions allow anyone from the Team to edit them, but you are free to configure them differently from their Template. -Look at the :ref:`importing-data` section to learn how to import your Resources from a spreadsheet file or through the API. +## Imports +Look at the [Importing data](../import-export#importing-data) section to learn how to import your Resources from a spreadsheet file or through the API. + +## Links Once you have your Resources present, you can mention them in your Experiments by typing `#` and their title, and selecting the proposed autocompletion, or use directly the Link system to link them to an Experiment. +See [Links](./experiments#linked-resourcesexperiments) section. Furthermore, Resources can be made bookable, see section below. ## Booking Resources It is possible to use the scheduler (calendar) present on the Scheduler page to book Resources. +
+ Scheduler page +
Scheduler page.
+
## Making a Resource bookable -In order to book a Resource, it needs to be bookable (they are not by default). To do that, go to the Resource, and click "Modify booking parameters" from the top right menu with three vertical dots: +To book a Resource, it must be made bookable. Resources are not bookable by default. + +To make a resource bookable, open its page and click the `Modify booking parameters` button from the toolbar.
- modify booking menu -
Modify booking menu.
+ activate booking parameters +
Toolbar: Modify booking parameters.
-This will show a modal window with various settings: +Once this parameter has been activated, clicking this same button will redirect you to the scheduler with the resource selected. +If you wish to edit parameters later on, click on the top right menu with three vertical dots:
- modify-booking-modal -
Modify booking modal.
+ modify booking menu +
Modify booking menu.
-### Settings description - -| Setting | Description | -|----------------------------------------------------|------------| -| Allow booking this Resource | This is a general toggle to allow booking of the Resource | -| Allow overlapping slots | Control whether it is allowed to have more than one booking slot at the same time | -| Maximum slot time (in minutes) | Maximum number of minutes allowed for a single booking slot | -| Maximum per-User future slot allowed | Number of future slots allowed for a particular User/Resource couple | -| Allow cancelling a booking slot | Control whether Users are allowed to cancel a booking | -| Minimum time before a slot can be cancelled (in minutes) | If "now" is closer than this number of minutes to the start of the event, it will not be possible to cancel it | - - -## Adjusting permissions - -When a Resource is bookable, a new permission appears: "Can book": +A modal with various settings opens:
- can book settings -
Modify booking permissions.
+ modify-booking-modal +
Modify booking modal.
-By default, it will match who can read the entry, but it can be adjusted to fine tune who exactly has access to this Resource for booking it. - -## Archiving and deleting resources - -Resources can be archived or deleted just like experiments. The behavior is exactly the same. - -## Using the scheduler - -Once all is set, Users can click the "Book item" button in the toolbar, or select it from the Scheduler page, and click the calendar to drag a booking slot. - +Once all is set, Users can click the `Book item` button in the toolbar, or select it from the Scheduler page, and click the calendar to drag a booking slot.
- book-item-button + book-item-button
Booking in item button.
-Clicking an existing slot will display a modal window allowing several options such as binding the slot to an Experiment or another Resource, or cancel booking, with or without sending a notification to Users. - +The scheduler page loads with the selected item:
- book-edit-modal -
Booking a resource modal window.
+ scheduler selected item +
Selected item in the scheduler page.
-Note: "Past and future Users who booked this Resource" means all Users who booked the Resource in the past two months and the ones who booked it in the upcoming month. +You can now move on to the [Scheduler](./scheduler) section to see how to work with your events. diff --git a/docs/usage/user-guide/scheduler.md b/docs/usage/user-guide/scheduler.md new file mode 100644 index 0000000..b82b421 --- /dev/null +++ b/docs/usage/user-guide/scheduler.md @@ -0,0 +1,119 @@ +--- +sidebar_position: 4 +title: Scheduler +--- + +# Scheduler + +It is possible to use the scheduler (calendar) to book Resources. + +Before proceeding, make sure you have a bookable resource. See [Make a resource bookable](./resources#making-a-resource-bookable) section. + +Select an item by typing its name in the searchbar. +
+ select an item +
Select an item to create an event.
+
+ +You can now drag-and-drop a slot, confirm the "Title" of the event and click the `Create event(s)` button. You can select multiple resources to create many events at the same time. +
+ scheduler create events modal +
Modal to confirm creation of events.
+
+ +Once created, you will be able to see a list of your scheduled bookings in the main page (dashboard). +
+ scheduled bookings in dashboard +
Scheduled bookings in the dashboard.
+
+ +## Events + +On the scheduler page, the items listed are called Events. Clicking an existing slot displays a modal window with different information: +
+ scheduler events +
Events in the scheduler.
+
+ +
+ modal view of an event +
Viewing an event.
+
+ +The first line indicates the Title (or Comment) of the event. It is defined by the user when creating or editing the event. + +Below are the date of the event, the time slot, and the duration in minutes. + +### Bindings + +You can bind the slot to an experiment or a resource. Start typing on the "Search" textbox and select the entry you wish to relate to this event. +
+ Bind an experiment to an event. +
Binding an experiment to the event.
+
+ +You can then view or unbind the entry. +
+ View or unbind +
View or unbind an experiment.
+
+ +### Edit an event + +Click the `Edit` button to edit an event. You can modify its title and starting/ending hours. + +
+ Edit an event +
Edit an event.
+
+ +In the scheduler page, you can update an event with the following actions: + +- Drag-and-drop: Move the event to the desired start time. +- Drag (by the end): Move only the ending hour of the event. + +
+ Edit an event +
Different actions on an event.
+
+ +### Cancel an event + +Click the `Cancel` button to cancel an event. + +
+ Delete an event +
Delete an event.
+
+ +You can add a custom message to inform the team members who are connected to this event. You can either send to **Members of the team** or to a list of users who booked this resource in a specific time range. + +### Browse events + +You can use the filters to reduce clutter on the scheduler view and look for specific events. + +
+ filtering by category +
Filtering by category.
+
+ +
+ filtering by owner +
Filtering by owner.
+
+ +## Adjusting permissions + +When a Resource is bookable, a new permission appears: "Can book": + +
+ can book settings +
Modify booking permissions.
+
+ +By default, it will match the `Visibility` permission of the entry, but it can be adjusted to fine-tune who exactly has access to this Resource for booking it. + +## Archiving and deleting resources + +Resources can be archived or deleted just like experiments. The behavior is the exact same. See [Archival](./experiments#archival) section. + diff --git a/static/img/book-item-button.png b/static/img/book-item-button.png deleted file mode 100644 index 39e4546..0000000 Binary files a/static/img/book-item-button.png and /dev/null differ diff --git a/static/img/book-item-button.webp b/static/img/book-item-button.webp new file mode 100644 index 0000000..1d5c424 Binary files /dev/null and b/static/img/book-item-button.webp differ diff --git a/static/img/can-book-setting.png b/static/img/can-book-setting.png deleted file mode 100644 index 6281056..0000000 Binary files a/static/img/can-book-setting.png and /dev/null differ diff --git a/static/img/can-book-setting.webp b/static/img/can-book-setting.webp new file mode 100644 index 0000000..27a5cfd Binary files /dev/null and b/static/img/can-book-setting.webp differ diff --git a/static/img/modify-booking-menu.png b/static/img/modify-booking-menu.png deleted file mode 100644 index d00abcd..0000000 Binary files a/static/img/modify-booking-menu.png and /dev/null differ diff --git a/static/img/modify-booking-menu.webp b/static/img/modify-booking-menu.webp new file mode 100644 index 0000000..c6467be Binary files /dev/null and b/static/img/modify-booking-menu.webp differ diff --git a/static/img/modify-booking-modal.png b/static/img/modify-booking-modal.png deleted file mode 100644 index aa4958b..0000000 Binary files a/static/img/modify-booking-modal.png and /dev/null differ diff --git a/static/img/modify-booking-modal.webp b/static/img/modify-booking-modal.webp new file mode 100644 index 0000000..6eef310 Binary files /dev/null and b/static/img/modify-booking-modal.webp differ diff --git a/static/img/resource-activate-booking.webp b/static/img/resource-activate-booking.webp new file mode 100644 index 0000000..df92041 Binary files /dev/null and b/static/img/resource-activate-booking.webp differ diff --git a/static/img/resources-menu.webp b/static/img/resources-menu.webp new file mode 100644 index 0000000..1b3491d Binary files /dev/null and b/static/img/resources-menu.webp differ diff --git a/static/img/scheduled-bookings.webp b/static/img/scheduled-bookings.webp new file mode 100644 index 0000000..51ef116 Binary files /dev/null and b/static/img/scheduled-bookings.webp differ diff --git a/static/img/scheduler-bind-experiment.webp b/static/img/scheduler-bind-experiment.webp new file mode 100644 index 0000000..8a91ee0 Binary files /dev/null and b/static/img/scheduler-bind-experiment.webp differ diff --git a/static/img/scheduler-binded.webp b/static/img/scheduler-binded.webp new file mode 100644 index 0000000..04e2fab Binary files /dev/null and b/static/img/scheduler-binded.webp differ diff --git a/static/img/scheduler-create-events.webp b/static/img/scheduler-create-events.webp new file mode 100644 index 0000000..6044258 Binary files /dev/null and b/static/img/scheduler-create-events.webp differ diff --git a/static/img/scheduler-delete-event.webp b/static/img/scheduler-delete-event.webp new file mode 100644 index 0000000..42dd547 Binary files /dev/null and b/static/img/scheduler-delete-event.webp differ diff --git a/static/img/scheduler-edit-event.webp b/static/img/scheduler-edit-event.webp new file mode 100644 index 0000000..8410f51 Binary files /dev/null and b/static/img/scheduler-edit-event.webp differ diff --git a/static/img/scheduler-event-actions.gif b/static/img/scheduler-event-actions.gif new file mode 100644 index 0000000..33ffb18 Binary files /dev/null and b/static/img/scheduler-event-actions.gif differ diff --git a/static/img/scheduler-event-view.webp b/static/img/scheduler-event-view.webp new file mode 100644 index 0000000..02180d4 Binary files /dev/null and b/static/img/scheduler-event-view.webp differ diff --git a/static/img/scheduler-event.webp b/static/img/scheduler-event.webp new file mode 100644 index 0000000..60a9626 Binary files /dev/null and b/static/img/scheduler-event.webp differ diff --git a/static/img/scheduler-filters-category.webp b/static/img/scheduler-filters-category.webp new file mode 100644 index 0000000..36d841b Binary files /dev/null and b/static/img/scheduler-filters-category.webp differ diff --git a/static/img/scheduler-filters-owner.webp b/static/img/scheduler-filters-owner.webp new file mode 100644 index 0000000..d273be6 Binary files /dev/null and b/static/img/scheduler-filters-owner.webp differ diff --git a/static/img/scheduler-select-item.webp b/static/img/scheduler-select-item.webp new file mode 100644 index 0000000..4a39b34 Binary files /dev/null and b/static/img/scheduler-select-item.webp differ diff --git a/static/img/scheduler-selected-item.webp b/static/img/scheduler-selected-item.webp new file mode 100644 index 0000000..96dfc46 Binary files /dev/null and b/static/img/scheduler-selected-item.webp differ diff --git a/static/img/scheduler.webp b/static/img/scheduler.webp new file mode 100644 index 0000000..5cf0cf1 Binary files /dev/null and b/static/img/scheduler.webp differ