How do I contribute documentation to Juju?

Question

I've found some bugs in the Juju Documentation that I'd like to fix, but the docs are in some format I've not seen before, how can I contribute?

Answer 1

Branch the code:

bzr branch lp:juju/docs

Go into the docs directory and find the document you want to edit. The files are in Restructured Text format:

cd docs/source

Make your changes with your favorite text editor, then commit it to your local repository and then push it up to Launchpad.

bzr ci -m'Whatever your changelog will be'
bzr push lp:~jorge/juju/foo

Replace "~jorge" with your launchpad username and "foo" with a name that describes a fix, so something like bzr push lp:~jorge/juju/fix-typos-in-introduction or something.

Then bzr lp-propose lp:juju/docs to propose your fix. That's it!

Checking the Documentation

You can optionally check that your formatting is correct before you submit the fix to the project. Juju uses Sphinx for documentation, so you need to install it:

 sudo apt-get install python-sphinx

And then run it from the juju/docs to make sure your fixes pass:

cd juju/docs/
make html

This puts the HTML in the build/ directory where you can browse it.