IQSS / IQSS/dataverse

Some help text about guestbooks always tells users that guestbooks appear when downloading files

Open
#12,154 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Guestbook User Role: Curator User Role: Depositor User Role: Guest User Role: Superuser UX/UI Input Needed
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Some help text about guestbooks always tells users that guestbooks appear during file download, even when the guestbook mode is "Guestbook Entry at Access Request". This help text might confuse a collection manager who's trying to use a "Guestbook Entry at Access Request" guestbook or someone who's interested in a dataset that has such a guestbook applied to it.

I think all of the help text is in the Bundle.properties file, and I can see most of it in the UI. I've highlighted in orange the parts of these screenshots that tell users that guestbooks appear during file download, even when the guestbook mode is "Guestbook Entry at Access Request":

Help text a user always sees in the Guestbook panel of a dataset's Terms tab when no guestbook is applied to the dataset:
Image

Help text a user always sees when creating a guestbook:
Image

Help text a user always sees when applying a guestbook to a dataset:
Image

Help text a user always sees in the Guestbook panel of a dataset that has a guestbook applied:
Image

Help text a user always sees when previewing a dataset's guestbook:
Image

I see more text in the Bundle.properties file that I haven't been able to find in the UI, like the entry for "dataset.manageGuestbooks.noGuestbooks.why.reason1", which looks like a tip that a collection manager might see at the top of the Manage Guestbooks page:

dataset.manageGuestbooks.noGuestbooks.why.reason1=Guestbooks allow you to collect data about who is downloading the files from your datasets. You can decide to collect account information (username, given name & last name, affiliation, etc.) as well as create custom questions (e.g., What do you plan to use this data for?).

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 src/main/java/propertyFiles/Bundle.properties and locate the guestbook help-text entries shown in the issue, including dataset.manageGuestbooks.noGuestbooks.why.reason1. Compare the wording used for access-request and file-download modes across the five UI contexts. Done means the relevant text no longer implies that every guestbook appears only during file download, with both modes represented accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.