-
Notifications
You must be signed in to change notification settings - Fork 490
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
8184 preview url changes #10961
base: develop
Are you sure you want to change the base?
8184 preview url changes #10961
Conversation
This comment has been minimized.
This comment has been minimized.
Hey @sekmiller. I haven't seen what you've done but from your comments in this PR, shouldn't this PR close the GitHub issue Some researchers unsure of difference between "Private URL" and "Anonymous Private URL" #8185, instead of the GitHub issue it's set to close now, Reviewers using anonymous private URL might learn dataset author's identity from information about the Dataverse installation or collection #8184? |
Hey @jggautier, the reason that I marked it with 8184 was because that is the one that was in the queue- and it has the references to changing the name to "Preview URL". 8185 has "no status", but I can add it to the "Closes" above. |
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. |
Ah thanks, sorry for the confusion. So this PR is about more than changes to the preview URL. It's also addressing how reviewers using the anonymous private URL might learn about the dataset author's identity, by following the approach that I summarized in that image at https://user-images.githubusercontent.com/18374574/151025261-ed70e998-9341-4013-9e0f-3c1d4d2c83e4.jpg. Thanks for including #8184 like you did. But I think there's an issue with how things were moved to the queue. I helped propose and test the redesign that's described in #8184 before @sbarbosadataverse opened #10950. And both of these GitHub issues have the v6.5 milestone on them. Does this PR account for what's being planned in #10950? For example, does the popup still make sense when the breadcrumbs that the dataset reviewer can see on the dataset page "anonymized". |
What this PR does / why we need it: Updates the Private URL to Preview URL in Edit Dataset Popup and native api calls. The request was due to confusion over the use of Private URLs.
Which issue(s) this PR closes:
Closes Reviewers using anonymous private URL might learn dataset author's identity from information about the Dataverse installation or collection #8184 Reviewers using anonymous private URL might learn dataset author's identity from information about the Dataverse installation or collection
#8184
Closes Some researchers unsure of difference between "Private URL" and "Anonymous Private URL" #8185 Some researches unsure of differences between "Private URL" and "Anonymous Private URL
Special notes for your reviewer: the native api references to privateurl remain and have been marked as deprecated. The classes and service beans, etc. remain with the private url nomenclature.
Suggestions on how to test this:
This is the doc I used to guide the update to the Edit Dataset Popup: https://user-images.githubusercontent.com/18374574/151025261-ed70e998-9341-4013-9e0f-3c1d4d2c83e4.jpg
I did make one change to the popup to show the resulting url on create. Please verify with Julian that this makes sense and should remain - it was part of the original popup.
Creation of the "general" preview url will always be available to those that have manage Dataset permission permissions via the "Preview URL" option under the Edit Dataset menu. "Anonymous Preview" is only available if the AnonymizedFieldTypeNames setting has been added to the installation. (Use curl -X PUT -d 'author, datasetContact, contributor, depositor, grantNumber, publication' http://localhost:8080/api/admin/settings/:AnonymizedFieldTypeNames to add the setting)
Verify that the newly created preview url works and indicates to the user that they are viewing an unpublished dataset. Also if the "Anonymous Preview" is used that the Anonymized metadata are displayed as "withheld".
In the native api verify that previewurl and privateurl may be used interchangeably.(curl -H "X-Dataverse-key:35f79221-0fc4-433b-956c-cf20f7f13d87" -X POST "http://localhost:8080/api/datasets/:persistentId/privateUrl?anonymizedAccess=true&persistentId=doi:10.5072/FK2/GNJY26")
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Yes. See doc above.
Is there a release notes update needed for this change?:
Included.
Additional documentation:
The app documentation has been updated for this change