Documentation Process for next release

The general process pgRouting used for documentation for the "next" release of pg routing:

1. Transifex has the current release of the documentation.

• The "Current Release Documentation" remain on Transifex until the new release candidate is ready.

2. Developers work on the documentation for the next release:

• A Developer will create documentation of a "new function" using ReStructuredText

• A Developer will modify documentation of a "modified function" using ReStructuredText

• A English reviewer will modify documentation for typos or grammar using ReStructuredText

• The developer use ReStructuredText syntax to write the documentation.

• That documentation is then used with Sphinx to generate the html, man, pdf,

• Also using Sphinx-intl the *.pot files are generated.

• Those *.pot files are used by Transifex and they contain only the strings that need to be translated.

• Translator works with those strings using the process bellow.

• When the translator finishes a language, the git hub mantainers proceed to download the generated *.po files that contain the translated strings and commit them in git hub and update the documentation page.

• Users can create their translation using:

  tools/transifex/create_translation.sh jp

Translations to japanese are going to be used as examples along this wiki, I decided on japanese because that way you can focus on what is being translated and what is not.

The Translators Process

• Tools for the Translator
• [Before you start] (Translation Before you start)
• [Working with small strings](Translations Working with small strings)
• [Check your work](Translation Check your work)
• [Which file is next?] (Translations Which file is next?)
• [Troubleshooting](Translation troubleshooting)

Links

• pgRouting Wiki