> On 01/12/2011 02:48:29 PM, Jan Just Keijser wrote: > > >> As for the document format: if we want users to contribute then we >> should not opt for a too-difficult format that users would have to >> learn >> before being able to contribute. Docbook and/or texinfo are nice for >> Linux users but you'd scare away most Windows/Mac users. >> What about plain simple OpenDoc (odf) ? >> > > If you say so. (It's not as if they haven't seen html, > which is superficially similar to docbook/xml, > or haven't they?) But they could install and use lyx > and get a full-gui experience. They'll have to install > something anyway if they want to use odf. > > I think the most straightforward option for users would be to use the Trac Wiki: this option was discussed in the #openvpn-devel a while back. Trac is probably not the optimal tool from formatting perspective, but I'm pretty sure it's easiest method to add or change content. Users would only need to know some of Trac's wiki syntax without of having to learn things such as:
- Git/version control basics - Docbook/xml/man/roff/whatever syntax - basics of patching - how our development process works I'm pretty sure there are many who are not familiar with any of the above, but could still contribute to the documentation. We'd obviously need to make sure that the wiki pages can be exported in some useful format. Any thoughts? -- Samuli Seppänen Community Manager OpenVPN Technologies, Inc irc freenode net: mattock
