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

Documentation Examples on BlogPosting and LiveBlogPosting Duplicate #2892

Closed
HughP opened this issue Jun 2, 2021 · 4 comments
Closed

Documentation Examples on BlogPosting and LiveBlogPosting Duplicate #2892

HughP opened this issue Jun 2, 2021 · 4 comments
Labels
type:cleanup + clarity Addresses wording fixes, ambiguities, confusion, bad examples etc

Comments

@HughP
Copy link

HughP commented Jun 2, 2021

Greetings,

I was using the documentation to look for examples of how to mark up BlogPosting. I notice the example provided is duplicated from LiveBlogPosting.

https://schema.org/BlogPosting
https://schema.org/LiveBlogPosting

I'm not sure, based on the examples given how these two terms (BlogPosting & LiveBlogPosting) should be differentiated in practice. It looks like maybe the BlogPosting example was mistakenly copied from LiveBlogPosting.

@danbri danbri added type:cleanup + clarity Addresses wording fixes, ambiguities, confusion, bad examples etc Queued for Editorial Work Editor needs to turn issues/PRs into final code and release notes. labels Jun 2, 2021
@danbri
Copy link
Contributor

danbri commented Jun 2, 2021

That did sound like an error - thanks for taking the time to report it. When I took the look, it seems that this is what's going on:

  • every example we have in our site (and this repo) is tagged with one or more schema.org terms that it illustrates. So in this case, the example in sdo-social-media-examples.txt has both LiveBlogPosting, BlogPosting because it shows an example of a LiveBlogPosting which includes several updates made to it, which are typed just as BlogPosting.
  • LiveBlogPosting is a subtype of BlogPosting, but the relationship isn't explained very clearly.
  • The type Blog is in 2021 more confusing, because it is increasingly common to refer to the posts on a blog (aka "weblog") as "blogs" too. Blog should have a proper definition.
  • Putting these under Article looks awkward.

We can do better. I've queued this for attention in the next release.

/cc @vholland (and #526) who led the original design.

@danbri
Copy link
Contributor

danbri commented Jul 7, 2021

I've added fixes to all the aspects I mentioned above, which should go out soon in Schema.org version 13. The only point I didn't touch is the question of modeling these as subtypes of Article. That probably deserves consideration as part of a larger cleanup of the CreativeWork hierarchy. Thanks again @HughP for taking the time to let us know this was confusing!

@github-actions
Copy link

github-actions bot commented Oct 6, 2021

This issue is being nudged due to inactivity.

@github-actions github-actions bot added the no-issue-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!). label Oct 6, 2021
@danbri
Copy link
Contributor

danbri commented Aug 9, 2022

Ok so these improvements did go out as part of version 13 release. Thanks again @HughP!

@danbri danbri closed this as completed Aug 9, 2022
@danbri danbri removed no-issue-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!). Queued for Editorial Work Editor needs to turn issues/PRs into final code and release notes. labels Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:cleanup + clarity Addresses wording fixes, ambiguities, confusion, bad examples etc
Projects
None yet
Development

No branches or pull requests

2 participants