search

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

Add an intro for the model builder #269 #273

Closed m-mohr closed 2 years ago

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 interacting 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?

soxofaan commented 2 years ago

About the current python instructions:

result.to_json()

If the user just does this directly in a jupyter cell they get something like this: Screenshot from 2022-09-01 09-24-57

Which is an escaped string rendering of a JSON string, and basically useless for export/import. So it's probably better to instruct the user to do 

print(result.to_json())

FYI: I recently also added cube.print_json() which is essentially the same, but that feature is not in a released version yet (will be 0.12.0 probably)

soxofaan commented 2 years ago

Another idea is to replace the textual explanation with a GIF or video, where you see collections/processes being dragged

m-mohr commented 2 years ago

Good point, I'll update the code for Python. (And then I'm thinking that an export_json() method could make sense that stores it in a temp folder and either downloads it in Jupyter or shows the Path in a Python instance.)

I'm not sure about the GIF. The drag&drop is probably the easiest task and you can't show e.g. the Copy/Paste behavior. Also, if you start to customize the style of your Editor, the GIF may not fit into the style. I think I'd prefer the textual description. We could add a video on YouTube and link to it specifically for the Platform Editor though.

soxofaan commented 2 years ago

Screenshot from 2022-09-01 12-23-13

m-mohr commented 2 years ago
  • I don't see that first clipboard button in the button toolbar, so that is confusing in this context

Yes, it's not there. The button is a compromise because CTRL+V only works once the intro is gone. But I could likely also add the button to the toolbar.

  • what is STRG? you mean CTRL or something alike

Yeah, so in German it's STRG and in other languages it seems to be CTRL or something else. So I assume I should remove these and just say "paste shortcut" or change depending on the language?!

dthiex commented 2 years ago

Yeah, so in German it's STRG and in other languages it seems to be CTRL or something else. So I assume I should remove these and just say "paste shortcut" or change depending on the language?!

I would not change this depending on the language but simply use "CTRL". The instruction is in English so I find it okay to use the English keyboard names.

Otherwise I went through the updated instruction. I think they are clear (I could easily follow them and they work) and a good addition.

I'm not sure about the GIF. The drag&drop is probably the easiest task and you can't show e.g. the Copy/Paste behavior. Also, if you start to customize the style of your Editor, the GIF may not fit into the style. I think I'd prefer the textual description. We could add a video on YouTube and link to it specifically for the Platform Editor though.

I would also leave a written description for now, as it's less work to keep them up to date.