Dataverse API and UI use term "archival" in ways that can make users unsure of which files are included
Nobody has claimed this yet.
- 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:
- The documentation for the API endpoint that reports the size of files in a dataset
- The documentation for the API endpoint that reports the size of all files in a collection
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:
-
The download options that users see in the UI, such as on the "Access Dataset" and "Download" dropdown menus on the page of a dataset that has .tab copies that Dataverse created
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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