Hi all ! Following ticket #93, and after some talks with David, we could perhaps think about changing our workflow for documentation and website..
We all agree that a public wki for documentation was not really needed: users seek more doc than they contribute, and that's normal after all... Also, current workflow disconnects svn and code commits to documentation on the website. It's not very interesting for developpers, who have to commit changes at various places, and might often forgot it.. Then, current wiki is not easy to use for maintaining examples and code snipets when the syntax of the language evolves... This would need simultaneous versions of the same page, which would be a pain... And I don't mention the perl parser from wiki to latex generation :) The idea that David suggested was mimic icecast's website and documentation workflow: move everything to the svn, and have a cron script that regenerates the public website on a daily basis... Still, we might allow the use of a simple markup language. Quick search through debian packages showed for instance: > parsewiki: > Description: Documentation System Based on ASCII Text > Perl script that can be used to produce HTML, XHTML, Latex or DocBook/XML > from a simple ASCII text source document, with minimum syntax rules. Which seems to be a very good candidate for this.. If you read again the above limitations, such a workflow would be sufficient to fix them: * Maintain a very simple markup language * Commit code change and documentation at the same time * Include the documentation directly in the tarball, allowing to generate the relevant version, both online and offline.. What do you think of this ? Also, this would make it very simple to integrate with balbinus' design for a new website... Romain
