[Qgis-psc] Processing Help, what next?

[matteo]

Hi PSC,

I'm forwarding a crucial IMHO mail sent to the dev list.

I think this point is crucial for the next QGIS release and not loose
the big effort made till now.

Just to give an example, there are already 4 (or 5?) new algorithms for
QGIS 3.2 that have not a description. The system is ready and it works
fine, so I'll suggest to use all we have to maintain the documentation.

as I say in the mail, I'm available to take part in this effort

Cheers

Matteo


-------- Forwarded Message --------
Subject: Processing Help, what next?
Date: Mon, 5 Mar 2018 09:09:54 +0100
From: matteo <matteo.ghetta at faunalia.eu>
To: qgis-developer <qgis-developer at lists.osgeo.org>

Hi all,

as you know, after big efforts from lots of people (both devs and doc
writers/reviewers) QGIS Processing algorithms have been well documented
on the website and they are available with the Help button of the dialog.

https://docs.qgis.org/3.0/en/docs/user_manual/processing_algs/qgis/index.html

IMHO we have to set up some points to not loose this work for all the
future development, next a list of ideas/wishes/..:

* [doc side] open an issue with the label "Processing Help" when
something changes for a Processing alg, or if a new algorithm is
created/removed
* [doc side] assign this issue to someone (I'm available to handle this)
* [doc side] I'm going to add a more specific section of the
Documentation Guidelines for Processing Docs
* with many people I've spoken, the current layout of the docs is
"ugly": lot of white space through the sections, changing some colors?..
some suggestions are more than welcome
* currently, clicking on the Help button points to the correct algorithm
because I've manually added the sphinx anchor = algorithm unique name.
So it is **mandatory** to have information (or better an automatic
mechanism?!) that writes the correct anchor in sphinx if the name changes
* other ideas?

Thanks to all the people that worked on that, I think that having a
documentation bucket is really a good news for users!

Cheers and thanks for any feedback

Matteo