7.10. Hosting The Documentation On readthedocs.org

You will want to make your templates and documentation available in a localization tarball for sites to install. However, Bugzilla's main documentation site is readthedocs.org. If you put your localized documentation up on that site, then it can be linked in with the main Bugzilla docs and appear as an alternative version.

To do this, you need to have a DVCS repository of your files accessible from the Internet. ReadTheDocs.org currently supports Mercurial, Git, Subversion and Bazaar repositories, but if you are working in a clone of the main Bugzilla repo, you will be using Git. You can create your repository on sites such as Github or sourceforge.net. It is both easiest and best if you publish your entire code tree, including the Bugzilla source code, as some of it is needed to compile the docs.

You should localize on the branch or head named after the major number of the release, for instance '5.0'. If you are making your own repo rather than cloning the Bugzilla one, you should name your branches in this way also.

Then, get on the readthedocs.org site and create an account by clicking on the button Sign up. Fill up the form and click on the Sign Up » button:

../_images/RTD1.png

Sign Up Form

On the page that appears, click on the Import a Project button:

../_images/RTD2.png

Ready to share your documentation

Then, either connect to your GitHub account or click on the Manually Import Project button. The manual way will be explained below.

../_images/RTD3.png

Import a Project

You should now name your project, following the naming rule bugzilla-ab-CD --where ab-CD is your locale code--, specify the URL for your repository and its type, and tick the Edit advanced project options: square. Click then on the Next button:

../_images/RTD4.png

Project Details

Fill now the new form, especially the Description, Documentation and Language fields. The other fields can be ignored and modified later if necessary. Then, click on the Finish button:

../_images/RTD5.png

Project Extra Details

Now, click on the Versions button in the navigation header and in the Inactive Versions section, choose the version you want to activate by clicking on the Edit button:

../_images/RTD6.png

Versions

../_images/RTD7.png

Inactive versions

Tick the Active: square and click on the Save button:

../_images/RTD8.png

Editing Version

Now, click on the Overview button in the navigation header. The version you have just made active should appear there. In the Build a version dropdown list, select the version you want to compile and click on the Build button to compile your localized documentation:

../_images/RTD9.png

Overview

../_images/RTD10.png

Compilation Results

If the result is Passed, your documentation has been successfully compiled. If the result is Failed, click on the link to see what went wrong and fix it.

Finally, you should inform the Bugzilla Project that the documentation is ready in your language by sending a mail to the mailing-list developers AT bugzilla.org giving your project name, that is bugzilla-ab-CD. They can then link your docs into the main Bugzilla docs so that they show up as an alternative language.