[Chore] Add brief doc on how reservations work #4798
Conversation
There was a problem hiding this comment.
Thank you for working on this! Very appreciated to have more info that can be handy for future devs (or even our future selves).
As a general comment, I think the paragraphs should be a single line in the file, so there aren't predefined newlines in the middle of the sentences. This is also a problem in lines 53-54, where the header is split
|
@LeticiaErrandonea I would keep short lines, they are easier to read from source and don't affect the markdown rendering. |
doc/HOWTO_reservations.md
Outdated
| it as part of its items. | ||
| Instruments are a type of Product which whose usage can be purchased by users | ||
| through Reservations. So whenever a new reservation is created, an order is | ||
| created or updated to include the Instrument as part of its items with a cost |
There was a problem hiding this comment.
item is a type of product 😅
Maybe we can say So whenever a new reservation is created, an order is created or updated to include the Instrument as part of its items order details?
doc/HOWTO_reservations.md
Outdated
| pricing policy which can be one of three types: | ||
|
|
||
| 1. Schedule Rule: charge per minute with fixed rate. | ||
| 2. Duration: charge per minute with a layered rate depending on the duration. |
There was a problem hiding this comment.
nit: usually we refer to it as "stepped" rate
doc/HOWTO_reservations.md
Outdated
| 3. Schedule Rule (Daily Booking): charged per day with fixed rate. | ||
|
|
||
| The first two allow reservations to be defined on a per minute basis while the | ||
| third one is done in 24 hours blocks. |
There was a problem hiding this comment.
nit: 24-hour blocks
Add howto reservations work.