As an User I want to have a user documentation, so I can easily learn how to use Pipeline

[pvdissel]

As an User
I want to have a user documentation
so I can easily learn how to use Pipeline

Acceptance criteria

• Easily editable format, preferably in markdown or a-like format
• Current functionality is documented, atleast in minimal form
• Documentation can be published to a static website
• Documentation can be viewed directly from github through the magic build-in markdown/.. viewer of github

Possible implementation

• Geb and Ratpack use the gradle markdown2book plugin for generating documentation from markdown files to HTML, you can find its usage on https://github.com/geb/geb/tree/master/doc/manual
• Spock framework used Sphinx docs, http://sphinx-doc.org
• Jodd uses kramdown and a homebrewed Java app to generate its site
• http://asciidoc.org also looks interesting