Add the tips carousel to the review dialog.

Review Request #13173 — Created Aug. 1, 2023 and submitted

Information

Review Board
release-6.x

Reviewers

With the change to pop up the review dialog as soon as a user clicks
"Create a new review", I worry that we're exacerbating the problem we've
always had of users not knowing how to create comments. This change adds
a new carousel of tips to the bottom of the review dialog, explaining
how to use comments and reviews.

Opened the review dialog for both empty and non-empty reviews. Saw that
when the review was empty, I saw the tips. The tips carousel starts in
auto-cycle mode, and I was able to cycle forward and backward through
the list.

Summary ID
Add the tips carousel to the review dialog.
With the change to pop up the review dialog as soon as a user clicks "Create a new review", I worry that we're exacerbating the problem we've always had of users not knowing how to create comments. This change adds a new carousel of tips to the bottom of the review dialog, explaining how to use comments and reviews. Testing Done: Opened the review dialog for both empty and non-empty reviews. Saw that when the review was empty, I saw the tips. The tips carousel starts in auto-cycle mode, and I was able to cycle forward and backward through the list.
ca3d4c985be61f124f984a34cb791fb9f13db0d2

Description From Last Updated

Do you think some users would get annoyed of the tips carousel? I feel like I might after a while. …

maubinmaubin

I feel like this might look nice within an info alert. How does this look at the top of the …

chipx86chipx86

These lines are too long. The _ template literal will happily wrap and condense whitespace.

chipx86chipx86

I think it'd be nice to add something like this: "For more information on reviewing code and documents, visit our …

maubinmaubin

Missing localization.

chipx86chipx86

Let's dedent this. No need to preserve the extra whitespace in the generated bundle.

chipx86chipx86
david
  1. 
      
  2. I feel like this could use (a lot) more content. Please let me know if you have any ideas.

  3. 
      
chipx86
  1. 
      
  2. I feel like this might look nice within an info alert.

    How does this look at the top of the dialog? That feels like a more stable location.

    1. I like the idea of putting this in an info alert, it does need more of a visual separation from the rest of the review dialog.

    2. The top of the dialog feels super weird.

  3. These lines are too long. The _ template literal will happily wrap and condense whitespace.

  4. Missing localization.

  5. Let's dedent this. No need to preserve the extra whitespace in the generated bundle.

  6. 
      
maubin
  1. 
      
  2. I think it'd be nice to add something like this:

    "For more information on reviewing code and documents, visit our documentation."

  3. 
      
david
maubin
  1. 
      
  2. Do you think some users would get annoyed of the tips carousel? I feel like I might after a while. We could add an X in the top right corner so that users can minimize the info alert, and when minimized it becomes just a "Show tips" link that they can click on to expand the full tips carousel again. And have this preference saved between reviews.

    1. I think it's probably not super intrusive because it only appears when there are no comments, but we can definitely make it hideable. I think I'd prefer to to that in a separate change, though.

    2. Sounds good.

  3. 
      
maubin
  1. Ship It!
  2. 
      
david
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-6.x (dc41224)
Loading...