Re: [QGIS-Developer] Using help button from a third-party Processing algorithm

[DelazJ]

Hi,

Nyall, the reporter is using 3.2.3 and I do not have third-party providers
installed here. So it might be fixed though regarding the issue report I
mentioned above I'm not really sure given that:
- if I understand the commit, saga is among the providers we keep showing
the help button for
- the link built (
https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/saga/rastertools.html#sagaaveragewithmask2)
by the button refers to an alg we don't have in docs (Average with mask 2 -
added to QGIS only a year ago) and more importantly, and this is what leads
to 404, a "rastertools" category we don't provide (and I can't see where
that category comes from). And we are anyway far from covering SAGA modules
(see
https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/saga/index.html
vs
https://github.com/qgis/QGIS/tree/master/python/plugins/processing/algs/saga/description
vs http://www.saga-gis.org/saga_tool_doc/2.2.4/a2z.html (latest?))

Does anything prevent us to:
1- apply the same rule to qgis and gdal providers: use our docs
2- apply same rule to grass and saga providers: use their docs
3- hide the help button for other providers and let them implement their
path?

Looks like 3 is already done but 1 and 2 need some tweaks.

Regards,
Harrissou

Le ven. 12 oct. 2018 à 22:53, Nyall Dawson  a
écrit :

> On Fri, 12 Oct 2018 at 20:23, Matteo Ghetta 
> wrote:
> > for all these 3rd part providers, we know that it is (and always will
> > be) difficult to keep the links updated to the official docs. I think
> > that, if we cannot provide this support, we should drop the Help button
> > for these providers. I know that it could sound harsh, but better than
> > opening a 404 page
> >
>
> This should have been fixed for a couple of weeks, since
> https://github.com/qgis/QGIS/pull/8014/commits/c3db16cd6
>
> Do you still see this with recent 3.3 builds?
>
> Nyall
> ___
> QGIS-Developer mailing list
> QGIS-Developer@lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Using help button from a third-party Processing algorithm

[Nyall Dawson]

On Fri, 12 Oct 2018 at 20:23, Matteo Ghetta  wrote:
> for all these 3rd part providers, we know that it is (and always will
> be) difficult to keep the links updated to the official docs. I think
> that, if we cannot provide this support, we should drop the Help button
> for these providers. I know that it could sound harsh, but better than
> opening a 404 page
>

This should have been fixed for a couple of weeks, since
https://github.com/qgis/QGIS/pull/8014/commits/c3db16cd6

Do you still see this with recent 3.3 builds?

Nyall
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Using help button from a third-party Processing algorithm

[Matteo Ghetta]

Hi Harrissou,

thanks for raining this important issue again

> * For GDAL, it brings you to the GDAL docs. I think that while
> perfectible, our GDAL alg doc is good enough to link instead, and our
> docs also propose a link to the corresponding GDAL call.

+1. I think that for GDAL the Help button should point to our doc (where
the links to the GDAL official docs are listed ). This allows us to
improve these algs with some more specific examples/pictures/etc

> * SAGA tries to open a page in our docs and returns a 404 (as reported
> in [1]). I guess this would be the case for any other third party alg
> (R, OTB, TauDem, LASTools... to name those we have docs in our repo).

for all these 3rd part providers, we know that it is (and always will
be) difficult to keep the links updated to the official docs. I think
that, if we cannot provide this support, we should drop the Help button
for these providers. I know that it could sound harsh, but better than
opening a 404 page

> IMO, and I already exposed it in the previous message (read it for
> detailed rationales), other than GDAL, pressing a help button should
> rely on the third party algs docs (ie, the way GRASS works). A check in
> the history of our doc repo proves that we do not maintain the other
> algs (reason why I'd like to remove them from our repo) and they
> actually have their proper website, better served than what we document.
> So better use it.
> 
> I don't know if this has to be done in QGIS code or in the plugin that
> links the two tools nor if QGIS proposes the necessary configs to help
> plug the other providers docs (so that we could invite the other
> projects to do the necessary changes/links). But it would be nice to get
> an official position and sort this out (both about keeping unmaintained
> docs and fixing help buttons).

A personal UI opinion: instead of opening an external browser, what
about resurrecting the old Help tab in the alg dialog?

Cheers

Matteo
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

[QGIS-Developer] Using help button from a third-party Processing algorithm

[DelazJ]

Hi devs,

I raised this issue months ago in the community list [0] from a
documentation maintainer perspective. It does not get solved. It arises
again, but from a user perspective (aka as a bug report [1]) and as this
impacts QGIS GUI, let's try to discuss and find a solution here: Have a
guideline for the behavior of help button in Processing dialogs.

Depending on the provider, the help button of an algorithm behaves
differently:

* For QGIS algs, it brings you to our docs;
* For GRASS algs, it brings you to the GRASS official docs. The issue I met
is that the docs link is not updated when the GRASS version changed (for
example, using the osgeo4w qgis-dev-g7.4.1.bat file, it should update the
settings with GRASS 7.4 paths)
* For GDAL, it brings you to the GDAL docs. I think that while perfectible,
our GDAL alg doc is good enough to link instead, and our docs also propose
a link to the corresponding GDAL call.
* SAGA tries to open a page in our docs and returns a 404 (as reported in
[1]). I guess this would be the case for any other third party alg (R, OTB,
TauDem, LASTools... to name those we have docs in our repo).

IMO, and I already exposed it in the previous message (read it for detailed
rationales), other than GDAL, pressing a help button should rely on the
third party algs docs (ie, the way GRASS works). A check in the history of
our doc repo proves that we do not maintain the other algs (reason why I'd
like to remove them from our repo) and they actually have their proper
website, better served than what we document. So better use it.

I don't know if this has to be done in QGIS code or in the plugin that
links the two tools nor if QGIS proposes the necessary configs to help plug
the other providers docs (so that we could invite the other projects to do
the necessary changes/links). But it would be nice to get an official
position and sort this out (both about keeping unmaintained docs and fixing
help buttons).

[0]
http://qgis-community-team.2324516.n4.nabble.com/Qgis-community-team-Removing-third-party-providers-algorithms-from-QGIS-Docs-td2577.html

[1] https://github.com/qgis/QGIS-Documentation/issues/3068

Greetings,
Harrissou
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer