I recently had some trouble running Webby to update the manual. Since we 
started using Webby to generate the manual, GitHub has released the GitHub 
Pages facility:

        http://pages.github.com/

This allows you to create a branch called gh-pages in a repository, then use 
Jekyll (similar in many ways to Webby, but a bit more flexible) to generate 
HTML pages from textile files and HTML layout files. The source for these files 
is here:

        http://github.com/bsag/tracks/tree/gh-pages/

When you push the branch up to GitHub, the HTML (basically, the contents of 
_site) gets automatically published here:

        http://bsag.github.com/tracks/

It was quite easy to convert the exiting manual to this format, and it's 
certainly much easier to administer, because I don't have to deploy it 
manually. What do people think?

I can link to this page from the main Tracks site, and since the PDF version of 
the manual (generated by PrinceXML as before, but I've included a handy rake 
file to do this) is on GitHub, we can also host the file there which saves the 
rather convoluted arrangement we had before.

If people like this arrangement, I'll delete the old tracks_manual repository, 
point the Manual link on getontracks.org to github and remove the linked manual 
with the tracks repository.

If you'd like to try it out, look at the GitHub pages page (linked above) for 
instructions on how to fetch the remote gh-pages branch, then you'll need to 
install jekyll, pygments and PrinceXML if you want to also build the PDF manual.

e.g. on Mac OS X:

sudo gem install jekyll -v 0.6.0
sudo easy_install pygments

Visit http://www.princexml.com/download/ and follow instructions to install 
Prince.

cheers,

bsag


-- 
but she's a girl - the weblog of a female geek
http://www.rousette.org.uk
[email protected]



_______________________________________________
Tracks-discuss mailing list
[email protected]
http://lists.rousette.org.uk/mailman/listinfo/tracks-discuss

Reply via email to