Skip to content

Conversation

simleo
Copy link
Collaborator

@simleo simleo commented Oct 10, 2022

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:

  • I have changed the requirement level of 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.
  • In workflow run crate, the mainEntity MUST be the workflow that's been executed, i.e., the one referenced by the CreateAction via instrument. 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.
  • Provenance run crate MUST record step executions with 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.

@simleo simleo requested a review from stain October 10, 2022 15:37
Copy link
Contributor

@stain stain left a 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.

@stain
Copy link
Contributor

stain commented Oct 13, 2022

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 0.1-draft/

I am not sure if we need https://w3id.org/ro/wfrun/0.1 as that won't be used in conformsTo (it is the grouping of the 3 profiles) but we can just include it for completeness/citation.

What do we call the collection?

Now we have:

Workflow Run Crate

  • Part of: Workflow Run RO-Crate

Which sounds confusing.. what do we call that grouping in profiles.md?

@simleo
Copy link
Collaborator Author

simleo commented Oct 13, 2022

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 conformsTo) or say that there are three separate profiles, which happen to be collected here because they are related, but their collection is not a profile itself. I went for the latter option in 044a3be. How does it look now? With this new arrangement it makes sense to get rid of https://w3id.org/ro/wfrun/0.1, as you suggested (this also allows to have different versions for the three profiles, though I'm not sure if we should do that).

@stain
Copy link
Contributor

stain commented Oct 17, 2022

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!

@stain stain merged commit 56c23e3 into ResearchObject:main Oct 17, 2022
@simleo simleo deleted the add_profile_draft branch October 17, 2022 12:28
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.

2 participants