Added lesson metadata and schema.org JSON-LD rendering#41
Added lesson metadata and schema.org JSON-LD rendering#41njall wants to merge 528 commits intocarpentries:gh-pagesfrom
Conversation
|
See issue #40 |
|
This looks fine to me, and I'm happy to accommodate changes to this template that match with other lessons in our organization. |
| keywords: GitHub, Forking, Collaborative # see: https://schema.org/keywords | ||
| audience: [PostDoc students, Early Career Researchers] # see: https://schema.org/audience | ||
| license: "https://creativecommons.org/licenses/by/3.0/" # see: schema.org/license | ||
| author: [Homer Simpson, Ned Flanders] # see: https://schema.org/author |
There was a problem hiding this comment.
Can author be auto-generated from the Git commits and .mailmap? (That's how we generate author lists for publication purposes.)
If _extras/figures.md exists,
$ ./bin/lesson_initialize.py
will return
Warning: _extras/figures.md already exists.
**Exiting without creating files.**
Fix bin/lesson_initialize.py
fixed broken link on landing page
Changed the keyword for emailing from 'contact' to 'email' per carpentries/styles#178 and changed the description for how to use GitHub to reflect usage of the web interface.
Reorganized description of process for contributing to clarify/increase readability
Add note about version of Jekyll needed per carpentries/styles#195 (comment).
Add HTML indenting.
Makefile: add docker-serve target
Fix typo on jekyll install
Add links.md to files in boilerplate
update URLs to reflect consolidation to carpentries organization
* Add 'cp' (Carpentry) as a lesson type (for instructor training) * Explain lesson type abbreviations (swc, dc, lc, cp) * Emphasize the fact that there is no need to edit "repository" variable in front matter
Update to styles v9.5.2
Move brand to the Carpentries
Remove section Displaying Figures
|
Could you please move your suggested changes to a different branch? It does not make sense to merge 250 commits that already exist in the base (gh-pages) branch. I guess your commit is You can also enable edits from maintainers for this PR - I will be able to help you with that then. |
@njall works with me. I'm taking over this pull request to work during this week. |
20 participants
Hi,
I thought it might be a good idea to help the discoverability of training materials by having more metadata examples in the config, and by rendering the metadata into a schema.org CreativeWork specification using the JSON-LD representation.
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
The variables declared in the _config.yml file are the attributes of the lesson correlated to the CreativeWork type. They are declared there and then rendered in JSON-LD in the schema_org.html partial in 'includes' folder. This is partial is called in _layouts/lesson.html
I've added a few example attributes but these variables could theoretically be the whole of http://schema.org/CreativeWork