New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open

pvdissel opened this issue Aug 31, 2013 · 0 comments

Member

pvdissel commented Aug 31, 2013

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment