[Qgis-community-team] QGIS Documentation: increase the speed of documentation writing

[Yves Jacolin]

Hello community and documentation contributors,

I would like to raise a discussion about the merge process in the QGIS
documentation.

My opinion is that the documentation process should be made easier in
order to increase the dynamic and the speed of feature documentation. I
do think we try to do our best to do some doc review, but probably not
enough and not fast enough. We should improve this and be faster in
order to be closer to the QGIS feature of the current public release,
then look at how to improve documentation later. If features are well
documented, we can probably pay for someone to proof read and fix
english issue.

In this purpose I would like to propose some keys to help merging PR and
I would like to get your opinion.

I would like to create three "levels" (a kind of guidelines) to
accept/refuse a PR, in a similar way as QGIS issues:

# Blocker (="need change" in review process)

Impossible to merge the PR because:

* Travis failed
* There is typos
* Write does not use any rst tags (:guilabel:, code-block, index, title,
etc.)

# No blocker but important (="comment" in review process)

PR can be merged but contributors can improve it before merging because:

* There is some missing rst tag
* Some sentences are not well written (I mean most of doc contributor
are not native english writer and so we are nos using the best english,
this email is a good illustration)

# Not important, just feedback (="comment" in review process)

PR can be merged, this is mainly subjective or small changes as:

* location of the contribution
* need screenshot (or update)
* fix a problem which has not been created by the PR
* Not enough description

Other contribution can create issue to not forget some of this changes
proposals.

We already agreed on the following, but better to tell it again: small
fix (add rst tag, fix typos) could be merged as soon as travis is a
success! So please, focus in small fix outside bigger PR :)

I am looking forward to read your opinion :)

Thanks to all for your great contributions!

Y.

-- 
http://yjacolin.gloobe.org


-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 473 bytes
Desc: OpenPGP digital signature
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20180918/e52d8e42/attachment.sig>