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

Add RO-Crate to guides #10796

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Add RO-Crate to guides #10796

merged 1 commit into from
Aug 29, 2024

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Aug 23, 2024

What this PR does / why we need it:

It's not easily discoverable in the guides that Dataverse supports RO-Crate because the implementation is outside the monolith.

In this pull request, near the link to the list of external metadata exporters (which is in a README in a separate repo), we highlight RO-Crate (and Croissant) so that people searching the guides for those terms can find them.

Which issue(s) this PR closes:

Special notes for your reviewer:

I'm definitely open to writing about RO-Crate somewhere in the User Guide (beyond a mention) but I couldn't find a good spot. Ideally, we'd have a specific place in the guides to link to from https://dataverse.org/software-features when we decide to call out RO-Crate support there (for every feature, we link to the guides). I'm open to suggestions!

Suggestions on how to test this:

No testing. It's just docs.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No.

Is there a release notes update needed for this change?:

Yes, included. In the release note I was a little non-specific about the various RO-Crate exporters but there are three of them:

The first two seem to work fine but I know very little about RO-Crate and can't really comment if anything isn't in line with the spec.

The last I couldn't get working, as I reported here: #10744 (comment)

Additional documentation:

None.

(Also add Croissant)
@pdurbin pdurbin added Size: 0.5 A percentage of a sprint. 0.35 hours GREI 6 Connect Digital Objects GREI 3 Search and Browse FY25 Sprint 3 FY25 Sprint 3 FY25 Sprint 4 FY25 Sprint 4 labels Aug 23, 2024
@cmbz cmbz added the FY25 Sprint 5 FY25 sprint 5 label Aug 28, 2024
Copy link
Member

@qqmyers qqmyers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I assume that as doc only, this can just get merged? (I did check that read the docs shows them formatted OK).

@pdurbin
Copy link
Member Author

pdurbin commented Aug 28, 2024

Yeah, docs get a fast track but up to you. Mostly I'm just trying to let people know about these exporters.

@qqmyers qqmyers merged commit da79401 into develop Aug 29, 2024
2 of 3 checks passed
@DieuwertjeBloemen
Copy link
Contributor

DieuwertjeBloemen commented Aug 30, 2024

Hi Phil,

I saw the PR and your comment about not knowing how to explain the difference between the RO-Crate exporters, so below I’ll give it a shot:

- Basic RO-Crate (via Transformer) - https://github.com/gdcc/exporter-transformer/tree/1.0.9/examples/basic-ro-crate: Creates an RO-Crate metdata export based on the already available Schema.org JSON-LD..
- ARP RO-Crate (via Transformer) - https://github.com/gdcc/exporter-transformer/tree/1.0.9/examples/arp-ro-crate: Creates an RO-Crate metadata export using internal & Dataverse-specific references. This exporter is in large part not schema.org compliant.
- RO-Crate (from KU Leuven) - https://github.com/gdcc/exporter-ro-crate: Creates an RO-Crate based on the already available Schema.org JSON-LD and allows for expansion using a configurable csv to add or adapt the metadata fields as is possible in the Dataverse metadata model tsv.

I would actually be tempted to only provide the third one as a standard RO-Crate exporter, as the others are based on the transformer, which might be mentioned as its own thing that can be used to more easily create future exporters with as use cases/examples the ARP and Basic one. I would also rename the last one to “RO-Crate (adaptable)”.
So, perhaps write it out as the following, or something in that vein:

An adaptable RO-Crate exporter that creates an RO-Crate based on the already available Schema.org JSON-LD and allows for expansion using a configurable csv is available. The CSV enables addition and adaptation of metadata fields as is possible in the Dataverse metadata model tsv. This exporter was made with the support of FAIR-IMPACT. - https://github.com/gdcc/exporter-ro-crate

Due to RO-Crate being relatively flexible in implementation, two other RO-Crate exporters are also available using the general exporter transformer (link to how this can be reused):

- Basic RO-Crate (via Transformer) - https://github.com/gdcc/exporter-transformer/tree/1.0.9/examples/basic-ro-crate: Creates an RO-Crate metdata export based on the already available Schema.org JSON-LD.
- Internal reference RO-Crate (via Transformer) - https://github.com/gdcc/exporter-transformer/tree/1.0.9/examples/arp-ro-crate: Creates an RO-Crate metadata export using internal & Dataverse-specific references. This exporter is in large part not schema.org compliant, but can be useful for Dataverse internal migrations.

And the work is being done by @okaradeniz to get the CSV one to work.

@pdurbin pdurbin added this to the 6.4 milestone Sep 3, 2024
@pdurbin pdurbin deleted the 10744-ro-crate-docs branch September 3, 2024 20:29
@pdurbin
Copy link
Member Author

pdurbin commented Sep 4, 2024

@DieuwertjeBloemen thanks for all your thoughts on this. I like what you wrote, but where to put it? If you look at the files changed for this pull request, you can see that I'm really just suggesting that people learn more about these exporters over at https://github.com/gdcc/dataverse-exporters but the problem in that repo is that these long-ish descriptions don't fix so well in the table in the README:

Screenshot 2024-09-04 at 2 54 46 PM

Perhaps instead of a table, we should have something else so that descriptions can be as long as necessary? (Perhaps every exporter should get a subheading.) Whatever we do, we should probably talk about it over in an issue at https://github.com/gdcc/dataverse-exporters/issues (please feel free to create one) or maybe in #docs in Zulip. @poikilotherm is the one who created the inventory table over there so we should get his thoughts. As I've said elsewhere, I'm also open to having the inventory in the guides themselves.

@DieuwertjeBloemen
Copy link
Contributor

Yeah, I guess it makes sense to add it somewhere over there, though it's not gonna fit in the overview table. I also get why a table might be nice to use to keep it clean and to the point. We could refer to the others in the RO-Crate one's page (https://github.com/gdcc/exporter-ro-crate). Though that might hide them a bit too much and make it so the table no longer has an overview of all available exporters...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: User Guide FY25 Sprint 3 FY25 Sprint 3 FY25 Sprint 4 FY25 Sprint 4 FY25 Sprint 5 FY25 sprint 5 GREI 3 Search and Browse GREI 6 Connect Digital Objects Size: 0.5 A percentage of a sprint. 0.35 hours
Projects
Status: Done 🧹
Development

Successfully merging this pull request may close these issues.

Test and describe RO-Crate support in Guides
4 participants