Billie,
In the Karaf world we started a wiki for that purpose also. Our experience was that folks didn't use it, preferring the documentation on the website or the mailing lists. When ServiceMix tried to move more aggressively to Wiki, James Strachan (uber committer extra-ordinaire) said the following: Finding contributions are very rare in documentation from non committers (and anyone who provides a decent amount of docs as a patch should be a committer anyway IMHO) - so the wiki isn't that big a deal really; the actual committers typically would rather be able to edit the docs using text editors (search & replace FTW!). Mike Van ASF - Committer ----- Original Message ----- From: "Billie J Rinaldi" <[email protected]> To: [email protected] Sent: Wednesday, October 26, 2011 4:00:00 PM Subject: Re: wiki & release On Wednesday, October 26, 2011 3:15:16 PM, "Jesse McConnell" <[email protected]> wrote: > Just a friendly note that in jetty we have started to look at > abandoning using the wiki in favor of a docbook approach to produce > documentation. Also it looks like the apache directory folks are > going a similar route of producing their wiki documentation through > docbook as well. Much of the maven documentation has trended the same > way, at least that produced by Sonatype. If your starting from > scratch it may be worth taking a few minutes to investigate other > options. There are also other options like markdown and some tooling > that lets you go from wiki text files into docbook and then be > transformed into xhtml, pdf, eclipse-help, and many other options all > in a maven build. We are already using markdown for our main web site, although it isn't being built with maven. We could attempt to use the main site in place of a wiki once CMS is enabled for it. The downside is that only committers would be able to edit it. It would be nice if others could contribute as well. Billie
