Closed christian-rli closed 2 years ago
I think this is already worked on in https://github.com/OpenEnergyPlatform/oeplatform/pull/630 . At least the tutorial naming. @TuPhanRLI If you have time atm could you try to run this branch on your machine? Then we can decide if this will solve part of the Issue or not.
The name of a tutorial displayed in the list on the OEP is taken from the 1st heading in the respective jupyter notebook.
Edit: I noticed there is another constraint to the title selection. If the first heading is "Open Energy Platform" then it is skipped and the second heading is selected.
This will be fixed with the new naming scheme that uses a json file to define the tutorials to be listed on the OEP. @jh-RLI introduced the new naming scheme in https://github.com/OpenEnergyPlatform/tutorial/pull/127 . If all goes well, only well named and relevant tutorials show up after the new release.
Currently it seems like only tutorials from this directory are linked on the OEP tutorials page. There are several issues with that. The naming often isn't ideal and the name is the only indicator for the content. There should be a descriptive name for all available tutorials.
Originally an overview table was planned that also categorizes tutorials into video / text / jupyter. Is this still under development @johannwagner or has it dropped off the list of things that were worked on at some point? In future there should probably be a short description visible for every tutorial, visible before going there, too.