On 2007-07-04T20:57:17, Sander van Vugt <[EMAIL PROTECTED]> wrote: Hi Sander,
wow, that's a great project! I'm very, very happy to see you take the lead on this, and you have my full support. I think the idea of gathering (tested!) example configurations, which are kept uptodate with the code changes as well, is a great plan, and we clearly have too few of those yet. In particular, we need more "building blocks" to combine - "this is how you do shared storage", "this is how you do apache", "this is how to do drbd", "this is how to combine them", "this is stonith". My main concern is that this new effort is not disjunct from the existing ones; for example the one started by Novell here: http://www.novell.com/documentation/beta/sles10/heartbeat/data/heartbeat.html or the information already in the wiki. The most important aspect we have is to build up a structure into which people can insert more information easily. The Wiki is great for the second part, but needs leadership for the first (right now, it's an unstructured mess); and then there's some "boring" work to be done to review and integrate the existing bits into the new structure. I think the Novell provided documentation, which is based on docbook xml, is probably the way to go for the reference documentation and the more stable building blocks. Manpages et cetera can be automatically be generated from that source. (I can put you in contact with our documentation folks if you want to.) We want this documentation to be open, free, and complete. (They can also help with language review etc.) I think the Wiki is a great place to complement such a structure; it can annotate improvements, host information which is still in-flux because the code is still evolving too quickly, and collect bits which haven't yet made it into the "reference". And, of course, to collect references to relevant documentation which might be hosted elsewhere, presentations et cetera. Then, there's one more task which needs to be considered - maintenance. Developers are great, but we have this frustrating tendency to forget to update the documentation when we change code. ;-) It'd be great if someone would step forward to monitor the checkins for possible documentation impact. And, if the documentation examples could be "regression tested" so they always work. Thanks for your help! Regards, Lars -- Teamlead Kernel, SuSE Labs, Research and Development SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG Nürnberg) "Experience is the name everyone gives to their mistakes." -- Oscar Wilde _______________________________________________ Linux-HA mailing list [email protected] http://lists.linux-ha.org/mailman/listinfo/linux-ha See also: http://linux-ha.org/ReportingProblems
