-
Notifications
You must be signed in to change notification settings - Fork 17
Description
reported by @HansVRP :
when (entry level) users start playing with openEO, they often land on generic, language-agnostic process docs like https://openeo.org/documentation/1.0/processes.html but get stuck there as they can't figure out how to translate the generic information (with schema and other descriptions that are quite cryptic to them) to, e.g., Python code that works.
Including Python snippets with each process in openeo-processes or openeo.org is probably a bad idea for various reasons (scalability, maintainability, coupling, ...).
But would it be possible to provide links with each process (e.g. like there is currently that "Download JSON" button apparently) that just leads to a generic documentation search entrypoint page for each of the popular client libraries?
For example, the python client docs currently already has a basic search page where a search query (e.g. process id in this case) can be provided:
https://open-eo.github.io/openeo-python-client/search.html?q=reduce_dimension
Integration at the openeo.org side would be very easy: just add a simple link for each process.
And then further improvements to the user experience can be fully handled at the side of the client docs