Hi all, > [1] http://www.exim.org/exim-html-current/doc/html/spec_html/ > index.html > http://www.exim.org/exim-pdf-current/doc/spec.pdf > [2] http://www.postgresql.org/docs/8.3/interactive/index.html
Both these links are made with DocBook. Best Rio. On 2008/11/26, at 21:10, Michael Biebl wrote: > 2008/11/26 Rainer Gerhards <[EMAIL PROTECTED]>: >> >> 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. > > Imho it would be very unfortunate, if the documentation would only be > available online. > > A wiki can be a very good *additional* source of documentation (for > stuff like best practices, tips and tricks), but it doesn't substitute > a well written manual. > > What I would rather like to see (and I know, I'm repeating myself > here), is to have the existing documentation a bit more structured and > easier accessible. I posted examples like the exim [1] or postgresql > [2] documentation, which I think are excellent. > > The postgresql documentation is interesting. If you follow [2] the > link, you can see, that users are able to add comments, which could be > helpful to improve the overall documentation. > There is still a "static" version though, also available as pdf, which > you could print and even use as a book. > > Cheers, > Michael > > > [1] http://www.exim.org/exim-html-current/doc/html/spec_html/ > index.html > http://www.exim.org/exim-pdf-current/doc/spec.pdf > [2] http://www.postgresql.org/docs/8.3/interactive/index.html > -- > Why is it that all of the instruments seeking intelligent life in the > universe are pointed away from Earth? > _______________________________________________ > rsyslog mailing list > http://lists.adiscon.net/mailman/listinfo/rsyslog > http://www.rsyslog.com ######################################################################## Ryo Fujita <[EMAIL PROTECTED]> Senior Solution Architect, RHCE Red Hat K.K. TEL +81-3-5798-8500 FAX +81-3-5798-8599 Ebisu Neonato 8F 4-1-18 Ebisu, Shibuya-ku, Tokyo Japan 1500013 ######################################################################## _______________________________________________ rsyslog mailing list http://lists.adiscon.net/mailman/listinfo/rsyslog http://www.rsyslog.com
