Comments on courses

[vismayajochem]

Description of the issue

First some general things:

• Two courses (01 & 05) don't have an introduction text with a link to a git issue to give feedback on this course. An in the ones where there is a link, the introductionary text is differently; some only give the link and others somthing like an abstract, an pverview of the content of the course. This could be made more homogenous.

• In the first course 01 - Introduction symbols for links are being introduce. But in the turorials those symbols are not used in the described way. Especially the first two get mixed up a lot. E.g. in 03 - Download - Find and download / interact with data the link to the How to find data on the OEP? (tutorial) should have the other symbol, since the tutorial has no code at all... #232

Regarding 03 - Download - Find and download / interact with data:

• The API Tutorial 01 - Download data from the Open Energy Platform using the API is link three times (the tutorial How to download data from the OEP - CSV and datapackage is linked once) while links to the OEP Client tutorials (OEP Client Tutorial 01 - Download data from the Open Energy Platform using the OEP Client in a python script and OEP Client Tutorial 03 - Download data from the Open Energy Platform using the OEP Client in the command line) are missing.

Regarding 05 - The Open Energy Ontology:

• In the last section the reader is asked to get in contact with 'us'. But no link to an e-mail-address or a contact form is given.

Regarding 09 - Open Peer Review:

• In the introduction a studies is quoted. But no link to the study is provided. (In the last section of the course some more informations on the study are given, but for a reader who reads from the beginning this is not foreseeable.)

Steps to Reproduce

Ideas of solution

Describe possible ideas for solution and evaluate advantages and disadvantages.

Context and Environment

• Version used:
• Operating system:
• Environment setup and (python) version:

Workflow checklist

• I am aware of the workflow in CONTRIBUTING.md

[han-f]

In the first course 01 - Introduction symbols for links are being introduce. But in the turorials those symbols are not used in the described way. Especially the first two get mixed up a lot. E.g. in 03 - Download - Find and download / interact with data the link to the How to find data on the OEP? (tutorial) should have the other symbol, since the tutorial has no code at all...

The first two symbols in the Introduction course were simply mixed up. I changed them. @vismayajochem, would you be able to check whether they are now consistent throughout the courses?

[han-f]

Regarding 03 - Download - Find and download / interact with data:

The API Tutorial 01 - Download data from the Open Energy Platform using the API is link three times (the tutorial How to download data from the OEP - CSV and datapackage is linked once) while links to the OEP Client tutorials (OEP Client Tutorial 01 - Download data from the Open Energy Platform using the OEP Client in a python script and OEP Client Tutorial 03 - Download data from the Open Energy Platform using the OEP Client in the command line) are missing.

I have rearranged the course and also integrated the oeclient tutorials.

[han-f]

In the last section the reader is asked to get in contact with 'us'. But no link to an e-mail-address or a contact form is given.

For now I have linked to the contact form of the OEP (FYI @stap-m).

[han-f]

In the introduction a studies is quoted. But no link to the study is provided. (In the last section of the course some more informations on the study are given, but for a reader who reads from the beginning this is not foreseeable.)

I have added a link to the study (FYI @christian-rli, @jh-RLI )

[han-f]

Two courses (01 & 05) don't have an introduction text with a link to a git issue to give feedback on this course. An in the ones where there is a link, the introductionary text is differently; some only give the link and others somthing like an abstract, an pverview of the content of the course. This could be made more homogenous.

All courses now have a link at the start of the course, except 01, as this is simply the introductory text to all courses. The links to the github issues can still be a bit harmonised, but from my point of view this is not urgent.

[stap-m]

In the last section the reader is asked to get in contact with 'us'. But no link to an e-mail-address or a contact form is given.

For now I have linked to the contact form of the OEP (FYI @stap-m).

I am fine with this. We once discussed about mentioning the oeo at info list there, but never made a final decision.

[vismayajochem]

In the first course 01 - Introduction symbols for links are being introduce. But in the turorials those symbols are not used in the described way. Especially the first two get mixed up a lot. E.g. in 03 - Download - Find and download / interact with data the link to the How to find data on the OEP? (tutorial) should have the other symbol, since the tutorial has no code at all...

The first two symbols in the Introduction course were simply mixed up. I changed them. @vismayajochem, would you be able to check whether they are now consistent throughout the courses?

I checked the courses and the usage of the symbols looks good to me now.

[flohrreija-oeko]

I would suggest to link to Course 7 "Metadata" in every section that includes down-/uploading (e.g. API tutorial 01, API tutorial 02, OEP Client tutorial 01, 02, 03, 04) for general clarity and improving the cross-understanding between courses/tutorials).

[vismayajochem]

@han-f @jh-RLI
While working on issue #242 I noticed that the 04 Upload course seems to be using 'upload' and 'publish' as synonyms. To my understanding they are not and the linked tutorials all describe only how to upload and not how to publish contrary to what the section headlines suggest.
Once the publish tutorial is written (and the old description is removed), maybe this course could include one section about the publishing process as well.

[jh-RLI]

Well spotted :) I agree, once the publishing tutorial is available, it can become part of the uploading course. We should still consider whether it makes sense to have an additional course on publishing.

Compared to uploading, publishing is a pretty quick task. But it still includes:

• a required, automatic check: if the metadata is available and contains an open license
• the option to select an embargo or remove an active embargo period
• Selection of a topic (schema) in which the table should be published (and moved to)

Some of these points require explaination on how to do it using the user interface & the HTTP-API.