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

improve guestbook guides and link to them, add download button #8402

Merged
merged 9 commits into from
Feb 10, 2022

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Feb 4, 2022

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 from GuestbookResponsesPage.streamResponsesByDataverseAndGuestbook.

Suggestions on how to test this:

  • Make sure the links to the guides appear in the places show in the screenshots below.
  • Make sure the download link in the screenshot below works.

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

  • Link to guides added to the top.

Screen Shot 2022-02-04 at 2 31 42 PM

edit guestbook

  • Link to guides added to the top.

Screen Shot 2022-02-04 at 2 32 52 PM

view terms while no guestbook is selected (edit access)

  • Added link to guides and reworded text under Guestbooks.
  • Note that the "help-block" CSS class was added to make the text grey.

Screen Shot 2022-02-09 at 11 37 59 AM

view terms while no guestbook is selected (no edit access)

  • Guestbook panel is hidden (because it's irrelevant).

Screen Shot 2022-02-09 at 11 38 22 AM

select a guestbook

  • Link to guides added.

Screen Shot 2022-02-04 at 2 36 13 PM

download guestbooks from list of guestbooks

  • Download button under "Action" for each row.

Screen Shot 2022-02-07 at 3 11 01 PM

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.

@pdurbin pdurbin self-assigned this Feb 4, 2022
@pdurbin pdurbin changed the title link to guides when creating, editing, selecting guestbooks #8244 improve guides and link to them when operating on guestbooks #8244 Feb 4, 2022
@TaniaSchlatter
Copy link
Member

Thanks for the screenshots, @pdurbin. Which user types see the "view terms while no guestbook is selected" example? Dataset downloaders? Dataset owners? Both?

@pdurbin
Copy link
Member Author

pdurbin commented Feb 7, 2022

@TaniaSchlatter both.

@pdurbin pdurbin changed the title improve guides and link to them when operating on guestbooks #8244 improve guestbook guides and link to them, add download button #8244 Feb 7, 2022
@pdurbin pdurbin marked this pull request as ready for review February 7, 2022 20:29
@pdurbin pdurbin changed the title improve guestbook guides and link to them, add download button #8244 improve guestbook guides and link to them, add download button Feb 7, 2022
@pdurbin pdurbin removed their assignment Feb 7, 2022
@TaniaSchlatter
Copy link
Member

TaniaSchlatter commented Feb 7, 2022

@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!

@pdurbin
Copy link
Member Author

pdurbin commented Feb 8, 2022

@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.

@sekmiller sekmiller self-assigned this Feb 10, 2022
Copy link
Contributor

@sekmiller sekmiller left a comment

Choose a reason for hiding this comment

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

Looks good.

@sekmiller sekmiller removed their assignment Feb 10, 2022
@kcondon kcondon self-assigned this Feb 10, 2022
@kcondon kcondon merged commit 4a63369 into develop Feb 10, 2022
@kcondon kcondon deleted the 8244-guestbook branch February 10, 2022 21:53
@pdurbin pdurbin added this to the 5.10 milestone Feb 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Help users creating a guestbook, including how to download results
4 participants