On Fri, Jun 28, 2013 at 4:31 AM, Phil Harvey <[email protected]> wrote: > My view on what-should-go-where is: > > *- Main website:* > - High-level user documentation with a marketing slant > - High-level information for Qpid developers > - Links to everything else > - "Books", provided in HTML and PDF format: complete user-facing > reference material. Generated from Docbook or Markdown content that is > versioned as part of the main codebase. > *- Wiki:* > - Authoritative developer documentation, e.g. coding standards, high > level design principles. > - Transient developer information, e.g. design proposals. Should be > obviously distinct from the aforementioned authoritative stuff. Most > designs can be agreed on the mailing list and in Jiras, but I prefer using > the wiki for occasional larger proposals so that I can include rich content > such as diagrams. > - NOT user documentation, even though it's quick and easy to add.
This seems reasonable to me. The last one I'm less ardent about. If someone wants to start developing some user documentation on the wiki, especially if it's expected to change quite a lot, it doesn't particularly bother me. > I've never understood the benefit of exporting the wiki to HTML, and to be > honest I don't understand exactly how the export works. If the motivation > is to make our users perceive wiki content as a conventional website then > this justification disappears when we take the pledge to keep user > documentation out of Confluence. I looked into this because initially I planned to put much more of the website content under the wiki. The straight wiki is a good bit slower than the exported HTML, so at one time it was important for projects that tried to use the wiki as their primary site. I'm hoping the upgraded wiki is faster in any case. Justin --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
