dellcloudedge/barclamp-crowbar — pull request #58 by cloudedge (2012-05-20 16:35:34+00:00)
Title: Integrated Documentation system for Crowbar and barclamps [1/5]

This addition (currently in DevMode only) reflects a desire to move
away from PDF based help and to something that can be tracked
and managed with the code for each barclamp itself.

This change includes some stubs for documentation in the doc directory that
need to be expanded based on the current documentation. The docs require
meta data at the top of each file to build the master index.

By default the docs are in markdown, but could be in any format
that pandoc supports (including textile). Pandoc is used to create the
small html pages that are viewed for the topics.

It is designed to be in smaller topic chunks rather than a single doc.

The basics are /docs will show (and generate) a master index with three
levels of nesting

Each topic can be viewed as /docs/topic/:id. The topics will have navigation
aids for root, parent, next, and previous.

Known Issues:
1) order is not working yet
2) apt-get install pandoc needs to be done before it works
3) MISSING CONTENT!!

crowbar.yml | 11 ++-
.../app/controllers/docs_controller.rb | 116 ++++++++++++++++++++
crowbar_framework/app/views/docs/_index.html.haml | 7 +
crowbar_framework/app/views/docs/index.html.haml | 15 +++
crowbar_framework/app/views/docs/topic.html.haml | 30 +++++
.../doc/default/==BC-MODEL==/index.md | 17 +++
crowbar_framework/config/locales/en.yml | 21 ++++-
crowbar_framework/config/navigation.rb | 9 +-
crowbar_framework/config/routes.rb | 6 +
.../doc/default/crowbar/book-barclamps.md | 22 ++++
.../doc/default/crowbar/book-deployguide.md | 14 +++
.../doc/default/crowbar/book-licenses.md | 19 +++
.../doc/default/crowbar/book-userguide.md | 16 +++
.../doc/default/crowbar/ui-general.md | 15 +++
crowbar_framework/doc/default/crowbar/ui-nodes.md | 15 +++
15 files changed, 324 insertions(+), 9 deletions(-)