Skip to content

Add vocabulary guide #461

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

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

Conversation

multimeric
Copy link
Contributor

Designed to close #444.

@stain
Copy link
Contributor

stain commented Jun 26, 2025

Thanks, @multimeric! Think we should include this, but just to improve navigation in case someone comes here before the spec, would you mind also adding links into https://www.researchobject.org/ro-crate/specification/1.2/profiles.html#extension-vocabularies and https://www.researchobject.org/ro-crate/specification/1.2/appendix/jsonld.html#adding-new-or-ad-hoc-vocabulary-terms at the first paragraphs? Considering this page will be found directly under "Resources" in menu.

I think also we can expand on how a profile should primarily try to use existing schema.org terms, for instance the Workflow Run Crate profile uses additional classes from the Action hierarchy. https://schema.org/docs/schemas.html can be used to find existing types.

@elichad
Copy link
Contributor

elichad commented Jun 26, 2025

haven't reviewed the text but adding to Stian's comment - you will also need to add the title and path to https://github.com/ResearchObject/ro-crate/blob/main/docs/_data/sidebars/resources.yml so it will show up in the Resources sidebar

@multimeric
Copy link
Contributor Author

I've linked to the spec's section on extension vocabs. I'm not sure about the "Add local definitions of ad hoc terms" section considering my page is about importing vocabularies and not defining custom terms.

I think also we can expand on how a profile should primarily try to use existing schema.org terms, for instance the Workflow Run Crate profile uses additional classes from the Action hierarchy.

I also think this is out of scope because the audience of this article is people who need more precise, domain-specific vocabulary than schema.org. This is motivated by finding OBI which does a good job of describing our research metadata. I did mention schema.org in the first sentence though.

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

Successfully merging this pull request may close these issues.

List suggested vocabularies on website
3 participants