IQSS / IQSS/dataverse

Feature Request/Idea: Improve metadata field label tooltips that mention types of persistent IDs

Open
#9,740 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Metadata UX & UI: Design
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request
Dataverse's support for types of PIDs for datasets and files has expanded in recent years. Some metadata field tooltips mention only DOIs and Handles and should be changed.

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

What inspired the request?
Steven Ferey found duplicate information in one of the files that control things like metadata field tooltips (https://github.com/IQSS/dataverse/issues/9169), including two tooltips for the Persistent Identifier field on the advanced search page.

We talked about which one to keep, and Steven found other tooltips that mention only DOIs and Handles.

What existing behavior do you want changed?
Make sure that Dataverse doesn't let users think that PIDs for datasets and files can be only DOIs and Handles. One idea is to not mention specific types of PIDs. Another idea is to mention a more representative list of PIDs and make it clear that they are examples and not all possible types of PIDs. When these tooltips were re-written last year (https://github.com/IQSS/dataverse/issues/8127), I think the intent was to include some examples, to try to make it clearer what was meant by persistent IDs.

What brand new behavior do you want to add to Dataverse?
No new behavior, but possibly finding and adjusting tooltips.

Screenshots
The Persistent ID field and its tooltip on the Advanced Search page:
Screenshot 2023-07-27 at 9 39 23 AM

The Persistent ID field and its tooltip on the Metadata tab of a dataset page:
256243362-5f97d317-2b1b-44b4-a4c4-5ffafdf83c89

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 locating the tooltip text for the Persistent ID field on the Advanced Search page and the Metadata tab of a dataset page, then search for other tooltips that mention only DOIs and Handles. Done means the affected tooltips no longer imply that those are the only supported PID types and consistently present examples as examples.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.