Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.61 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.61 KB
Raw

ReDBox Information Website

The source code for the ReDBox public information website.

This is the staging website.

Test changes here first.

Once things lok good, copy the changes to the production website.

Overview

  • Uses Jekyll and GitHub Pages.
  • Dependabot configured to update the Gemfile, npm packages, GitHub Actions.
  • Content pages are in Markdown.
  • Most recent ReDBox release info can be generated by a script, then included where ever is needed.

Contributing

There are two options for contributing.

Option A

For simple changes - edit in the GitHub website or a local git clone and immediately deploy.

  1. Modify content that is part of the Jekyll site content.
  2. Commit and push the change to the default branch.
  3. The GitHub Actions will deploy the changes to the GitHub Pages site.

Option B

For more extensive or complicated changes - set up GitHub Pages to test changes locally.

  1. Set up rvm on your machine or in a VM or docker container.
  2. Set up the GitHub Pages gem. Use the scripts in .support to install the dependencies and build the static site.
  3. Make content or structural changes.
  4. Run the site locally to see that the changes are ok. Use the script .support/local_jekyll_server.sh.
  5. Commit and push the change to the default branch.