Skip to content

Commit 1dbaa7d

Browse files
committed
feature: Adds Users & Staff docs (#497)
1 parent 06ccbaf commit 1dbaa7d

File tree

3 files changed

+74
-1
lines changed

3 files changed

+74
-1
lines changed

docs/docs-overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Documentation to get you started:
1212
- [Questionnaires](questionnaires.md)
1313
- [Messages](messages.md)
1414
- [Bus Lists](busses.md)
15+
- [Users & Staff](users-and-staff.md)
1516
- _More to come..._
1617

1718
## Timeline of a hackathon

docs/users-and-staff.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
id: users-and-staff
3+
title: Users & Staff
4+
---
5+
6+
**Accessible by:** Directors
7+
8+
The Users & Staff page is an easy way to manage the users of your hackathon's HackathonManager instance. In addition to attendees, you can also manage volunteers, organizers and directors.
9+
10+
## User Management
11+
Certain attributes within a user can be modified.
12+
13+
**Email:** The email for the user, used for signing into HackathonManager.
14+
**Role:** Role for the user, see [Roles](#roles).
15+
**Login access:** Allow/Block login for that specific user. Will also disable the weekly report email if that user is an admin.
16+
**Receive weekly report:** A weekly email report on admissions, bus lists, and messages. Only sent when there are weekly updates up until 7 days past the event.
17+
18+
19+
## Roles
20+
Roles allow for organization and permission access for users. There are four roles within HackathonManager: **User**, **Volunteer**, **Organizer** and **Director** with Director being the highest.
21+
22+
### Permissions
23+
The following are permissions for all admin roles. An admin role is any role other than User that has access to the admin dashboard. User can only create, view, edit and delete their own questionnaire.
24+
25+
| | Volunteer | Organizer | Director |
26+
|---|:-:|:-:|:-:|
27+
| `View Questionnaires` | ✔️ | ✔️ | ✔️ |
28+
| `Create Questionnaires` | | | ✔️ |
29+
| `Update Questionnaires` | | | ✔️ |
30+
| `Destroy Questionnaires` | | | ✔️ |
31+
| `Check in Hackers` | ✔️ | ✔️ | ✔️ |
32+
| `View Messages` | | ✔️ | ✔️ |
33+
| `Modify Message Triggers` | | | ✔️ |
34+
| `Send Messages` | | | ✔️ |
35+
| `Create Messages` | | | ✔️ |
36+
| `Update Messages` | | | ✔️ |
37+
| `Destroy Messages` | | | ✔️ |
38+
| `View Statistics` | | ✔️ | ✔️ |
39+
| `View Trackable Tags` | | ✔️ | ✔️ |
40+
| `(API) View Trackable Tags` | ✔️ | ✔️ | ✔️ |
41+
| `Create Trackable Tags` | | | ✔️ |
42+
| `Update Trackable Tags` | | | ✔️ |
43+
| `Destroy Trackable Tags` | | | ✔️ |
44+
| `View [own] Trackable Events` | ✔️ | ✔️ | ✔️ |
45+
| `View [other] Trackable Events` | | ✔️ | ✔️ |
46+
| `Create Trackable Events` | ✔️ | ✔️ | ✔️ |
47+
| `Destroy [own] Trackable Events` | ✔️ | ✔️ | ✔️ |
48+
| `Destroy [other] Trackable Events`| | | ✔️ |
49+
| `View Schools` | ✔️ | ✔️ | ✔️ |
50+
| `Create Schools` | | | ✔️ |
51+
| `Update Schools` | | | ✔️ |
52+
| `Merge Schools` | | | ✔️ |
53+
| `Message Schools` | | | ✔️ |
54+
| `View Users & Staff` | | | ✔️ |
55+
| `Update Users & Staff` | | | ✔️ |
56+
| `Destroy Users & Staff` | | | ✔️ |
57+
| `Modify Account Role` | | | ✔️ |
58+
| `View Legal Agreements` | | | ✔️ |
59+
| `Update Legal Agreements` | | | ✔️ |
60+
| `Destroy Legal Agreements` | | | ✔️ |
61+
| `View Hackathon Settings` | | | ✔️ |
62+
| `Update Hackathon Settings` | | | ✔️ |
63+
| `View App Authentication` | | | ✔️ |
64+
| `Create OAuth2 Applications` | | | ✔️ |
65+
| `Update OAuth2 Applications` | | | ✔️ |
66+
| `Destroy OAuth2 Applications` | | | ✔️ |
67+
| `View Sidekiq` | | | ✔️ |
68+
| `View Blazer` | | | ✔️ |
69+
| `View Data Exports` | | | ✔️ |
70+
| `Export Hackathon Data` | | | ✔️ |
71+
_Own:_ Objects/events that were created by that user.
72+
_Other:_ Objects/events that were created by any user.

website/sidebars.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"updating-hm",
1313
"2.0-whats-new"
1414
],
15-
"Docs": ["docs-overview", "questionnaires", "messages", "busses"],
15+
"Docs": ["docs-overview", "questionnaires", "messages", "busses", "users-and-staff"],
1616
"API": ["api-overview", "api-testing-setup"],
1717
"Getting Help": ["resources"]
1818
}

0 commit comments

Comments
 (0)