Updating Website Or User Manual

Some quick notes on updating website or user manual

• If you want to see website changes you make published in a timely manner, it's best to work on the latest release branch. These branches are named e.g. 0.25. The website update process will also update the ScalaDocs on the website, and it's important that those ScalaDocs show the right version. (If the website is published from the master branch, then the ScalaDocs will show a snapshot version.)
• Website source code is mostly markdown, and lives under longevity/src/main/jekyll.
• Continuously rebuild website using SBT command ~ longevity/makeSite.
• This builds site to longevity/target/site.
• I typically go to this directory and run jekyll serve. Then I can view local copy of site at localhost:4000.
  • You can just view the .html files in the longevity/target/site directory, but somehow the CSS goes missing when you do this.
  • To get jekyll on your Mac try something like: brew install ruby && gem install jekyll.
• Once your website changes are ready, commit them to the current release branch.
• To publish, run SBT command ghpagesPushSite on current release branch. (Sully will handle this step for now.)
• Merge the current release branch back to master to assure the changes survive through the next release.