You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 4e86dd0
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,8 @@
6
6
7
7
A web application for tracking equipment status and coordinating repairs at community makerspaces, originally developed for [Decatur Makers](https://decaturmakers.org). Provides a single source of truth so members know what's working, technicians know what needs fixing, and staff can coordinate it all.
8
8
9
+
At Decatur Makers, ESB is available from the space or while connected to the VPN at [http://esb.decaturmakers.org:8000](http://esb.decaturmakers.org:8000).
10
+
9
11
## Features
10
12
11
13
-**Equipment Registry & Status Tracking** — Maintain a registry of all equipment organized by area, with live green/yellow/red status derived from open repair records
@@ -40,6 +42,7 @@ Full user guides and administrator documentation are available at:
40
42
-[Members Guide](https://decaturmakers.github.io/equipment-status-board/members/) — Checking status, scanning QR codes, reporting problems
Copy file name to clipboardExpand all lines: docs/index.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,10 @@ A large-screen display mode designed for wall-mounted monitors or projectors in
28
28
29
29
A lightweight status page that can be hosted externally (e.g., on S3) for checking equipment status from anywhere, even outside the local network.
30
30
31
+
### Equipment Reservations
32
+
33
+
View reservable equipment on the reservation calendar. Members can create and manage their own reservations from Slack, technicians can manage reservations, and staff can configure equipment policies. See the [Reservations Guide](reservations.md).
34
+
31
35
{% if slack_enabled %}
32
36
### Slack Integration
33
37
@@ -65,6 +69,7 @@ This documentation is organized by role. Find the guide that matches how you use
65
69
-**[Members Guide](members.md)** — For anyone using the makerspace. Learn how to check equipment status, scan QR codes, and report problems. No account needed.
66
70
-**[Technicians Guide](technicians.md)** — For volunteer repair technicians. Learn how to work the repair queue, manage repair records, and use Slack commands.
67
71
-**[Staff Guide](staff.md)** — For makerspace managers. Learn how to use the Kanban board, manage equipment and users, and configure the system.
72
+
-**[Reservations Guide](reservations.md)** — For members reserving equipment and the technicians or staff who manage reservations and policies.
68
73
-**[Administrators Guide](administrators.md)** — For technical volunteers deploying and maintaining the system. Covers Docker deployment, environment configuration, Slack App setup, and ongoing maintenance.
Use reservations to check when equipment is available, reserve equipment through Slack, or manage reservations and equipment policies if your role allows it.
4
+
5
+
## View the Reservation Calendar
6
+
7
+
{% if reservation_url %}
8
+
Select [**Reservations**]({{ reservation_url }}) in the Equipment Status Board navigation.
9
+
{% else %}
10
+
Select **Reservations** in the Equipment Status Board navigation.
11
+
{% endif %}
12
+
13
+
The calendar shows each reservable equipment item in a separate column. A block labeled **Reserved** shows an unavailable time. The calendar does not show the name of the member who made the reservation.
14
+
15
+
Use **Previous**, the date field, or **Next** to view another day. If the page says that no reservable tools are configured, ask a staff member whether reservations are available for the equipment you need.
16
+
17
+
{% if slack_enabled %}
18
+
## Reserve Equipment in Slack
19
+
20
+
Before you start, make sure that your Slack account is linked to an active ESB user. Ask a staff member for help if Slack says that your account is not linked.
21
+
22
+
### Create a Reservation
23
+
24
+
1. Enter `/esb-reserve` in Slack.
25
+
2. Select **Reserve** for the equipment you need.
26
+
3. Review the listed unavailable times and reservation limits.
27
+
4. Enter a start time and an end time.
28
+
5. Enter a note if it helps other users understand the reservation.
29
+
6. Select **Reserve**.
30
+
31
+
{ .docs-screenshot-compact }
32
+
33
+
Slack shows a confirmation with the equipment, time, and note.
34
+
35
+
If your requested time is unavailable or does not meet the equipment reservation policy, Slack shows the reason. Select **Choose another time** and enter a valid time.
36
+
37
+
### View or Cancel Your Reservations
38
+
39
+
1. Enter `/esb-reserve` in Slack.
40
+
2. Select **My reservations**.
41
+
3. To cancel a reservation, select **Cancel reservation**.
42
+
4. Review the reservation details.
43
+
5. Select **Cancel reservation** to confirm.
44
+
45
+
{ .docs-screenshot-compact }
46
+
47
+
You can cancel only an active reservation that belongs to you. Slack confirms when the reservation is canceled.
48
+
{% endif %}
49
+
50
+
## Manage Reservations
51
+
52
+
Technicians and staff can manage reservations in the web application. Select **Admin**, then select **Reservations**.
53
+
54
+
### View Reservations and History
55
+
56
+
The **Calendar** view shows reservations for one day. Use **Previous**, **Today**, or **Next** to change the displayed day.
57
+
58
+
Select **History** to view reservation records. Use the filters to limit the results by date range, area, equipment, member, status, or source. The source is either **Slack** or **Admin**.
59
+
60
+
An active reservation can be edited or canceled. A canceled reservation remains in the history.
61
+
62
+
### Create a Reservation or Administrative Hold
63
+
64
+
1. Select **New Reservation**.
65
+
2. Select **Member reservation** or **Admin hold**.
66
+
3. Select the equipment.
67
+
4. If you selected **Member reservation**, select the member.
68
+
5. Enter the start date, start time, duration, and note.
69
+
6. Select **Review reservation**.
70
+
7. Review the reservation details and any policy warnings.
71
+
8. Confirm the reservation.
72
+
73
+
An administrative hold blocks a time without assigning the reservation to a member. All administrative reservations and holds require a note.
74
+
75
+
### Edit or Cancel a Reservation
76
+
77
+
To edit an active reservation, select **Edit**, update the fields, review the changes, and confirm the replacement reservation. The system cancels the previous reservation and preserves it in the history.
78
+
79
+
To cancel an active reservation, select **Cancel**, then confirm the cancellation. You cannot edit or cancel a reservation that is already canceled.
80
+
81
+
## Configure Reservation Policies
82
+
83
+
Only staff can configure reservations for an equipment item.
84
+
85
+
1. Open the equipment detail page.
86
+
2. Select **Reservation Settings**.
87
+
3. Select **Allow reservations** to make the equipment available for reservations.
88
+
4. Enter a **Reservation slug**.
89
+
5. Set the advance-notice, duration, and slot-granularity limits.
90
+
6. Select **Save Reservation Settings**.
91
+
92
+
Use a reservation slug that contains lowercase letters, numbers, and single hyphens only. For example, use `laser-cutter-1`.
93
+
94
+
Set **Minimum advance notice** and **Maximum advance notice** to control how soon and how far ahead members can reserve the equipment. Set **Minimum duration** and **Maximum duration** to control reservation length. Set **Slot granularity** to control the allowed start-time and duration increments.
95
+
96
+
The maximum advance notice must be at least the minimum advance notice. The maximum duration must be at least the minimum duration. Both duration limits must be exact multiples of the slot granularity.
97
+
98
+
Clear **Allow reservations** to prevent new reservations for the equipment. You cannot configure reservations for archived equipment.
0 commit comments