The up-to-date syslog-ng Administration Guide received a new look and easier navigation, as well as better search experience. Best of all, you can now also easily contribute to the syslog-ng documentation.
The problem
Up until recently, the syslog-ng open source edition (OSE) documentation was maintained together with the rest of the One Identity product documentation. This practice had some advantages, as it had the same overall look, and was maintained according to the same strict rules, as any other One Identity product. However, it also meant that the syslog-ng Administration Guide was maintained using proprietary tools, outside the reach ($$$) of the casual syslog-ng contributors, and even most of our own colleagues. Having the source code of the documentation out in the open was no real help for the community.
The solution
The syslog-ng OSE documentation source was transformed from a proprietary documentation code format to markdown. Of course, it also needs some basic formatting knowledge, but it needs a lot less effort to learn. Actually, just looking at other documentation snippets is more than sufficient to get started with markdown. Using the GitHub infrastructure to maintain the syslog-ng documentation also has some major advantages. For example, when someone submits a fix, or extends the documentation, there is no need to wait for months until it becomes available in a new release of the documentation. Once a contribution is reviewed and merged, changes appear online almost immediately.
Where?
Almost everything is available from the opening page at https://syslog-ng.github.io/
However, here are some direct links for you:
-
The syslog-ng 4.X documentation: https://syslog-ng.github.io/admin-guide/README
-
The syslog-ng documentation contributor guide: https://syslog-ng.github.io/doc-guide/README#how-to-contribute-to-the-documentation
-
The syslog-ng developer guide: https://syslog-ng.github.io/dev-guide/README (which still has some outdated parts)
-
And if you need the old syslog-ng 3.X documentation: https://www.syslog-ng.com/technical-documents/list/syslog-ng-open-source-edition/
-
If you find a problem in the documentation, you can report it at https://github.com/syslog-ng/syslog-ng.github.io/issues
-
If you have questions or comments related to syslog-ng, do not hesitate to contact us. You can reach us by email or even chat with us. For a list of possibilities, check our GitHub page under the “Community” section at https://github.com/syslog-ng/syslog-ng. On Twitter, I am available as @PCzanik, on Mastodon as @Pczanik@fosstodon.org.