Tutorials for the next release #2373
Conversation
tutorials/tutorial_kml.py
Outdated
| @@ -67,6 +67,9 @@ def _load_kml_files(kml_folder_path): | |||
| select_listelement(4) | |||
| create_tutorial_images() | |||
| _load_individual_kml_file('folder.kml', kml_folder_path) | |||
| # cursor is on center of the button, moving it so it can be found on screen | |||
| pag.move(100,100) | |||
There was a problem hiding this comment.
our flake8 checker could improve
There was a problem hiding this comment.
Left some comments. Some of those can also be addressed later. It is mainly just the parentheses and the XDG_CONFIG_HOME thing that I would like to have addressed here. I am not able to check the correctness of the alt texts and that the docs actually work properly right now, I trust that you did.
docs/conf.py
Outdated
| @@ -23,11 +23,11 @@ | |||
| from string import Template | |||
|
|
|||
| def get_tutorial_images(): | |||
| TUTORIAL_URL = "https://fz-juelich.sciebo.de/s/7DUjGMgP1HFvakG/download" | |||
| TUTORIAL_DIR = 'videos/gif' | |||
| TUTORIAL_URL = ("https://fz-juelich.sciebo.de/s/KcF29hPNRzkxN6q/download") | |||
There was a problem hiding this comment.
The parentheses don't look right.
docs/tutorial.rst
Outdated
|
|
||
|
|
||
| .. video:: _static/mp4/tutorial_waypoints.mp4 | ||
| :nocontrols: |
There was a problem hiding this comment.
Does this mean that there are no controls shown to skip around in the videos? I think that would not be good (and was also not great with the gifs), being able to skip around is useful.
There was a problem hiding this comment.
I change that, the autoplay is here the more important. I want one tutorial on top of the page, showing a flightpath creation.
|
|
||
| .. video:: _static/mp4/tutorial_waypoints.mp4 | ||
| :nocontrols: | ||
| :autoplay: |
There was a problem hiding this comment.
I usually dislike autoplay, I prefer manually starting videos. As long as they don't have sound it might be fine though...
There was a problem hiding this comment.
it is the only one which gives there a little dynamic in creating a flight path. At the moment we have sound it gets disabled.
tutorials/tutorials.batch
Outdated
| @@ -13,98 +13,74 @@ | |||
| ~/bin/highlight-pointer -r 10 --key-quit q & | |||
| mkdir /tmp/msui_tutorials | |||
| export MSUI_CONFIG_PATH=/tmp/msui_tutorials | |||
| export XDG_CONFIG_PATH=/tmp/msui_tutorials | |||
There was a problem hiding this comment.
XDG_CONFIG_PATH is not used by MSS yet, AFAIK. You probably meant XDG_CACHE_HOME? I'd also prefer if this was a proper random temporary directory created with mktemp -d.
|
|
||
| ########################################################################## | ||
| # wms tutorial | ||
| $HOME/mambaforge/envs/mssdev/bin/python tutorial_wms.py | ||
| $HOME/Miniforge/envs/mssdev/bin/python tutorial_wms.py |
There was a problem hiding this comment.
This should just rely on the right python being in the PATH, instead of making so many assumptions, IMO.
There was a problem hiding this comment.
I know, step by step. This gets later worked on.
| @@ -13,98 +13,74 @@ | |||
| ~/bin/highlight-pointer -r 10 --key-quit q & | |||
There was a problem hiding this comment.
highlight-pointer should be properly installed as a dependency.
|
|
||
| $HOME/mambaforge/envs/mssdev/bin/python ../mslib/mscolab/mscolab.py start & | ||
| $HOME/Miniforge/envs/mssdev/bin/python ../mslib/mscolab/mscolab.py start & |
There was a problem hiding this comment.
My shell instincts tell me that this process will be left running after this script finished, but I would have to double check if that is true.
There was a problem hiding this comment.
yes, it needs to be killed later. That can also become improved.
|
reading and formatting the Alt Text another time. This needs a bit time, playing tutorials and looking at text .... |
|
a short peek on the autoplayed video (first seconds) tutorial_example.mp4 |
|
I guess when we understand or can solve |
Purpose of PR?:
Fixes #2372
Does this PR introduce a breaking change?
tutorials are now based on mp4 and an html5 videoplayer for sphinx.
for 8.x the gifs were in total 38.8MB, the mp4's for 9.x are smaller: 26.4MB
(the mp4's 2021 were 94.9MB)
tutorials are provided on our sciebo box for 9.x
For Alt Text the tutorial description is used. It is a description what happens in detail, taken from the tutorials.
batch and helper scripts optimized.
The conda-forge package is on the way, readthedocs needs only the pip package.
If the changes in this PR are manually verified, list down the scenarios covered::
reviewed the videos and created an issue for later #2370