IQSS / IQSS/dataverse

Feature Request: Add/standardize blockURIs for all community blocks to simplify migration/improve machine-readability

Open
#11,195 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Metadata Feature: Migration Size: 3 Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request As reported/documented in #11192, there are metadata blocks that don't define a blockURI (or individual URIs for all fields) which leads to Dataverse instance specific json-ld which is problematic in migrating metadata and machine-reading across instances. It would be a useful improvement to machine readability if all the community blocks had a blockURI.

There are a couple issues w.r.t. possible scope of work on this that should be decided before the issue is prioritized for development:

  • Just adding https://dataverse.org/schema/{blockname} as the citation and codemeta blocks currently do would be useful and simple (size 3, 10?)
  • Since the https://dataverse.org/schema/* URLs don't currently resolve, it would be nice if they did, i.e. if one could go to that URL to learn about the block and its fields.
    • We could change the base URL to, for example, https://schema.dataverse.org/ to facilitate this, which would mean updating the citation and codemetadata blocks as well (still size 10? just edits to a couple lines in the blocks and documentation of the (backward-incompatible) change).
    • We could create content to populate the URLs we define, hopefully automating creating from the block definition files (size tbd)
  • We could explore whether there are better block or field URIs available, e.g. whether DDI-related URIs could/should be used for the social block (size tbd)

Are you thinking about creating a pull request for this feature?
I'd be happy to make block edits and document, but wouldn't have time in the short term for larger changes

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading issue #11192 and comparing the citation and codemetadata block definitions with the other community blocks. First agree on the URI scope and base URL; done means all targeted blocks have standardized block and field URIs, with the corresponding documentation or resolvable schema content if that option is chosen.

Written by the indexing model from the issue text.

Assessment

Domain
data, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.