-
Notifications
You must be signed in to change notification settings - Fork 488
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
improve guestbook guides and link to them, add download button #8402
Conversation
Thanks for the screenshots, @pdurbin. Which user types see the "view terms while no guestbook is selected" example? Dataset downloaders? Dataset owners? Both? |
@TaniaSchlatter both. |
@pdurbin ideally dataset users do not see the Guestbook module unless there is a Guestbook (view terms while no guestbook is selected example). I recognize that might be out of scope. As is, the language is written for a data owner, and might be confusing to a data user. Let's discuss options. The button looks great! |
@TaniaSchlatter @scolapasta and I had a nice pow wow about next steps. I went over some changes to the guides I wanted to met and after we hung up I implemented them (plus a couple more) in d27a45b. This includes putting quotes around button labels, as discussed. Feedback is certainly welcome. I also lowercased to "guestbooks" in 0d34784 as discussed. A principle we discussed is that downloaders don't need to see the link to the guides. Toward that end, as suggested above, we plan to hide the entire Guestbooks panel for non-editors (people just browsing anonymously, for example) if there is no guestbook selected. (Less is more. Don't make me think.) Since only editors will see this we can change the message from "you will not" to "users will not". I'll ping Tania when I'm done with the panel so we can take another look. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
What this PR does / why we need it:
Users could use some help understanding how guestbooks work by reading the guides. We provide a link to the guides in a few more places. We also add a download button on the page that lists guestbooks so that users don't have to first click "View Responses" to see responses and then click "Download" to download them.
Which issue(s) this PR closes:
Closes #8244
Special notes for your reviewer:
streamResponsesByDataverseAndGuestbook
was mostly copied fromGuestbookResponsesPage.streamResponsesByDataverseAndGuestbook
.Suggestions on how to test this:
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Yes. The "To learn more about" line was added in several places. Also, a new download button was added to the list of guestbooks.
create guestbook
edit guestbook
view terms while no guestbook is selected (edit access)
view terms while no guestbook is selected (no edit access)
select a guestbook
download guestbooks from list of guestbooks
Is there a release notes update needed for this change?:
Yes, added.
Additional documentation:
A significant rewrite of the guestbooks section of the User Guide is included.