These documentation pages are stored under version control alongside the source code for the project. We take advantage of github pages so that when we push changes to the github repository, the documentation gets automatically updated.
This gives us the advantage of ensuring that the documentation in the source code and what’s available online is in sync. Also, since these pages are for developers why not use the same tool (version control) for collaboration? So, the steps for contributing changes is very similar to those described in the ‘how to contribute’ document.
If you already have the openaustralia repository checkout out, skip to the next step. Otherwise:
$ git clone git://github.com/openaustralia/openaustralia.git $ cd openaustralia
Now, you have the master branch checked out. You want to check out (and track) the gh-pages branch where the documentation lives
$ git checkout --track -b gh-pages origin/gh-pages
The main files to edit are
*.textile which are all in Textile markup. When edited, committed and pushed back to your github fork of the openaustralia repository, the Textile is converted to html and combined with the layouts to produce static html which is then served at http://your_name.github.com/openaustralia/
For more information on how this magic works see the pages documentation.
http://software.openaustralia.org redirects to http://openaustralia.github.com/openaustralia so to get your changes merged into the “official” documentation make a pull request on github to openaustralia.