11159 Add more information about anonymous access Preview URL #11164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
📦 Pushed preview images as 🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
pdurbin
reviewed
Jan 24, 2025
| @@ -0,0 +1,3 @@ | |||
| ### Preview URL popup updated | |||
|
|
|||
| The Preview URL popup has been updated to give the dataset more information about anonymous access including the names of the dataset fields that will be withheld from the url user and suggesting how to review the url before releasing it. | |||
There was a problem hiding this comment.
Suggested change
| The Preview URL popup has been updated to give the dataset more information about anonymous access including the names of the dataset fields that will be withheld from the url user and suggesting how to review the url before releasing it. | |
| The Preview URL popup has been updated to give the dataset more information about anonymous access including the names of the dataset fields that will be withheld from the url user and suggesting how to review the url before releasing it. See also #11159 and #11164. |
| @@ -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. | |||
There was a problem hiding this comment.
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.
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.
| 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. |
There was a problem hiding this comment.
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Is there a release notes update needed for this change?: included
Additional documentation: the note on testing was added to the doc