This document contains instructions for maintaining the site.
The site uses GitHub Pages with a slightly customized version of GitHub's "slate" theme.
Running and previewing the site locally requires installing Jekyll (a command-line tool), which in turn requires having Ruby.
Install a current version of Ruby. As of August 2017, the latest stable version was 2.4.1.
We recommend using rvm to install and manage the versions of Ruby installed on your machine.
You can check what version of Ruby you are currently using by running:
$ ruby --version
With rvm, you can list all of your installed Ruby versions with:
$ rvm list
From the repository root--
$ bundle install
The command above installs each of the needed Ruby gems (project
dependencies), using the version numbers specified in Gemfile.lock.
To clone a copy of the repository:
$ git clone git@github.com:OSVTAC/OSVTAC.github.io.git
$ git submodule update --init --recursive
The git submodule command is needed because the site uses Git
submodules to include things like binary files (e.g. PDF's)
and the committee's approved project recommendations, which live in a
separate repository.
To run and preview the site locally, run the following from the repo root:
$ bundle exec jekyll serve
This writes the generated pages to a subdirectory called _site.
Then browse to: http://127.0.0.1:4000.
Pushing new commits to the master branch will automatically update the rendered page on GitHub pages.
You can see whether this was successful by looking for a green check mark next to the commit in GitHub's commit history UI.