#M14. Misc cleanup changes and improvements

.env_sample

@@ -2,3 +2,4 @@ DEVELOPMENT=1
 SECRET_KEY="your_secret_key_here"
 SITE_NAME="localhost"
 SLACK_ENABLED=True
+SUPPORT_EMAIL = 'support@example.com'

home/views.py

@@ -1,5 +1,6 @@
 from django.contrib import messages
 from django.core.paginator import Paginator
+from django.conf import settings
 from django.shortcuts import render, redirect, reverse
 
 from hackathon.models import Hackathon
@@ -37,8 +38,9 @@ def home(request):
 
 def faq(request):
     """ A view to return the FAQ page """
+    support_email = settings.SUPPORT_EMAIL
 
-    return render(request, "faq.html")
+    return render(request, "faq.html", {'support_email': support_email})
 
 
 def judging_criteria(request):

main/settings.py

@@ -166,3 +166,4 @@
 # Number of showcases displayed in the carousel
 SHOWCASE_SPOTLIGHT_NUMBER = int(os.environ.get('SHOWCASE_SPOTLIGHT_NUMBER')
                                 or 0)
+SUPPORT_EMAIL = os.environ.get("SUPPORT_EMAIL")

templates/faq.html

@@ -2,7 +2,137 @@
 {% load static %}
 {% block content %}
 
-<h1>FAQ</h1>
+<h1>Frequently Asked Questions</h1>
 <!-- help needed -->
+<h3>
+    1. WHAT IS A HACKATHON?
+</h3>
+<p>A hackathon (also known as a hack day, hackfest, datathon or codefest) is a
+    design sprint-like event; often, in which computer programmers and others
+    involved in software development, including UX/graphic designers, project
+    managers, subject matter experts, and others collaborate intensively on
+    software projects.
+</p>
+<p>
+    The goal of a hackathon is to create functioning software or hardware prototype
+    by the end of the event which usually lasts . Hackathons tend to have a specific
+    focus, which can include the programming language used, the operating system,
+    an application, an API, or the subject and the demographic group of the programmers.
+</p>
+<p>
+    (Wikipedia, 2021)
+</p>
+<h3 class="mt-5">
+    2. WHO SHOULD JOIN?
+</h3>
+<p>
+    Any interested student, alumni, staff or partner can join a hackathon.</p>
+<p>
+    Participating in a hackathon is a great way to learn more about how it is
+    to work in a fast paced development team. You will be using version control
+    to share code with your team members, troubleshoot code and create a project
+    towards very challenging deadlines.
+</p>
+<p>
+    We encourage participation, but would only suggest to join if you are
+    currently ahead of your schedule and do not have any project deadline
+    close to the hackathon date. 
+</p>
+<h3 class="mt-5">
+    3. WHAT DO I NEED?
+</h3>
+<ul>
+    <li>
+        A computer with a good internet connection
+    </li>
+    <li>
+        Access to the Code Institute Slack Workspace (if you cannot access the
+        workspace, please contact Student Care)
+    </li>
+    <li>
+        A Zoom account (this will be used for video conferencing during the
+        hackathon)
+    </li>
+    <li>Access to a development IDE (we recommend Gitpod.io as code can easily
+        be shared amongst the team and has great GitHub integration)
+    </li>
+    <li>
+        An open mind and willingness to learn
+    </li>
+</ul>
+<h3 class="mt-5">
+    4. HOW DO I FORM OR JOIN A TEAM AND WHY?
+</h3>
+<p>
+    You need a team to participate in a hackathon, otherwise the workload to
+    get everything done within time will be too great and more importantly you
+    will not get the wanted learning outcomes. Learning about what it means to
+    work as part of a development team is the main benefit of participating in
+    a team.
+</p>
+<p>
+    In most cases participants sign up on their own, so teams are semi-randomly
+    assigned to get an even mix of experience in each of the teams.
+</p>
+<h3 class="mt-5">
+    5. I HAVE A TEAM ALREADY, HOW CAN I MAKE SURE WE END UP TOGETHER
+</h3>
+<p>
+    If you want to join a hackathon with a preformed team, make sure that each
+    of your team members joins individually and send an email to 
+    {% if not support_email %}Student Care{% else %}
+    <a href="mailto:{{support_email}}">{{support_email}}</a>{% endif %} at
+    least a few days before the hackathon.
+</p>
+<h3 class="mt-5">
+    6. ARE THERE PRIZES FOR THE HACK CATEGORIES?
+</h3>
+<p>
+    Prizes depend on the individual hackathons and sponsorship availability.
+</p>
+<h3 class="mt-5">
+    7. WHO JUDGES THE WINNERS?
+</h3>
+<p>
+    The winning team will be decided by a jury made up of Code Institute staff
+    and depending on the hackathon industry experts and/or partners of Code
+    Institute. 
+</p>
+<h3 class="mt-5">
+    8. WHAT IS THE EVALUATION CRITERIA FOR THE SELECTION OF THE WINNING TEAM?
+</h3>
+<p>
+    The jury will analyze and evaluate all works submitted by each team
+    according to the following evaluation criteria: 
+</p>
+<ul>
+    <li>
+        Effective Use of Course Knowledge
+    </li>
+    <li>
+        Usability and Practicality
+    </li>
+    <li>
+        Team Collaboration
+    </li>
+    <li>
+        Presentation and Adherence to Theme
+    </li>
+    <li>
+        Awesomeness
+    </li>
+</ul>
+<p>
+    (this can vary depending on the hackathon, but will be visible on the
+    hackathon itself)
+</p>
+<h3 class="mt-5">
+    9. WHAT IS THE THEME FOR THE HACKATHON?
+</h3>
+<p>
+    Hackathon themes vary depending on the hackathon itself. The theme will be
+    visible on the hackathon signup page or on the hackathon page itself.
+</p>
+
 
 {% endblock %}