IQSS / IQSS/dataverse

Feature Request: Automatic Download of License Terms for Restricted Files

Open
#12,117 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Terms & Licensing Type: Feature 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
Increasing the likelihood that downloaders of restricted files will reviewed the Terms of Access. This may involve multiple new features/enhancements.

What kind of user is the feature intended for?
data downloader

What inspired the request?
At Johns Hopkins University, we are likely going to be permitting restricted files in our Repository in the coming year. Thus far, we only accept data that can be open. We've been going to various compliance offices at our institution and getting feedback on our proposed workflow. There are concerns that that pop-up box that contains the Terms of Access for Restricted Files is too small and will not be read.

What existing behavior do you want changed?
The pop-up box with the Terms of Access for Restricted Files could be expanded. See image.

Any brand new behavior do you want to add to Dataverse?
Ideally, there would be a way to configure our installation to automatically download a copy of the terms in a separate text file. It would be simplest if both the restricted file and text file came together in a zip file, but this may not work for every institution's storage configuration. Perhaps if a zip file is not possible, we would want the license text file to have a name that unambiguously marries it to the restricted file, including version, in case Terms of Access change through time.

Another, likely simpler approach, is to have a button that asks downloaders if they want to download the Terms of Access for Restricted Files. There would need to be some customizable language around this button explaining why they should download the license file.

Any open or closed issues related to this feature request?
Zulip conversation: https://dataverse.zulipchat.com/#narrow/channel/375707-community/topic/Automatic.20Download.20of.20License.20Terms.20for.20Restricted.20Files/with/564475372
https://github.com/IQSS/dataverse/issues/11459

Are you thinking about creating a pull request for this feature?
Not at this moment

Image

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 reviewing issue #11459 and the linked Zulip conversation, then examine Dataverse's existing restricted-file Terms of Access popup and download flow. Done means the project has an agreed implementation for the requested terms download behavior and expanded popup, including the required customization and file-naming or packaging rules.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.