Commit Graph

8 Commits

Author SHA1 Message Date
Michael Friedrich 34bd8e14c3 Enhance the documentation and fix outdated information (preferences, etc.)
This applies a new structure for the main doc/ and modules/*/doc tree with

01-About.md
02-Installation.md
...

This allows us to link from the main doc directory into module specific
documentation entries.

Furthermore table formatting, examples, and missing settings have been added
where applicable.

This patch also takes care about proper URL anchors and file names and directories.

fixes #2950
2017-09-29 11:01:37 +02:00
Michael Friedrich 661014747d Docs: Split installation into basic; create advanced topics, upgrading, troubleshooting 2017-08-11 15:30:28 +02:00
Blerim Sheqa 75516526b5 Update docs for better compatibility with mkdocs
* Move HTML links (<a>...</a>) to the end of the header lines
  * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC
  * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-14 16:33:05 +02:00
Eric Lippmann 2d32f4a3be Fix markdown table syntax 2016-09-01 14:32:23 +02:00
Heike Jurzik cbf55ffbf1 Fix some syntax bugs in markdown files
Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2016-09-01 14:32:20 +02:00
Eric Lippmann ffd5a56ded Fix doc links 2016-04-13 13:43:39 +02:00
Michael Friedrich e298ee8e3d Docs: Fix global permission table formatting
'<' and '>' must be escaped using html-tags in tables.

refs #11568
2016-04-11 16:43:38 +02:00
Eric Lippmann fde78cdeb8 doc: Improve order of chapters
refs #9386
2016-03-30 15:40:56 +02:00