Rsyslog Documentation Review Proposal¶
Currently the Rsyslog documentation is spread over many places. It’s not logical and well-organized as well. The objective of this proposal is to address those issues and establish a procedure for further development of the documentation.
Note
We SHOULD NOT write examples using mixed formats, RainerScripts and legacy. It confused the readers. We can provide them in both formats, but should not mix them.
Compile information from current sources of information¶
Below are listed the official locations where documentation about Rsyslog can be found.
- Wiki: http://wiki.rsyslog.com/index.php/Main_Page
- Rainer’s blog: http://blog.gerhards.net/2012/10/how-to-use-rsyslogs-ruleset-and-call.html
- Issues: https://github.com/rsyslog/rsyslog
- docs: https://github.com/rsyslog/rsyslog-doc
- Forum: http://kb.monitorware.com/configuration-f36.html
- https://www.youtube.com/user/rainergerhards
Add a Cookbook Section¶
We should create some cookbooks to help people get started with Rsyslog. Some candidates to be a cookbook are below.
Add a subsection called “processing logs from”. We’d place articles that’d would help people with specific common scenarios for a specific log sender application.
Add a Reference Section¶
This section would have all the reference configuration of all possibile tags, in both formats, RainerScript and legacy.
Extra¶
Some resources worth taking a look.
Initial Summary¶
Troubleshooting
Proposed Documentation Structure¶
toctree:
new_documentation/index
See also
If you would like to contribute to these docs, but are unsure where to start, please see the rsyslog-doc project README for an overview of the process. If you would like to contribute to the main source project, please review the contribution guidelines listed in the rsyslog project README.
If you have a question about these docs or Rsyslog
in general, please
see the following resources: