search

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

Feedback course 07: Metadata #187

Open christian-rli opened 1 year ago

christian-rli commented 1 year ago

Please review course 07 : https://openenergyplatform.github.io/academy/courses/07_metadata/ and provide your feedback as comments below. Feedback can include pointing out errors (such as broken links, things that do not work as described) any suggestions for improvements, things that you are expecting from such a course but find they are missing, etc.

In your comment, please make sure to reference the link to the material you're referring to (the courses link to various materials)

han-f commented 4 months ago

I read through the course today and wonder whether you could - additionally to all the links - also provide a hands-on example for someone who has never worked with metadata and looks for how to do it right away. An idea could be to show a table with the field names of the OEMetadatastandard on the left, the description what it should hold in the middle, and an example on the right. This already exists here and it may be helpful to display this directly in the course with some context information.

For some users some more context information around these table may also be helpful, e.g. I am not sure if everyone knows without further text that under section Licence keys An array of objects of the license(s) under which the described package is provided. It can depend on the licenses of the sources (copyleft or share-alike) or can be granted by the creator of the data refers to their own published dataset. A simple inftroductory set for each section and extra info for some columns may help in such cases, for example by letting the reader know that the described package refers to the data he/she provided. . Happy to check this also together.