diff --git a/README.md b/README.md index ae32e99..3045df2 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,16 @@ There are many ways to [deploy Django](https://docs.djangoproject.com/en/4.2/how 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. +#### Default Superuser +user: `contestadmin` +pass: `seminoles1!` + +A default superuser account is created when the container connects to an empty database. The default password should be changed to secure the account. + +### Production + +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. + ### Quick-start 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. diff --git a/docs/docker.md b/docs/docker.md index 327d3c0..f6d60d6 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -1,6 +1,7 @@ --- title: Docker Image layout: default +nav_order: 3 --- # Docker Image diff --git a/docs/index.md b/docs/index.md index 6a5fa87..f3bb775 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,6 +30,16 @@ There are many ways to [deploy Django](https://docs.djangoproject.com/en/4.2/how 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). +#### Default Superuser +user: `contestadmin` +pass: `seminoles1!` + +A default superuser account is created when the container connects to an empty database. The default password should be changed to secure the account. + +### Production + +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. + ### Quick-start 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. diff --git a/docs/usage/contest_dashboard.md b/docs/usage/contest_dashboard.md new file mode 100644 index 0000000..e5645fc --- /dev/null +++ b/docs/usage/contest_dashboard.md @@ -0,0 +1,41 @@ +--- +layout: default +title: Contest Dashboard +parent: Usage +--- + +# Contest Administration + + +![Contest Dashboard](https://github.com/mmcinnestaylor/Programming-Contest-Suite/blob/14a068074f95fcf0c85f0edc7171f88f5cb64f4b/docs/assets/images/admin_dashboard.png?raw=true) + +The Contest Dashboard centralizes many of the administrator actions available in the PCS. + +### Card Overview + +- **Pre-Contest** + - Generate and download the DOMjudge TSV files required to populate the DOMserver database with contestant data +- **Post Contest** + - Upload the results TSV file(s) from DOMjudge + - In DOMjudge: *Administer > Import / Export > results.tsv w/ sort order 0* +- **Extra Credit** + - Generate and download the CSV files with contestant participation data + - Notify all faculty registered with the contest that participation results are available +- **Contest Tools** + - Create a specified number of Upper/Lower Division walk-in teams + - Check in/out all users (useful for virtual contests) +- **Update User Role** + - Update an account's role (Contestant, Docent, Proctor, Question Writer, Organizer) +- **Account Tools** + - Manually activate a user account. Useful if a registrant has issues verifying their account. + - Mark a given team as a Faculty Team +- **Discord Tools** + - Creates the Upper/Lower Division Looking For Group roles on a Discord server + - server specified by `GUILD_ID` configuration variable + - Removes the Upper/Lower Division Looking For Group roles on a Discord server + - server specified by `GUILD_ID` configuration variable +- **Clear Discord Channel** + - Clears a channel on a Discord server of all content + - server specified by `GUILD_ID` configuration variable +- **Volunteers** + - Displays all volunteers registered in the system, whether they have registered for extra credit, and if they've checked into the contest diff --git a/docs/usage/index.md b/docs/usage/index.md new file mode 100644 index 0000000..c19eb45 --- /dev/null +++ b/docs/usage/index.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Usage +nav_order: 4 +has_children: true +---