Merge pull request #19 from mmcinnestaylor/main

Documentation updates

Author: mmcinnestaylor

docs/_config.yml

@@ -10,7 +10,7 @@ favicon_ico: "/assets/images/favicon.ico"
 
 # Enable or disable the site search
 # Supports true (default) or false
-search_enabled: false
+search_enabled: true
 search:
   # Split pages into sections that can be searched individually
   # Supports 1 - 6, default: 2
@@ -44,7 +44,7 @@ aux_links:
     - "//github.com/mmcinnestaylor/Programming-Contest-Suite"
 
 # Makes Aux links open in a new tab. Default is false
-#aux_links_new_tab: true
+aux_links_new_tab: true
 
 # Back to top link
 back_to_top: true
@@ -68,6 +68,52 @@ callouts:
     title: Warning
     color: red
 
+# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in
+mermaid:
+  # Version of mermaid library
+  # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
+  version: "11.2.0"
+  # Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js
+  # See also docs/ui-components/code
+  # To load mermaid from a local library, also use the `path` key to specify the location of the library; e.g.
+  # for (v10+):
+  # path: "/assets/js/mermaid.esm.min.mjs"
+  # for (<v10):
+  # path: "/assets/js/mermaid.min.js"
+  # Note: copy both `mermaid.esm.min.mjs` (v10+) or `mermaid.min.js` (<v10) and the associated `.map` file from the specified version of `mermaid/dist` to `/assets/js/`.
+
+# External navigation links
+nav_external_links:
+  - title: Django Documentation
+    url: https://docs.djangoproject.com/en/4.2/
+    hide_icon: false # set to true to hide the external link icon - defaults to false
+    opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false
+  - title: Celery Documentation
+    url: https://docs.celeryq.dev/en/v5.3.1/
+    hide_icon: false # set to true to hide the external link icon - defaults to false
+    opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false
+  - title: Flower Documentation
+    url: https://flower.readthedocs.io/en/latest/
+    hide_icon: false # set to true to hide the external link icon - defaults to false
+    opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false
+  - title: MariaDB Documentation
+    url: https://mariadb.com/kb/en/documentation/
+    hide_icon: false # set to true to hide the external link icon - defaults to false
+    opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false
+  - title: Redis Documentation
+    url: https://redis.io/docs/latest/get-started/
+    hide_icon: false # set to true to hide the external link icon - defaults to false
+    opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false
+  - title: RabbitMQ Documentation
+    url: https://www.rabbitmq.com/docs
+    hide_icon: false # set to true to hide the external link icon - defaults to false
+    opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false
+  - title: Docker Documentation
+    url: https://docs.docker.com/
+    hide_icon: false # set to true to hide the external link icon - defaults to false
+    opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false
+    
+
 plugins:
   - jekyll-seo-tag
   - jekyll-github-metadata

docs/about.md

@@ -0,0 +1,25 @@
+---
+title: About
+layout: about
+nav_order: 2
+---
+
+# About 
+
+The Programming Contest Suite (PCS) is a set of tools for running [ICPC](https://icpc.global) style programming contests hosted by the [Association for Computing Machinery Florida State University Student Chapter](https://fsu.acm.org) (ACM@FSU). The suite is designed to work alongside a [DOMjudge](https://www.domjudge.org/) jury system by facilitating contest registration and management, generating contestant data files required by DOMjudge, and processing contest results generated by DOMjudge.
+
+## The Contest
+
+The ACM@FSU Programming Contest is held each Spring and Fall semester at [Florida State University](https://www.fsu.edu). It routinely attracts 300-500 contestants, many of whom are FSU Computer Science students, and is actively supported by Computer Science Department faculty.
+
+## Motivation
+
+This project is the successor to [FSU-ACM/Contest-Server](https://github.com/FSU-ACM/Contest-Server), a Flask based ACM@FSU Programming Contest registration server created by [Andrew Sosa](https://github.com/andrewsosa). The PCS was intended to:
+
+1. Address the limitations of FSU-ACM/Contest-Server
+2. Enhance and ease engagement with administrators, contestants, volunteers and university faculty 
+3. Provide a codebase maintainable by student, and often newer, developers
+
+## Development
+
+The project was initially developed between early 2020 and its first live deployment for the 2021 Fall Programming Contest. It has since been under active development and maintenance, with management of the project being transferred to ACM@FSU in early 2024.