IQSS / IQSS/dataverse

Dataverse API and UI use term "archival" in ways that can make users unsure of which files are included

Open
#12,155 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

For several API endpoints that return file sizes of datasets, we use the term "archival" in ways that can make users unsure of which types of files are included in the sizes that the endpoints return. And how we use "archival" differently in the Dataverse UI might also make users unsure of what we mean by "archival" files.

When "archival" files means the files a depositor uploaded plus the .tab copies that Dataverse creates
We use the term "archival" to include "the files uploaded by users (plus the tab-delimited versions generated for tabular data files on ingest)" in:

When "archival" files means only the .tab copies that Dataverse creates
We use the term "archival" to mean only the tab-delimited versions generated for tabular data files on ingest in:

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 three linked API documentation sections and the “Access Dataset” and “Download” menu labels shown in the issue. Compare how each uses “archival” and identify terminology that distinguishes uploaded files from generated .tab files. Done means the API documentation and UI consistently communicate which files and sizes are included.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation, frontend
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.