Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

11159 Add more information about anonymous access Preview URL #11164

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from

Conversation

sekmiller
Copy link
Contributor

What this PR does / why we need it:
In reviewing the complete list of dataset fields to be withheld from users of the anonymized Preview URL, the curation team suggested that the dataset depositor should have more info available - in particular the names of the metadata fields which will be withheld from the url user and suggestions on how they could test the preview url to make sure that the available Metadata does not reveal the identity of the depositor,

Which issue(s) this PR closes:

Special notes for your reviewer: no functional changes just tool tips and docs as suggested by curation team

Suggestions on how to test this: as a dataset owner in an installation that supports anonymous preview url make sure that the list of withheld metadata fields in the tool tip on the Preview URL popup matches the fields from the setting AnonymizedFieldTypeNames

Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Screen Shot 2025-01-16 at 3 16 00 PM
Screen Shot 2025-01-16 at 10 34 06 AM

Is there a release notes update needed for this change?: included

Additional documentation: the note on testing was added to the doc

@sekmiller sekmiller added the Size: 3 A percentage of a sprint. 2.1 hours. label Jan 16, 2025
@sekmiller sekmiller added this to the 6.6 milestone Jan 16, 2025
@sekmiller sekmiller added the FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) label Jan 16, 2025
@coveralls
Copy link

coveralls commented Jan 16, 2025

Coverage Status

coverage: 22.758% (-0.002%) from 22.76%
when pulling 9b44b98 on 11159-anon-access-doc
into 78ac64b on develop.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't test this but the code looks reasonable. I'm leaving a little feedback.

doc/release-notes/11159-preview-url-update.md Outdated Show resolved Hide resolved
@@ -694,6 +694,9 @@ Creating a Preview URL for your dataset allows you to share your dataset (for vi
#. Copy the Preview URL which has been created for this dataset and it can now be shared with anyone you wish to have access to view or download files in your unpublished dataset.

To disable a Preview URL and to revoke access, follow the same steps as above until step #3 when you return to the popup, click the “Disable Preview URL” button.

Before distributing an anonymized Preview URL it is recommended that you view the dataset as a potential user to verify that the metadata available does not reveal authorship, etc. You must first log out of Dataverse then open the dataset via the anonymized Preview URL you plan to distribute. By logging out first, you will be able to view the dataset as it would be seen by the anonymized Preview URL user. It may be necessary for you to further edit your dataset's metadata to remove identifying items before you distribute the anonymized Preview URL.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Before distributing an anonymized Preview URL it is recommended that you view the dataset as a potential user to verify that the metadata available does not reveal authorship, etc. You must first log out of Dataverse then open the dataset via the anonymized Preview URL you plan to distribute. By logging out first, you will be able to view the dataset as it would be seen by the anonymized Preview URL user. It may be necessary for you to further edit your dataset's metadata to remove identifying items before you distribute the anonymized Preview URL.
Before distributing an anonymized Preview URL it is recommended that you view the dataset as a potential user to verify that the metadata available does not reveal authorship, etc. You must first log out of Dataverse and then open the dataset via the anonymized Preview URL you plan to distribute. By logging out first, you will be able to view the dataset as it would be seen by the anonymized Preview URL user. It may be necessary for you to further edit your dataset's metadata to remove identifying items before you distribute the anonymized Preview URL.

I'm suggesting the same change below in the bundle but maybe we can discuss it here. I'm simply adding "and" but perhaps the whole paragraph could be made a bit shorter somehow? In the docs it's fine but in the tooltip (thanks for the screenshot!) it looks a bit big.

404042237-0be43c5d-9662-4daa-8c82-cf82e2d3cf94

I assume we're using a tooltip because we already have a lot of text in the popup and we're trying not to overwhelm the user.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right. And that's what Katie suggested and approved

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I definitely take the point of having a lot of info in the tool tip here too. I just think there should be someplace where a user can access the list of fields that are anonymized. A link to somewhere in the guide would be fine.

dataset.privateurl.anonymous.description.paragraph.two=The dataset's files are not changed and users of the Anonymous Preview URL will be able to access them. Users of the Anonymous Preview URL will not be able to see the name of the Dataverse that this dataset is in but will be able to see the name of the repository, which might expose the dataset authors' identities.
dataset.privateurl.anonymous.tooltip.testing=Before distributing an anonymized Preview URL it is recommended that you view the dataset as a potential user to verify that the metadata available does not reveal authorship, etc. You must first log out of Dataverse then open the dataset via the anonymized Preview URL you plan to distribute. By logging out first, you will be able to view the dataset as it would be seen by the anonymized Preview URL user. It may be necessary for you to further edit your dataset's metadata to remove identifying items before you distribute the anonymized Preview URL.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
dataset.privateurl.anonymous.tooltip.testing=Before distributing an anonymized Preview URL it is recommended that you view the dataset as a potential user to verify that the metadata available does not reveal authorship, etc. You must first log out of Dataverse then open the dataset via the anonymized Preview URL you plan to distribute. By logging out first, you will be able to view the dataset as it would be seen by the anonymized Preview URL user. It may be necessary for you to further edit your dataset's metadata to remove identifying items before you distribute the anonymized Preview URL.
dataset.privateurl.anonymous.tooltip.testing=Before distributing an anonymized Preview URL it is recommended that you view the dataset as a potential user to verify that the metadata available does not reveal authorship, etc. You must first log out of Dataverse and then open the dataset via the anonymized Preview URL you plan to distribute. By logging out first, you will be able to view the dataset as it would be seen by the anonymized Preview URL user. It may be necessary for you to further edit your dataset's metadata to remove identifying items before you distribute the anonymized Preview URL.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me think about making this shorter, but Katie is very concerned about someone distributing an anonymized preview that might contain identifying info.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before distributing an anonymized Preview URL it is recommended that you view the dataset as a potential user to verify that the metadata available does not reveal authorship, etc. You must first log out of Dataverse then open the dataset via the anonymized Preview URL you plan to distribute. By logging out first, you will be able to view the dataset as it would be seen by the anonymized Preview URL user. It may be necessary for you to further edit your dataset's metadata to remove identifying items before you distribute the anonymized Preview URL.

@pdurbin Just to be clear, in these instructions, we are assuming the user publishes the dataset and then goes back in and looks at it from a user perspective. Reading this, it may be unclear to the user whether they need to publish first and get a copy of the link before logging out. I know, hate being so specific but... This also implies if they want to review it, they are publishing a minor version with any additional anonymization they may need to do?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about something like: "To verify that all identifying information has been removed or anonymized, it is recommended that you logout and review the dataset as as it would be seen by an anonymized Preview URL user." I think it could be fine to assume that a user understands the concept of "logging out to review" without having to explicitly talk them through each step and the reasoning behind.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to take another pass at this. what I was trying to get across is that the author/depositor should view the dataset via the anonymous url before distributing it. That way they can see what the anonymous reviewer would see and be alerted to any metadata that may reveal authorship, etc.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

@cmbz cmbz added the FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) label Jan 30, 2025
Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11159-anon-access-doc
ghcr.io/gdcc/configbaker:11159-anon-access-doc

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) Size: 3 A percentage of a sprint. 2.1 hours.
Projects
Status: In Review 🔎
Development

Successfully merging this pull request may close these issues.

Feature Request: Add more information to the Anonymized Access Documentation and withheld fields tool tip
6 participants