VinylDNS documentation site

https://www.vinyldns.io/

Publication

The VinylDNS documentation is published to the gh-pages branch after each successful master branch build. This is configured through Travis CI.

Documentation Structure

• The documentation site is built with the sbt-microsites plugin.
• The docs module contains most content for the documentation site:
  • The text content is in the tut directory
  • The primary menu is built through setting a position value in the linked file (example) or in build.sbt if the target link is not a file in the docs module.
  • The sidebar menu is maintained in the menu.yml
  • Images are stored in the img directory.
  • Custom CSS is stored in the custom.css file.
• The Contributing Guide is the CONTRIBUTING.md file at the root of the VinylDNS project.
• The sbt-microsite configuration is in the docSettings section of the build.sbt in the root of the VinylDNS project.

Build Locally

In the terminal enter:

1. sbt
2. project docs
3. makeMicrosite

In a separate tab enter:

1. cd modules/docs/target/site
2. jekyll serve
3. View in the browser at http://localhost:4000/

Tips:

• If you make any changes to the documentation you'll need to run makeMicrosite again. You don't need to restart Jekyll.
• If you only need to build the microsite once you can run sbt ";project docs ;makeMicrosite" then follow the jekyll steps from the same tab.
• If you delete files you may need to stop Jekyll and delete the target directory before running makeMicrosite again to see the site as expected locally.