New Documentation site for Jokosher!

The Jokosher project has a development site using Trac. It’s a good setup for software developers because it combines a source code repository with a wiki, allowing code, bug-tracking and documentation all to happen in the same place. We did most of the documentation for Jokosher 0.1 there on that site.

Before the next release, though, Jono wanted to have a separate documentation site. This minimizes the number of people who need accounts and SVN access on the developer site. It also gave me the opportunity to look into a setup better tuned to documentation, rather than software development.

We settled on using MoinMoin, mostly because it supports DocBook/XML natively, is written in Python, has great theming support and seems to be actively developed. We used two wikis, one at http://doc.jokosher.org that has been themed to look almost exactly like Jokosher.org, and a second at http://userdocs.jokosher.org that looks more like a wiki.

The first site appears to the “casual observer” as just another page on jokosher.org, but it can easily be updated by me without giving me FTP access to the server. It also lets me post documentation in DocBook/XML, which we couldn’t do with WordPress.

The second site will be open to anyone who wants to edit, and will give us an easy to use place for documenters to collaborate. As new documentation is finished it can be moved to the main docs site for users to access.

Eventually this will all be integrated to look like one congruent web site, even though it’s 3 sites (jokosher.org, doc.jokosher.org and userdocs.jokosher.org) on 2 different pieces of software (WordPress and MoinMoin).

Leave a Reply