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

Added schema.org JSON-LD to lesson #226

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

rgaiacs
Copy link
Contributor

@rgaiacs rgaiacs commented Aug 2, 2018

This is a fork of #41.

@rgaiacs rgaiacs added this to the v9.5.1 milestone Aug 2, 2018
@rgaiacs rgaiacs self-assigned this Aug 2, 2018
@rgaiacs
Copy link
Contributor Author

rgaiacs commented Aug 2, 2018

@njall I moved where the JSON-LD is included. Could you check for me?

@fmichonneau fmichonneau added type:enhancement Propose enhancement to the lesson and removed enhancement labels Aug 21, 2018
"timeRequired": "{{site.data.lesson.timeRequired}}",
"learningResourceType": "{{site.data.lesson.learningResourceType}}",
"citation": "{{site.data.lesson.citation}}",
"dateCreated" : "{{site.data.lesson.dateCreated}}"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not super clear what dateCreated refers to. First commit? Last commit? Last release?

Copy link
Contributor

@mkuzak mkuzak Feb 8, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be the first commit after forking the lesson example.

Copy link
Contributor Author

@rgaiacs rgaiacs Feb 8, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not use the date from the last commit? See 40f1dfa

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last commit is not when the lesson has been created, it's when the lesson has been updated.
Why removing this field in
40f1dfa

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@njall Does schema.org have a field for date updated? If not, can we use dateCreated for it?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we have a field called dateModified that would be good for last commit.

Date Created could be the first commit after the repo was cloned.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. We can't automate dateCreated.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's ok, since it will happen once in a lifetime of the training meterial.

{% endfor %}
],
"timeRequired": "{{site.data.lesson.timeRequired}}",
"learningResourceType": "{{site.data.lesson.learningResourceType}}",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is it different from genre above ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Genre" is replaced by "About" now. LerningResourcesType, that can be video lecture, e-learning module, handout etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mkuzak @njall DoesLerningResourcesType a close list of options?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, it's an open list. More info here: https://schema.org/learningResourceType

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it's an open list for now. I have been tempted to create a vocab but making and maintaining an exhaustive list would be an overhead to big for its benefit right now.

@@ -22,7 +22,8 @@
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<title>{{ site.title }}{% if page.title %}: {{ page.title }}{% endif %}</title>
<title>{{ site.data.lesson.title }}{% if page.title %}: {{ page.title }}{% endif %}</title>
{% include schema_org.html %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does it affect the header of a lesson?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not affect the header.

"@type": "Person",
"name": "{{contributor}}"
}{% if forloop.last %}{%else%},{%endif%}
{% endfor %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Author and contributor are vague terms as lessons are being developed by the community. There is an initial author and then there is an army of contributors. Giving proper credits is important, but it should probably happen on a separate page

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The distinction between author and contributor:
Author: Preparation, creation and/or presentation of the published work, specifically writing the initial draft;
Contributor: a critical review, commentary or revision;
We need this information in metadata. We may reuse it to display on the separate page.

@maxim-belkin
Copy link
Contributor

I like the added structure this PR adds but I'm not sure about some of the categories.

Copy link
Contributor

@maxim-belkin maxim-belkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see my comments :)

@rgaiacs
Copy link
Contributor Author

rgaiacs commented Dec 20, 2018

@njall and @mkuzak I rebased this pull request. Could you answer @maxim-belkin's questions?

@rgaiacs
Copy link
Contributor Author

rgaiacs commented Feb 8, 2019

@mkuzak and @njall I will be working on this until lunch today.

@fmichonneau fmichonneau changed the base branch from gh-pages to main October 13, 2021 05:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement Propose enhancement to the lesson
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants