Skip to content

Documentation Process for next release

cvvergara edited this page Oct 17, 2013 · 21 revisions

The general process pgRouting used for documentation:

  • Transifex has the current release of the documentation.

    • The "Current Release Documentation" remain on Transifex until the new release candidate is ready.
  • Developers work on the documentation for the next release using ReStructuredText:

    • A Developer will create documentation of a "new function"
    • A Developer will modify documentation of a "modified function" maybe because of changes in the functionality
    • User's and translators findings of typos and grammar are posted on [Issue 200] (https://github.com/pgRouting/pgrouting/issues/200)
    • An English reviewer will modify documentation for typos or grammar findings.
  • Preparing Transifex and github for the "next release candidate":

    • Transifex managers download the "current release translations".
    • Update github of the "current release" (master) with the latest translation.
    • Documentation for the "next release" is uploaded into Transifex
    • Transifex managers download the "next release translations".
    • Update github of the "next release candidate" (develop?) with the latest translation.
  • Translators time for translating

  • Preparing Transifex for the "next release":

    • Transifex managers download the "next release translations".
    • Update github of the "next release candidate" (develop?) with the latest translation.
  • "New Release" is announced

    • Github managers perform the process for the release.

Links

Clone this wiki locally