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:

1. Complete v5-stable documentation
2. Merge v5-stable into v7-stable branch
3. Update v7-stable branch with all new documentation and materials specific for that version
4. 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

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

###Generate HTML Documentation on Windows

1. Download the pip installer from here: https://raw.github.com/pypa/pip/master/contrib/get-pip.py
2. Download and install Git for windows if you don’t already have Git:
3. https://code.google.com/p/msysgit/downloads/list?can=3&q=full+installer+official+git&colspec=Filename+Summary+Uploaded+ReleaseDate+Size+DownloadCount
4. Install Git for Windows.
5. Run: c:\python27\python get-pip.py
6. Run: c:\python27\scripts\pip install sphinx
7. Checkout Branch in Repo –
8. Run: git clone https://github.com/rsyslog/rsyslog-doc.git
9. Run: cd rsyslog-doc
10. Run: git checkout v5-stable
11. Run: c:\python27\scripts\sphinx-build -b html source build
12. open rsyslog-doc/build/index.html in a browser