History

This page describes the process to be followed when preparing a new documentation release for QGIS. The english 'master'-document is currently divided into a user_guide and a compilation-coding_guide. Important is to finish updates before the software is tagged to be able to include current documentation in qgis/doc.

Update the english 'master'-document

On the ManualTasks wiki page you should find a list of svn commit comments (changelogs) describing new features and updates that need to be added to the english 'master'-document before tagging.

Generate the changelog

  • Note revision number of previous release (i.e. 1.0) 9801
  • Revision number of current release (i.e. 1.0) 10531
  • svn log -r9801:10531 > /tmp/log.txt or more fancy svn log -r9801:10531 | grep -i '^[a-z][a-z]' | sed -e "s\^\* \1" > /tmp/log.txt
  • Another (additional) way to generate a changelog is to use trac to get a list of all closed bugs e.g. https://trac.osgeo.org/qgis/query?status=closed&milestone=Version+1.1.0&order=priority
  • create a table under ManualTasks with a cleaned up changelog version

Tagging new manual versions for release

A new version of the english user_guide/ and coding-compilation_guide/ is tagged and released together with QGIS software releases. The manual team lead should update that page reguarly and use it, when prepairing a new release. Important is also to arrange your plans with the Community Manager and the ReleaseTeam on the qgis-release-team and the qgis-community-team mailing lists.

User Guide

  • Review, if the content is uptodate and the layout of the user_guide looks nice (do images fit with the text, pagebreaks, etc.). Also compare with the changelog under ManualTasks.
  • Check title and adapt qgis_style.sty if necessary (version number)
  • Check preamble for complete list of authors
  • Test, if the latex sources in trunk compile properly.
  • Test creating PDF, PS, and HTML output for.

Tagging a new release

When you think, everything works well and the documentation is ready to release, copy the directory user_guide from trunk to tags

# Example for version 1.1 user guide
svn cp trunk/english_us/user_guide tags/1.1.0_user_guide

Prepair translation branches

After the release is tagged, create a new (yet empty) branch for translations.

# Example for version 1.1
svn make branches/1.1.0/

Webpage updates

Finally it is necessary to create a PDF output for the user_guide, copy it to the osgeo server
at http://download.osgeo.org/qgis/doc/manual/ and update the webpage links at qgis.org.

Coding and Compilation Guide

  • Update the chapter install.tex converting INSTALL.t2t from qgis sources
  • Update the chapter coding.tex converting CODING.t2t from qgis sources
  • Review, if the content is uptodate and the layout of the compilation-coding_guide looks great.
  • Check title and adapt qgis_style.sty if necessary (version number)
  • Check preamble for complete list of authors
  • Test, if the latex sources in trunk compile properly.
  • Test creating PDF, PS, and HTML output for.

Tagging a new release

When you think, everything works well and the documentation is ready to release, copy the directory coding-compilation_guide from trunk to tags

# Example for version 1.1 
svn cp trunk/english_us/coding-compilation_guide tags/1.1.0_coding-compilation_guide

Webpage updates

Finally it is necessary to create a PDF output for the compilation-coding_guide, copy it to the
osgeo server at http://download.osgeo.org/qgis/doc/manual/ and update the webpage links at qgis.org.