Kubrick Documentation Scaffolding

This charm template scaffolding is a tribute to film director, screenwriter, producer, editor, and cinematographer Stanley Kubrick. You might be asking what's the correlation? You wont find it. I just enjoy his work and wanted to attribute something to his name.

Why?

Juju Charms are full-fledged software projects, leaving them at just a README file really seemed wrong to me. I wanted a quick way to generate documentation about a charm in lock-step verions with my code. A really quick way to do this would be to embed the documentation in the charm (or in a branch in the charm) and keep that in sync with the charm code. As revisions are tagged - tag the documentation as a complimentary tag and you're cooking with gas without breaking your workflow. Jekyll makes this super simple, and kind of fun!

Getting Started

Check out the Documentation Site that this code-base empowers!

Features

• Easily edit in markdown without breaking your workflow
• Host your docs in the same repository as your code! Easy versioning!
• Focus on content and not your layout
• Quickly link users to documentation topics with Github Style header links
• Gain insights into focus areas of your users by using Google Analytics
• Host on Github for zero hassle, zero deploy - just git push!