convert documentation to markdown

[Oliver Kusche]

No description provided.

[Oliver Kusche]

the result should be the following folder structure:

src 
  +--- Administration_Guide
           +--- images
           +--- Administration_Guide.md
  +--- FAQ
           +--- images
           +--- FAQ.md
...

etc. for all 5 documents that are currently in

src/docbx

PDF and HTML versions of the documentation should be generated on demand by Maven using the MarkdownDoc-Maven-Plugin or the like, with the resulting PDF and HTML documents being written to the

target

folder by Maven (these will not be committed to the repository).

The Service API documentation should keep its modular structure. As there are no includes in the regular Markdown syntax, there could be two files:

#!

Service_API.md

• for viewing directly inside the BitBucket repo, contains links to the individual sections

#!

Service_API.mmd

• uses MMD transclusions of the individual sections and will be used by the maven plugin to generate a single PDF document

[Oliver Kusche]

In addition, convert the Node User Guide from

#!

src/msword

to Markdown format and place it in

#!

src/User_Guide/User_Guide.md

.

[Oliver Kusche]

As currently there seems to be no reasonable option to generate both PDF and HTML from MD sources, we stick with HTML output for now.

Options for generating HTML and PDF from MD would be:

• write a Maven plugin that utilizes Doxia to convert MD to Docbook, then use that to generate both formats like we did previously,
• extend tombensve/MarkdownDoc to support tables or
• fix Maven PDF plugin to run with Maven 3.