Skip to content

Commit 544ab32

Browse files
mmcinnestaylormmcinnestaylor
committed
Merge branch 'additional-docs'
2 parents b9e56ef + 48d6233 commit 544ab32

File tree

5 files changed

+68
-0
lines changed

5 files changed

+68
-0
lines changed

‎README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,16 @@ There are many ways to [deploy Django](https://docs.djangoproject.com/en/4.2/how
5050

5151
Please reference `docs/docker/` for image creation and usage documentation. Pre-built images are available in the project's [Docker Hub repository](https://hub.docker.com/r/acmfsu/contestsuite). Reference `deploy/dev/docker-compose.yml` for an example deployment intended for [Docker Compose](https://docs.docker.com/compose/) and suitable for local development and testing purposes.
5252

53+
#### Default Superuser
54+
user: `contestadmin`
55+
pass: `seminoles1!`
56+
57+
A default superuser account is created when the container connects to an empty database. The default password should be changed to secure the account.
58+
59+
### Production
60+
61+
The default values of `SECRET_KEY` and `HASHID_FIELD_SALT` are not safe for production use and should be changed. Django secret key generators are readily available online.
62+
5363
### Quick-start
5464

5565
The following steps outline running the PCS outside of a Docker context. This is minimally sufficient for development or internal testing, but not for a production deployment.

‎docs/docker.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Docker Image
33
layout: default
4+
nav_order: 3
45
---
56

67
# Docker Image

‎docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ There are many ways to [deploy Django](https://docs.djangoproject.com/en/4.2/how
3030

3131
Please reference our [Docker image documentation]({{ site.url }}/docker.html) for creation and usage details. Pre-built images are available in the project's [Docker Hub repository](https://hub.docker.com/r/acmfsu/contestsuite). An example deployment intended for [Docker Compose](https://docs.docker.com/compose/) and suitable for local development and testing purposes is available in the repository's [deploy directory](https://github.com/mmcinnestaylor/Programming-Contest-Suite/tree/main/deploy/dev).
3232

33+
#### Default Superuser
34+
user: `contestadmin`
35+
pass: `seminoles1!`
36+
37+
A default superuser account is created when the container connects to an empty database. The default password should be changed to secure the account.
38+
39+
### Production
40+
41+
The default values of `SECRET_KEY` and `HASHID_FIELD_SALT` are not safe for production use and should be changed. Django secret key generators are readily available online.
42+
3343
### Quick-start
3444

3545
The following steps outline running the PCS outside of a Docker context. This is minimally sufficient for development or internal testing, but not for a production deployment.

‎docs/usage/contest_dashboard.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: default
3+
title: Contest Dashboard
4+
parent: Usage
5+
---
6+
7+
# Contest Administration
8+
9+
10+
![Contest Dashboard](https://github.com/mmcinnestaylor/Programming-Contest-Suite/blob/14a068074f95fcf0c85f0edc7171f88f5cb64f4b/docs/assets/images/admin_dashboard.png?raw=true)
11+
12+
The Contest Dashboard centralizes many of the administrator actions available in the PCS.
13+
14+
### Card Overview
15+
16+
- **Pre-Contest**
17+
- Generate and download the DOMjudge TSV files required to populate the DOMserver database with contestant data
18+
- **Post Contest**
19+
- Upload the results TSV file(s) from DOMjudge
20+
- In DOMjudge: *Administer > Import / Export > results.tsv w/ sort order 0*
21+
- **Extra Credit**
22+
- Generate and download the CSV files with contestant participation data
23+
- Notify all faculty registered with the contest that participation results are available
24+
- **Contest Tools**
25+
- Create a specified number of Upper/Lower Division walk-in teams
26+
- Check in/out all users (useful for virtual contests)
27+
- **Update User Role**
28+
- Update an account's role (Contestant, Docent, Proctor, Question Writer, Organizer)
29+
- **Account Tools**
30+
- Manually activate a user account. Useful if a registrant has issues verifying their account.
31+
- Mark a given team as a Faculty Team
32+
- **Discord Tools**
33+
- Creates the Upper/Lower Division Looking For Group roles on a Discord server
34+
- server specified by `GUILD_ID` configuration variable
35+
- Removes the Upper/Lower Division Looking For Group roles on a Discord server
36+
- server specified by `GUILD_ID` configuration variable
37+
- **Clear Discord Channel**
38+
- Clears a channel on a Discord server of all content
39+
- server specified by `GUILD_ID` configuration variable
40+
- **Volunteers**
41+
- Displays all volunteers registered in the system, whether they have registered for extra credit, and if they've checked into the contest

‎docs/usage/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
layout: default
3+
title: Usage
4+
nav_order: 4
5+
has_children: true
6+
---

0 commit comments

Comments
 (0)