Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feedback course 07: Metadata #187

Open
christian-rli opened this issue Jun 7, 2023 · 6 comments · Fixed by #198
Open

Feedback course 07: Metadata #187

christian-rli opened this issue Jun 7, 2023 · 6 comments · Fixed by #198
Assignees
Labels

Comments

@christian-rli
Copy link
Contributor

christian-rli commented Jun 7, 2023

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)

@Ludee Ludee self-assigned this Jun 13, 2023
Ludee added a commit that referenced this issue Jun 13, 2023
Ludee added a commit that referenced this issue Jun 13, 2023
christian-rli added a commit that referenced this issue Jun 13, 2023
@Ludee Ludee added help wanted Extra attention is needed documentation labels Jun 14, 2023
@Ludee Ludee linked a pull request Jun 14, 2023 that will close this issue
5 tasks
@han-f
Copy link
Contributor

han-f commented Feb 13, 2024

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.

@flohrreija-oeko
Copy link
Collaborator

The link "Validate that your metadata is a datapackage" leads to the tutorial Introduction to OpenEnergyMetadata (OEM) (see issue #225). I assume it refers to the section "Compatible with frictionless data" in this tutorial - to clarify this it could be useful to include the word frictionless in the link, e.g. "How to validate that you metadata is a datapackage compatible with frictionless data" (maybe this is not what the link referred to and I simply missunderstood it)

@flohrreija-oeko
Copy link
Collaborator

The first and third of the supplementary materials in the last section of the course are not linked - maybe because not published yet? If published already the link should be included.

@jh-RLI
Copy link
Contributor

jh-RLI commented Jul 17, 2024

The link "Validate that your metadata is a datapackage" leads to the tutorial Introduction to OpenEnergyMetadata (OEM) (see issue #225). I assume it refers to the section "Compatible with frictionless data" in this tutorial - to clarify this it could be useful to include the word frictionless in the link, e.g. "How to validate that you metadata is a datapackage compatible with frictionless data" (maybe this is not what the link referred to and I simply missunderstood it)

I agree it should link to the "frictionless datapackae" section and also include the working.

Should i update this?

@jh-RLI
Copy link
Contributor

jh-RLI commented Jul 17, 2024

The first and third of the supplementary materials in the last section of the course are not linked - maybe because not published yet? If published already the link should be included.

Are you referring to this section? The links work for me :)
image

Edit:
Ah sorry now i got it the linked documents on zenodo are not available. Hm i will ask around what happend there

Edit:
Seems like this is only a display error on zenodo?

@flohrreija-oeko
Copy link
Collaborator

The first and third of the supplementary materials in the last section of the course are not linked - maybe because not published yet? If published already the link should be included.

Are you referring to this section? The links work for me :) image

Edit: Ah sorry now i got it the linked documents on zenodo are not available. Hm i will ask around what happend there

Edit: Seems like this is only a display error on zenodo?

I missunderstood it and thought there should be 4 materials (for 4 bulletpoints) linked and that the first and third one had no link - i did not realize it was just the titles of the linked material, my mistake! I also get the display error on zenodo now but could acces the presentation 2 days ago

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants