Skip to content

Commit fb6c601

Browse files
amthornamthorn
authored
Issue #30: partial user guide and some bug fixes (#32)
* partial user guide and some bug fixes * finished documentation
1 parent 874f68f commit fb6c601

32 files changed

+768
-72
lines changed

‎docs/administration.md

Lines changed: 81 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,94 @@
22

33
## What is an Administrator?
44

5-
## Administrator Privileges
5+
An administrator is someone that is responsible for managing a project and all its components. This includes anything that is stored under the project, which includes [queues](/queues) and other administrators.
66

7-
### Responsibilities
7+
## Administrator Privileges
88

9-
### Limitations
9+
Administrator privileges are the permissions that a project administrator has. This includes running commands that are not runnable by anyone else. A list of those commands can be found [here](/command_list)
1010

1111
### Recommendations
1212

13-
## Adding New Administrators
13+
All project administrators should manage the users for that project with respect.
14+
15+
## Adding Administrators
16+
17+
{% include "auth_project_admin.md" %}
18+
19+
You can add individual admins to a project by tagging them using the following command:
20+
21+
=== "Generic"
22+
```
23+
create admin <project_name>
24+
```
25+
=== "Valid Example"
26+
```
27+
create admin valid
28+
```
29+
=== "Invalid Example"
30+
```
31+
create admin NOT&^%VALID
32+
```
33+
=== "Regex"
34+
```
35+
^\s*create admin [\w\s]+\s*$
36+
```
37+
38+
???+ important
39+
You must **tag** the person to add as an admin.
40+
41+
???+ example
42+
<img src="/images/createAdmin.png" width=350/>
43+
44+
???+ note
45+
You cannot add an admin that already exists.
46+
47+
???+ Caution
48+
You should not add people as an administrator unless you have talked with them and are sure they would like to be made an administrator. When they are made an admin, data will be stored about them such as username and display name. See the [Qutex Privacy Policy](https://github.com/amthorn/qutex/wiki/Privacy-Policy) for more information.
1449

1550
## Removing Administrators
1651

52+
{% include "auth_project_admin.md" %}
53+
54+
You can remove individual admins to a project by tagging them using the following command:
55+
56+
=== "Generic"
57+
```
58+
delete admin <project_name>
59+
```
60+
=== "Valid Example"
61+
```
62+
delete admin valid
63+
```
64+
=== "Invalid Example"
65+
```
66+
delete admin NOT&^%VALID
67+
```
68+
=== "Regex"
69+
```
70+
^\s*(delete|remove) admin [\w\s]+\s*$
71+
```
72+
73+
???+ important
74+
You must **tag** the person to remove as an admin.
75+
76+
???+ note
77+
You cannot remove an admin that does not exist. I should hope that would be obvious.
78+
79+
???+ warning
80+
There must always be at least one admin on every project at any given time. If you try to remove the final admin on a project, you will get an error.
81+
1782
## Listing Administrators
1883

19-
<!-- dont add people unless you are sure they would like to be added. reference privacy policy -->
84+
{% include "public.md" %}
85+
86+
Listing all administrators is possible by issuing the following command:
87+
88+
=== "Generic"
89+
```
90+
list admins
91+
```
92+
=== "Regex"
93+
```
94+
^\s*list admins\s*$
95+
```

‎docs/analytics.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
## Graphs
44

5-
## Largest Queue Depth
5+
## Queue Length History
66

7-
## Queue Length History
7+
{% include "public.md" %}
8+
9+
You can use Qutex to generate some basic graphs that show statistical trends in the data that is collected by Qutex. One such graph is the graph of Queue Length over time. Qutex will also respond a link by which you can view your chart in a browser or download the chart. You can get this graph by invoking the following command:
10+
11+
=== "Generic"
12+
```
13+
get queue length history
14+
```
15+
=== "Regex"
16+
```
17+
^\s*get queue length history\s*$
18+
```
19+
20+
???+ example
21+
<img src="../images/queueLengthHistory.png" width=350/>
22+
23+
???+ note
24+
To get these graphs, Qutex leverages [QuickChart](https://quickchart.io/) to build and generate the graphs. No personal data is sent here. See the [Qutex Privacy Policy](https://github.com/amthorn/qutex/wiki/Privacy-Policy) for more information.

‎docs/authorization.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# Authorization
22

3-
## None
3+
## None {% include "public_shield.md" %}
44

5-
## Project Administrator
5+
If a command requires no permissions, otherwise known as a public command, then anyone can execute that command without the need for any special permissions.
66

7-
## Super Administrator
7+
## Project Administrator {% include "auth_project_admin_shield.md" %}
8+
9+
If a command requires project administrator permission, then only those who are registered as a [project administrator](/administration) can execute that command.
10+
11+
## Super Administrator {% include "auth_super_admin_shield.md" %}
12+
13+
If a command requires super administrator permission, then only those who are registered as a super administrator can execute that command. Currently, there is no way to request or elevate to super administrator privileges. If you need a command to be run that requires super administrator permissions, please reach out directly to the Qutex team.

‎docs/blocks/auth_project_admin.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<span class="tooltip hint--right" aria-label="The commands listed in this section require project administrator access.">
2+
<a href="/authorization/#project-administrator"><font color="orange" size=4>:material-shield-account:</font>Project Admin</a>
3+
</span>

‎docs/blocks/auth_project_admin_shield.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<span class="tooltip hint--top" aria-label="Project Administrator"><a href="/authorization/#project-administrator"><font color="orange" size=4>:material-shield-account:</font></a></span>

‎docs/blocks/auth_super_admin.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<span class="tooltip hint--right" aria-label="The commands listed in this section require super administrator access.">
2+
<a href="/authorization/#super-administrator"><font color="red" size=4>:material-shield-star:</font>Super Admin</a>
3+
</span>

‎docs/blocks/auth_super_admin_shield.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<span class="tooltip hint--top" aria-label="Super Administrator"><a href="/authorization/#super-administrator"><font color="red" size=4>:material-shield-star:</font></a></span>

‎docs/blocks/public.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<span class="tooltip hint--right" aria-label="The commands listed in this section do not have any access restriction.">
2+
<a href="/authorization/#none"><font color="green" size=4>:material-shield-check:</font>Public</a>
3+
</span>

‎docs/blocks/public_shield.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<span class="tooltip hint--top" aria-label="Public"><a href="/authorization/#none"><font color="green" size=4>:material-shield-check:</font></a></span>

‎docs/command_list.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Command List
2+
| Command | Arguments | Authorization |
3+
|--------------------------------------------------------------------|--------------------|:-------------:|
4+
| [`create project NAME`](/projects/#creating-a-new-project) | Project Name | {% include "public_shield.md" %} |
5+
| [`delete project NAME`](/projects/#deleting-a-project) | Project Name | {% include "auth_project_admin_shield.md" %} |
6+
| [`list projects`](/projects/#listing-all-projects) | | {% include "public_shield.md" %} |
7+
| [`create admin USER`](/administration/#adding-administrators) | Administrator Name | {% include "auth_project_admin_shield.md" %} |
8+
| [`delete admin USER`](/administration/#removing-administrators) | Administrator Name | {% include "auth_project_admin_shield.md" %} |
9+
| [`list admins`](/administration/#listing-administrators) | | {% include "public_shield.md" %} |
10+
| [`pun`](/eggs/#puns) | | {% include "public_shield.md" %} |
11+
| [`get status`](/eggs/#status) | | {% include "public_shield.md" %} |
12+
| [`get queue length history`](/analytics/#queue-length-history) | | {% include "public_shield.md" %} |
13+
| [`help`](/eggs/#puns) | | {% include "public_shield.md" %} |
14+
| [`set current queue to NAME`](/queues/#changing-the-current-queue) | Queue Name | {% include "public_shield.md" %} |
15+
| [`add me`](/queues/#adding-myself-into-a-queue) | | {% include "public_shield.md" %} |
16+
| [`remove me`](/queues/#remove-myself-from-a-queue) | | {% include "public_shield.md" %} |
17+
| [`add person USER`](/queues/#adding-others-to-a-queue) | Person's Username | {% include "auth_project_admin_shield.md" %} |
18+
| [`remove person USER`](/queues/#removing-others-from-a-queue) | Person's Username | {% include "auth_project_admin_shield.md" %} |
19+
| [`get queue`](/queues/#showing-the-members-in-the-queue) | | {% include "public_shield.md" %} |
20+
| [`get largest queue depth`](/queues/#getting-largest-queue-depth) | | {% include "public_shield.md" %} |
21+
| [`how long`](/queues/#getting-estimated-time-remaining-for-me) | | {% include "public_shield.md" %} |
22+
| [`create queue NAME`](/queues/#creating-a-new-queue) | Queue Name | {% include "auth_project_admin_shield.md" %} |
23+
| [`delete queue NAME`](/queues/#deleting-a-queue) | Queue Name | {% include "auth_project_admin_shield.md" %} |
24+
| [`list queues`](/queues/#listing-all-queues) | | {% include "public_shield.md" %} |
25+
| [`get registration`](/registrations/#check-registration) | | {% include "public_shield.md" %} |
26+
| [`register to project NAME`](/registrations/#changing-the-registration) | Project Name | {% include "public_shield.md" %} |

‎docs/css/hint.min.css

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/eggs.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,23 @@
22

33
## Status
44

5-
## Puns
5+
{% include "public.md" %}
6+
7+
You can get a humorous literaly status from qutex by sending the command `get status`. Qutex will respond with the message below.
8+
9+
???+ example
10+
STATUS: Thank you for asking, nobody really asks anymore. I guess I'm okay, I just have a lot going on, you know? I'm supposed to be managing all the queues for people and it's so hard because I have to be constantly paying attention to everything at all hours of the day, I get no sleep and my social life has plumetted. But I guess I'm:<br>
11+
12+
200 OK
13+
14+
## Puns
15+
16+
{% include "public.md" %}
17+
18+
You can also tell Qutex to give you a pun using the `pun` command.
19+
20+
???+ example
21+
Toasters were the first form of pop-up notifications.
22+
23+
???+ note
24+
In order to get puns, Qutex using [I can haz dad joke](https://icanhazdadjoke.com/) in the backend for a pun API.

‎docs/images/createAdmin.png

41.9 KB
Loading

‎docs/images/queueLengthHistory.png

27.3 KB
Loading

0 commit comments

Comments
 (0)