IQSS / IQSS/dataverse

Improve Dataverse/Dataset Linking search error messages

Open Beginner friendly
#10,594 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Overview of the Feature Request
The current error messages for Dataverse linking search are very confusing

find.datasetlinking.error.not.found.ids=Dataset linking dataverse with dataset ID {0} and dataset linking dataverse ID {1} not found.
find.datasetlinking.error.not.found.bad.ids=Bad dataset ID number: {0} or dataset linking dataverse ID number: {1}.
find.dataverselinking.error.not.found.ids=Dataverse linking dataverse with dataverse ID {0} and dataverse linking dataverse ID {1} not found.
find.dataverselinking.error.not.found.bad.ids=Bad dataverse ID number: {0} or dataverse linking dataverse ID number: {1}.

Following the discussion on Zulip to clarify these, the messages could be improved by clarifying which object is the linked one and using "target" rather than "linking".

Here is a proposition for the following PR (feel free to comment or join the Zulip stream) :

find.datasetlinking.error.not.found.ids=Dataset linking with linked dataset ID {0} and target dataverse ID {1} not found.
find.datasetlinking.error.not.found.bad.ids=Bad linked dataset ID number: {0} or target dataverse ID number: {1}.
find.dataverselinking.error.not.found.ids=Dataverse linking with target dataverse ID {0} and linked dataverse ID {1} not found.
find.dataverselinking.error.not.found.bad.ids=Bad target dataverse ID number: {0} or linked dataverse ID number: {1}.

These properties are located in Bundle.properties

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

What inspired the request?
Translation of these properties.

Any open or closed issues related to this feature request?
None seen

Will you be able to contribute a Pull Request for this issue?
Yes, we'll push the updated messages to Bundle after the new sentences have been discussed with the community

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

Open the Bundle.properties file mentioned in the issue and locate the four dataset-linking and dataverse-linking error messages. Compare their placeholders and wording with the proposed replacements, then verify that each message clearly distinguishes linked and target dataverses and preserves the expected IDs.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.