ResearchObject / workflow-run-crate

Workflow Run RO-Crate profile
https://www.researchobject.org/workflow-run-crate/
Apache License 2.0
8 stars 9 forks source link

Add profile draft #31

Closed simleo closed 2 years ago

simleo commented 2 years ago

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:

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.

stain commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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!