-
Notifications
You must be signed in to change notification settings - Fork 10
Add profile draft #31
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Would add the subfolders for versioning and them symlink to those from root. I'll sort the w3id.
Before I settle on the w3id and versioning, we need to agree on the naming.. I am thinking:
(Not yet registered! I will add to https://github.com/perma-id/w3id.org/tree/master/ro ) And them equivalent symlinks for those for current versions without I am not sure if we need What do we call the collection?Now we have:
Which sounds confusing.. what do we call that grouping in |
It think a lot of the confusion comes from the fact that sometimes we've talked about "profiles" and other times about "profile levels". We can say that there's only one profile with three levels (but I guess that does not work well with |
OK, I agree with going for the "The Workflow Run RO-Crate profile collection" and potentially separate versions if we need so later. Let's merge! |
Adds the current profile draft to the repository. Most of these contents have been previously authored by @stain and me in a Google doc, with suggestions and comments from the Workflow Run RO-Crate community. I reviewed the whole text and expanded some sections, mainly the one about the Provenance Run Crate profile.
Main changes:
name
properties from MUST to SHOULD. Names are not required for consumption and forcing their appearance might lead to made up names like "action001" or just more or less verbatim copies of the@id
.mainEntity
MUST be the workflow that's been executed, i.e., the one referenced by theCreateAction
viainstrument
. A crate whose main entity is workflow A, but describes the run of some other application B would be pretty odd and harder to consume.CreateAction
instances. I previously wrote that as a SHOULD, but without step executions it would just be a workflow run crate.A rendering of this is rooted at https://simleo.github.io/workflow-run-crate/. The top-level page for the profile is https://simleo.github.io/workflow-run-crate/profile. Note that I've changed the Jekyll theme because in the current one the rendering of tables is very confusing.