Good morning! I'm looking forward to working with everyone on this. I would ask, if you have a documentation suggestion but don't have the time to edit the documentation yourself in rsyslog-doc, feel free to email the distro with [docs] in the subject line. That will call it out to me so I can file the email for processing.
Rainer and I have been speaking. I'll loop everyone else in. I'm currently working on cleaning up conversion errors in the existing documentation. (Thanks Mike for pointing out pandoc. Saved me a huge amount of time.) Once I finish that I'll be completing the config and theme work for Sphinx. This is required to make sure the HTML output works as expected. As part of this I'm also going to be finishing the creation of the Sphinx man page output. The goal of this is to have it result in usable man pages that are broken down enough to be easy to navigate and still functional. I may create some git branches for each of the output types so that individuals can pull then, test them and give comments on their usability. I'll keep everyone apprised. -- James ________________________________________ From: [email protected] [[email protected]] On Behalf Of Rainer Gerhards [[email protected]] Sent: Sunday, December 15, 2013 4:14 AM To: rsyslog-users Subject: [rsyslog] doc project All, David, I start a new thread because I a) think it's easier to spot what it really is about and b) I could not locate David's last message quickly enough ;) I have asked James to create an rsyslog-doc project. It's now up on github: https://github.com/rsyslog/rsyslog-doc I understand David's concerns on the doc correctness. But I admit that I would probably become a major blocker for the doc work if I would necessarily require a review each time (especially as I will be heading for vacation by the end of the week and I will most like only react to emergencies for two weeks while I am away). Also, I think that the doc is much less critical in sense of security, and even correctness. Every now and then I run over things that are incorrect in the current doc set as well (because I did it wrongly, I explained something wrongly to someone who documented it, or best practices have changed over time). The current doc is a mess, at best usuable for folks that already know what to look for. I'd assume any change is an improvement. I also trust James, who is also a long-term list member, with doing serious work on the doc -- just look at the first results. James has also accepted to act as a maintainer for the doc set, something I am extremely happy with. David, if you like and have the time, I am sure all of us would be extremely glad if you could join in into this effort (BTW: it's extremely seldom that you are not right - and sometimes you correct me when I overlooked things, so... ;)). For the time being, I will make doc updates both the the rsyslog repo as well as the rsyslog-doc one. When I am back from vacation (and hopefully the rsyslog-doc has reached a good state), I'll remove the doc from rsyslog repo and begin to use rsyslog-doc for that. I am sure we'll get into some trouble spots, but what do we have to lose? At worst, we can integrate rsyslog-doc back into rsyslog, and make me accept contributions as of now. But I think by keeping it separate, we can attrack a much bigger crowd (as it becomes easier to contribute). Comments welcome. Rainer _______________________________________________ rsyslog mailing list http://lists.adiscon.net/mailman/listinfo/rsyslog http://www.rsyslog.com/professional-services/ What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE THAT. _______________________________________________ rsyslog mailing list http://lists.adiscon.net/mailman/listinfo/rsyslog http://www.rsyslog.com/professional-services/ What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE THAT.
