Hackweek Website Template

THIS IS A TEMPLATE REPOSITORY designed to streamline creating two linked websites for a UW eScience Hackweek:

An event landing page built on a Tech Conference Theme
A JupyterBook for event content (including tutorials)

We've found that every hackweek benefits from a single-page website to get people's attention and consolidate important logistical details such as the 'who','what','why','when' of an event. In addition, JupyterBook provides a convenient means to consolidate and present tutorials with dynamic content such as executable code and dynamic figures.

Examples

We've used this template for the following events:

ICESat-2 Hackweek 2022 + 2023: https://icesat-2.hackweek.io
SnowEx Hackweeks (2021, 2022): https://snowex.hackweek.io

How to use this template

You can use this template for your own event!

Click the "Use this template" button at the top of the repo
Select the account where you'd like to use the template.
In your new repo, got to Settings --> Pages --> Source = GitHub Actions
1. Enter a Custom Domain if you have one, or use the default GitHub Pages URL
There are a few files you'll need to edit to customize content for your event:
- cookiecutter.yaml: customize your landing page content
- book/_config.yml: customize your JupyterBook content
- README.md: a basic description of your project
- CITATION.cff: add a standard citation file with all the event organizers

Design

We've designed this template so that you should only have to edit a few files with intuitive syntax. When changes are pushed to GitHub, continuous integration takes care of converting these files into HTML and publishing the website.

Additional options to consider

ReviewNB is a great tool for viewing changes in Jupyter Notebooks. Someone with admin privileges must activate it for each repository you create from this template. To activate:

Go to reviewnb.com.
Select the "Connect to GitHub" button.
Select "+/- REPOSITORIES" from the menu or bottom of the page.
Choose the organization where your repo lives.
Toggle the "Only select repositories" button and choose your repo from the dropdown.
Select "Install".

Great! Now ReviewNB will post a rich-diff of your notebooks each time a PR is opened.

How to contribute

We are always trying to improve upon this template for future events and welcome contributions. Have a look at our code of conduct and contributing guide.