Hi all, as you probably know, I keep rsyslog's documentation in html files, with the man pages containing the bare minimum to make sense of the system. This need arises from the sheer volume of the information that must be provided.
However, this makes the documentation pretty closed (everything needs to go through me) and consequently I have seen very few doc contributions. It probably also makes it more complicated than needed to translate the documentation. Initially, I considered a purely web-based doc vs. a html-file based doc. I went for the file-based doc as this can easily be distributed together with every rsyslog version. However, looking at other projects, many have adapted a web-based approach where version differences are flagged within the documentation. The advantage of a web-based doc is that we can use thinks like a wiki to generate it. That, I think, would make it much easier for users to contribute doc or at least samples. Also, it looks like a web-based doc is also more convenient for most users. Everyone has a browser open and checks the web, but who installs doc packages? ;) So I am now consider changing to a web-based system, too. I'd probably consider the rsyslog wiki (http://wiki.rsyslog.com) a good starting point. Since I created it, it receives a slow but steady traffic increase and has now around the same number of hits than the rsyslog main site. I would move over the current file-based doc into that system and at the same time see that I can improve the structure and usability of the doc. With the many new and powerful features that appeared in rsyslog over the past couple of month, I think it is very important to make them accessible by a sufficiently good doc. The current one is, to phrase it politely, not good. It probably even hinders adoption of rsyslog in some cases. With a web-based system open to user contributions I hope to solve this issues. Please let me know your thoughts. All feedback is deeply appreciated. Many thanks, Rainer Gerhards _______________________________________________ rsyslog mailing list http://lists.adiscon.net/mailman/listinfo/rsyslog http://www.rsyslog.com
