IQSS / IQSS/dataverse-frontend

SPA : Set Curation labels for collections in the UI

Open
#519 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
31
Forks
26
Avg merge
4d 13h
Merged PRs (30d)
4

Description

Overview of the Feature Request
Allow collection managers to configure the set of curation labels for their collection from the edit collection form.

What kind of user is the feature intended for?
Dataverse collection administrators

Any brand new behavior do you want to add to Dataverse?
If AllowedCurationLabels is enabled with at least one set of curation labels, then add a section in the edit collection form to configure the collection's allowed set of collection labels curationLabelSet.
Choices should be :

  • Inherit from ROOT (default) (for reverting after another selection curl -H "X-Dataverse-key: $API_TOKEN" -X DELETE http://$SERVER/api/admin/dataverse/$dataverse-alias/curationLabelSet)
  • Selecting a set from the installation (equivalent to curl -H "X-Dataverse-key: $API_TOKEN" -X PUT http://$SERVER/api/admin/dataverse/$dataverse-alias/curationLabelSet?name=$curationLabelSetName), field disabled when "Inherit from ROOT" is ticked
  • Selecting none of the allowed sets, therefore disabling the feature for the collection ( curl -H "X-Dataverse-key: $API_TOKEN" -X PUT http://$SERVER/api/admin/dataverse/$dataverse-alias/curationLabelSet?name=DISABLED

The labels should be internationalized if the installation supports multiple languages.

Example of mockups

  1. Inherit from root
    Image
  2. Selecting a set
    Notes: I did put wrongly a multiple selector.
    The "too long example" is intentional to remember to address it when implementing.
    Image

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

Are you thinking about creating a pull request for this feature?
Not planned, we won't start contributing to the SPA before 2025.

https://guides.dataverse.org/en/latest/admin/dataverses-datasets.html#configure-a-dataverse-collection-to-allow-use-of-a-given-curation-label-set

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 at the SPA edit collection form and review the AllowedCurationLabels documentation plus the curationLabelSet API examples in the issue. Done means collection administrators can inherit, select, or disable a label set, with labels internationalized when multilingual support is enabled.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.