IQSS / IQSS/dataverse

Feature Request/Idea: In Dataverse Guides, indicate which metadata block properties are required and optional

Open
#8,854 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Admin Guide Feature: Metadata
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
Curator, Sysadmin

What inspired the request?
A TSV file for a new metadatablock being worked on was missing a property that was required. The property in this case was displayOrder, a property of every TSV file's datasetField section. The metadatablock can't be added to Dataverse installations without the displayOrder property being filled out.

As of v6.3, the Dataverse Guides don't indicate that the displayOrder for each field is required and the guides don't indicate which other properties need to be filled and which are optional.

What existing behavior do you want changed?
The Dataverse Guides indicate which parts of the TSV file need to be filled out and which are optional. Specifically, which parts of the three sections - metadataBlock, datasetField, and controlledVocabulary - are required or optional.

Any related open or closed issues to this feature request?
https://github.com/IQSS/dataverse/issues/7844

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 with the Dataverse Guides pages describing metadata block TSV files and compare the metadataBlock, datasetField, and controlledVocabulary sections. Identify which properties are required or optional, including displayOrder, and update the guides so the requirements are explicit. Done means all three sections clearly document their required and optional properties.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.