Open-EO / openeo-web-editor

An interactive and easy to use web-based editor for the OpenEO API.
https://editor.openeo.org
Apache License 2.0
12 stars 17 forks source link

Document better how users can import JSON from clients #269

Closed m-mohr closed 2 years ago

m-mohr commented 2 years ago

Document better how users can import JSON from clients, see feedback below:

In the editor, once you have generated a process, you can export the code in three programming languages (Javascript, Python and R), however, you cannot import processes from other languages, because it only allows you to import json files, which are javascript files, but not even the one you have exported previously.

It is actually possible to generate the JSON from the client libraries so you can go in circles here: Editor -> R -> Editor -> Python -> Editor would work. Each client can generate the corresponding JSON output so that you can import it into the Web Editor again. This doesn't work directly with the Python and R code as they don't run in the Browser so this small workaround is needed to go via JSON. See the details here: https://openeo.org/documentation/1.0/cookbook/#output-process-as-json

m-mohr commented 2 years ago

I started with an overview that users get on "startup" when the model builder is empty. Once you start intreracting with the canvas, e.g. by dragging something, it disappears.

image

What do you think? Does this help? Is this confusing? What can we improve? Do the explanations for Python/R work?

cc'ing @dthiex (due to the demo today), @soxofaan (Python client), and @flahn (R client)

m-mohr commented 2 years ago

Also add the code to the import modal.

soxofaan commented 2 years ago

I somehow missed this ticket. I'd like to point to this cookbook page from python client docs which discusses:

m-mohr commented 2 years ago

Thanks, the first link is actually already included in PR #273 :-)

The second link is a good addition although I'd hope it's not required so often as we also have the Python code export itself.