Grouping of tutorials - Githubissues

OpenEnergyPlatform / academy

The Open Energy Academy is a collection of courses, tutorials, and questions for the Open Energy Family

https://openenergyplatform.github.io/academy/

GNU Affero General Public License v3.0

16 stars 6 forks source link

Grouping of tutorials #135

Closed Ludee closed 3 years ago

Ludee commented 3 years ago

Expand the json strings that contain the tutorial metainformation. Include the following keys (possible values in brackets):

language (de, en, fr)
creator (freetext) potentially copyright might be a better key name
license (CC0, AGPL)
contact (E-mail, github-handle, o.ä)
level (beginner, intermediate, expert)
medium (video, text, jupyter notebook)

This approach will work for the jupyter notebook tutorials. @jh-RLI please find out how level information is stored in the OEDB at the moment and comment in this issue. If you can, expand with the terms above in the OEDB, so we have matching sets of metainformation.

@Ludee There already is an issue for implementing the table-like design, which includes a classification for tutorials. @johannwagner you are assigned to this (https://github.com/OpenEnergyPlatform/oeplatform/issues/462 ). Is there any plan for implementation?

jh-RLI commented 3 years ago

I can add the fields to the text/markdown tutorials on OEP. There the level info is stored with the tutorial content in a table (model) and can be extended. I will start implementing the functional Django stuff and update the GitHub tutorial meta.json with the info above. Maybe @johannwagner can implement the UI design afterwards? I could do this, but it would look very basic and not like the mockup.

johannwagner commented 3 years ago

I can handle the UI design. Hit me up @ Telegram, if you finish your part.

jh-RLI commented 3 years ago

@christian-rli we still miss the category. We just have 'I/O' and 'Introduction' ATM (see in OEP-markdown tutorials). These categories could be used to group the tutorials when a User visits the tutorial area. This would extend the current mockup I believe.

jh-RLI commented 3 years ago

The categories are derived from names defined in https://github.com/OpenEnergyPlatform/oeplatform/issues/394

jh-RLI commented 3 years ago

@christian-rli I created a meta.json template/example: https://github.com/OpenEnergyPlatform/tutorial/blob/da5ecc42c5f1161353cf377c9e316e3751c5e741/template/tutorial_metadata.json#L1-L11

I will start updating all the meta.json for each tutorial.

Ludee commented 3 years ago

PLease rename "github" to "github_contact"

christian-rli commented 3 years ago

From our discussion: categories should be: "category": "General; Publication/Licensing; Upload/Download; Data Structure; Ontology; Other Topics",

jh-RLI commented 3 years ago

Included the review result :+1: See updated comment above ^

jh-RLI commented 3 years ago

We updated the meta.json and added database identifiers and readable names: https://github.com/OpenEnergyPlatform/tutorial/blob/53d9b2e35e671dd994b9e01717ad29130f82afe3/template/tutorial_metadata_template.json#L1-L23

christian-rli commented 3 years ago

@johannwagner this is the other issue i meant to link in our developer meeting yesterday. As I see it, it is basically done and is just waiting for implementation on the website. If you have any questions talk to @jh-RLI

johannwagner commented 3 years ago

@jh-RLI mentioned a mock-up, that I do not know yet. Is it uploaded somewhere?

jh-RLI commented 3 years ago

I meant the mockups in here https://github.com/OpenEnergyPlatform/oeplatform/issues/462.