• 
      

    Flesh out the "Review Requests" chapter a fair bit.

    Review Request #7369 — Created June 3, 2015 and submitted

    Information

    Review Board
    release-2.5.x
    a6ff7ae...

    Reviewers

    This update makes a bunch of major improvements to the "Review Requests"
    chapter in the user manual:

    • Added an "Overview" page which gives a high-level summary of what a review
      request is and all the different pieces of UI. It also discusses review
      request drafts a bit.
    • Made some revisions to the "Creating Review Requests" page.
    • Updated the screenshots throughout.

    Built HTML and looked at the results.

    Description From Last Updated

    Do we want both guilabel and quotes here?

    chipx86chipx86

    "top-right"

    chipx86chipx86

    I think this should be a semicolon at the end, not a comma.

    chipx86chipx86

    "top-left"

    chipx86chipx86

    Can you add a "TODO:", just to help this stand out?

    chipx86chipx86

    Should use = instead of - at this level.

    chipx86chipx86

    I think "and is" ?

    chipx86chipx86
    reviewbot
    1. Tool: PEP8 Style Checker
      Ignored Files:
          docs/manual/users/review-requests/review-request-fields@2x.png
          docs/manual/users/review-requests/review-request-details@2x.png
          docs/manual/users/review-requests/review-request-details.png
          docs/manual/users/review-requests/uploading-files.rst
          docs/manual/users/review-requests/file-attachment.png
          docs/manual/users/review-requests/upload-diff-dialog@2x.png
          docs/manual/users/dashboard/index.rst
          docs/manual/users/review-requests/new-review-request.png
          docs/manual/users/review-requests/review-request-fields.png
          docs/manual/users/review-requests/index.rst
          docs/manual/users/review-requests/file-attachment@2x.png
          docs/manual/users/review-requests/fields.rst
          docs/manual/users/review-requests/new-review-request@2x.png
          docs/manual/users/review-requests/overview.rst
          docs/manual/users/review-requests/creating.rst
          docs/manual/users/review-requests/upload-diff-dialog.png
      
      
      
      Tool: Pyflakes
      Ignored Files:
          docs/manual/users/review-requests/review-request-fields@2x.png
          docs/manual/users/review-requests/review-request-details@2x.png
          docs/manual/users/review-requests/review-request-details.png
          docs/manual/users/review-requests/uploading-files.rst
          docs/manual/users/review-requests/file-attachment.png
          docs/manual/users/review-requests/upload-diff-dialog@2x.png
          docs/manual/users/dashboard/index.rst
          docs/manual/users/review-requests/new-review-request.png
          docs/manual/users/review-requests/review-request-fields.png
          docs/manual/users/review-requests/index.rst
          docs/manual/users/review-requests/file-attachment@2x.png
          docs/manual/users/review-requests/fields.rst
          docs/manual/users/review-requests/new-review-request@2x.png
          docs/manual/users/review-requests/overview.rst
          docs/manual/users/review-requests/creating.rst
          docs/manual/users/review-requests/upload-diff-dialog.png
      
      
    2. 
        
    chipx86
    1. This will be a great addition :)

    2. Show all issues

      Do we want both guilabel and quotes here?

      1. I tried it with only guilabel and it was confusing.

    3. Show all issues

      "top-right"

    4. Show all issues

      I think this should be a semicolon at the end, not a comma.

      1. Nope. That said, it's a pretty big sentence, so I'll break it

      2. That was a list of things (Reviews view and Diff view) with commas in each item. Semicolons are used in that case to separate out the items. Am I reading it wrong?

    5. Show all issues

      "top-left"

    6. Show all issues

      Can you add a "TODO:", just to help this stand out?

    7. Show all issues

      Should use = instead of - at this level.

    8. Show all issues

      I think "and is" ?

    9. 
        
    david
    reviewbot
    1. Tool: Pyflakes
      Ignored Files:
          docs/manual/users/review-requests/review-request-fields@2x.png
          docs/manual/users/review-requests/review-request-details@2x.png
          docs/manual/users/review-requests/review-request-details.png
          docs/manual/users/review-requests/uploading-files.rst
          docs/manual/users/review-requests/file-attachment.png
          docs/manual/users/review-requests/upload-diff-dialog@2x.png
          docs/manual/users/dashboard/index.rst
          docs/manual/users/review-requests/new-review-request.png
          docs/manual/users/review-requests/review-request-fields.png
          docs/manual/users/review-requests/index.rst
          docs/manual/users/review-requests/file-attachment@2x.png
          docs/manual/users/review-requests/fields.rst
          docs/manual/users/review-requests/new-review-request@2x.png
          docs/manual/users/review-requests/overview.rst
          docs/manual/users/review-requests/creating.rst
          docs/manual/users/review-requests/upload-diff-dialog.png
      
      
      
      Tool: PEP8 Style Checker
      Ignored Files:
          docs/manual/users/review-requests/review-request-fields@2x.png
          docs/manual/users/review-requests/review-request-details@2x.png
          docs/manual/users/review-requests/review-request-details.png
          docs/manual/users/review-requests/uploading-files.rst
          docs/manual/users/review-requests/file-attachment.png
          docs/manual/users/review-requests/upload-diff-dialog@2x.png
          docs/manual/users/dashboard/index.rst
          docs/manual/users/review-requests/new-review-request.png
          docs/manual/users/review-requests/review-request-fields.png
          docs/manual/users/review-requests/index.rst
          docs/manual/users/review-requests/file-attachment@2x.png
          docs/manual/users/review-requests/fields.rst
          docs/manual/users/review-requests/new-review-request@2x.png
          docs/manual/users/review-requests/overview.rst
          docs/manual/users/review-requests/creating.rst
          docs/manual/users/review-requests/upload-diff-dialog.png
      
      
    2. 
        
    chipx86
    1. Ship It!
    2. 
        
    david
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to release-2.5.x (15e1501)