[Qgis-community-team] Manual update can officially start

Otto Dassau otto at qgis.org
Tue Jan 26 11:32:51 PST 2016


Hi Documentation team,

we can now start with the manual update in github. All documenters who sent
me a login have write access to the QGIS Documentation repo in github,
because that will speeds up the work. You can work on the manual, check
if it builds and then apply the change to the repository. 

Here is the procedure to update the QGIS manual: 

Login to github and edit manual
===============================

1) login with your github account and go to the QGIS Documentation issue
list at
https://github.com/qgis/QGIS-Documentation/issues?q=is%3Aopen+is%3Aissue+label%3A%22User+Manual%22

2) select an issue you want to work on by clicking on the issue assign
yourself. 

3) change to
https://github.com/qgis/QGIS-Documentation/tree/master/source/docs/user_manual
and search for the RST file to update/add the issue. 

4) Then save the changes by clicking on 'create a new branch for this commit
and start a pull request' 

5) Click on 'Propose file changes' , leave a comment about your change and
click on 'Create Pull request'

Check the build
===============

The Rull Request automatically starts a Travis build, where you can check,
if your changes build properly, looking at QGIS-Website build by Travis at
https://travis-ci.org/qgis/QGIS-Documentation/builds

It takes about 10 minutes before the build has finished.

After build has finished without errors go to
https://github.com/qgis/QGIS-Documentation/pulls, select your Pull Request
and click on 'Merge pull request'.

If there are errors, go back to step 3, fix your changes and so on.... and
if something doesn't work as expected or if you have questions, please write
to the list and we will try to help.

Regards,
Otto


More information about the Qgis-community-team mailing list