Error Prone Support website
This directory contains the majority of the source code that powers error-prone.picnic.tech. The website is statically generated using Jekyll.
Local development
To view the website on localhost, first follow the Jekyll installation
instructions. Once done, in this directory execute:
bundle install
../generate-docs.sh && bundle exec jekyll serve --livereload
The website will now be available on port 4000. Source
code modifications will automatically be reflected. (An exception is
_config.yml: changes to this file require a server restart.) Subsequent
server restarts do not require running bundle install, unless Gemfile has
been updated in the interim.
Documentation can be regenerated whist jekyll is running, by executing:
../generate-docs.sh
If you are not familiar with Jekyll, be sure to check out its documentation. It is recommended to follow the provided step-by-step tutorial.
Deployment
The website is regenerated and deployed using the
deploy-website.yaml GitHub
Actions workflow any time a change is merged to master.