Schema.org rendering of template

[njall]

Hi,

I thought it might be a good idea to help the discoverability of training materials by having more metadata examples in the markdown, and by rendering the metadata into a schema.org CreativeWork specification using the JSON-LD representation.

If you think it's a good idea and accept the request, I can go about updating the existing Data Carpentry materials and format them similarly.

Structuring metadata using Schema.org is very useful for SEO to get included in more Google SERPs; as well as for content integration platforms like TeSS - The Life Science Training Portal. There's more about it on the working group page for BioSchemas

[hlapp]

👍 on the Schema.org-based metadata.

Note that you have some seemingly unrelated changes in 00-lesson-00-name.md in the pull request. Did you mean to include them?

[njall]

I accidentally changed the indentation of those comments/divs - It was sunny and I was anxious to go outside, sorry :) Do you want me to put them back? They're about inline anyway

[hlapp]

@njall I wasn't referring to the indentation changes. I was referring to the changes to the YAML front matter of 00-lesson-00-name.md.

[njall]

Ah right, the variables declared in the .md file are the attributes of the CreativeWork type. They are declared there and then rendered in JSON-LD in lesson.html. They need to be declared there for ease of use and so that the metadata 'stays with' the lesson in the .md file.

I've added a few example attributes but these variables could theoretically be the whole of http://schema.org/CreativeWork

[hlapp]

Thanks for the explanation, @njall! Seems ready to merge from my end, but I'll leave that to @tracykteal or @ErinBecker 😄

[njall]

Great :) I've added a few more metadata attributes - the ones that correlate to what TeSS uses to describe training materials e.g. https://tess.elixir-uk.org/materials/data-carpentry-spreadsheets-for-ecology

[tracykteal]

Thanks @njall, discoverability is definitely important, and this is a great contribution.

[tracykteal]

Looks good to me. If @njall you're happy with the current status, I'll merge.

[njall]

Yep :) All good. Thanks!