rsyslog-docs

Documentation for the rsyslog project

This is a work in progress. We are currently migrating over to a new document generation framework.

The process of this work will be done as follows:

Complete v5-stable documentation
Merge v5-stable into v7-stable branch
Update v7-stable branch with all new documentation and materials specific for that version
Repeat 2 and 3 merging current repo with next highest until Master is merged and updated.

Current Status -

v5-stable - (In Development)
v7-stable - (In Development)
v8-devel - (In Development)

Learning the doc tools

If you are new to rst and Sphinx, visit the Sphinx doc to get started: http://sphinx-doc.org/contents.html

Importing missing content

For the time being, occasionally a page from the v7 or v8 doc branches seems to be missing in rsyslog-doc. To recover it, check out the respective version (v8.1.6 is the latest v8 with html doc) and use this too to convert to rst:

$ pandoc -f html -t rst <html_file> -o <output_file>

Instructions

These assume default installs of Python for Windows and Linux

Generate HTML Documentation on Linux

Download the pip installer from here: https://raw.github.com/pypa/pip/master/contrib/get-pip.py
Run: python ./get-pip.py
Run: pip install sphinx
Checkout Branch in Repo –
Run: git clone https://github.com/rsyslog/rsyslog-doc.git
Run: cd rsyslog-doc
Run: git checkout v5-stable
Run: sphinx-build -b html source build
open rsyslog-doc/build/index.html in a browser

###Generate HTML Documentation on Windows