Update the "Creating Review Requests" documentation for the new hotness.

Review Request #4717 — Created Oct. 10, 2013 and submitted

Information

Review Board
master

Reviewers

Update the "Creating Review Requests" documentation for the new hotness.

I've rewritten all the documentation dealing with the new review request page
to explain the new UI and the various workflows that it enables.

Generated html docs and read through the new text a few times.

Description From Last Updated

maybe reword to "To get the change into the repo", to make clear it's not always a change to Review …

PU puiterwijk

Should you really say this is a new feature? If you're in Review Board 5.0, this will probably still be …

PU puiterwijk

Which types of repositories? Maybe name them explicitely?

PU puiterwijk

I thought this was for creating a review request instead of "viewing"?

PU puiterwijk

"left-hand" side

chipx86chipx86

Maybe "configured on the server" instead of "connected?" I would also start "The first step" on the next paragraph, to …

chipx86chipx86

"Once ... first" sounds good. Maybe remove the "first."

chipx86chipx86

If we list the types of repositories, it'll easily grow stale. Let's just say that it's not available for all …

chipx86chipx86

"jump-to" looks odd here. "Jump To" would look better. If we had the icon showing up here, that'd be even …

chipx86chipx86
reviewbot
  1. This is a review from Review Bot.
    Tool: PEP8 Style Checker
    Processed Files:
    Ignored Files:
    docs/manual/users/review-requests/new-review-request-form.png
    docs/manual/users/review-requests/creating.txt
    docs/manual/users/review-requests/new-review-request.png

  2. 
      
reviewbot
  1. This is a review from Review Bot.
    Tool: Pyflakes
    Processed Files:
    Ignored Files:
    docs/manual/users/review-requests/new-review-request-form.png
    docs/manual/users/review-requests/creating.txt
    docs/manual/users/review-requests/new-review-request.png

  2. 
      
PU
  1. 
      
  2. maybe reword to "To get the change into the repo", to make clear it's not always a change to Review Board, but rather the code managed through a Review Board instance?

    1. It's not about committing to the repo, it's about posting the change. I'll work on the wording.

  3. Should you really say this is a new feature? If you're in Review Board 5.0, this will probably still be here as nobody cleaned this up?

    1. I'll change it to use our versionadded macro.

  4. Which types of repositories? Maybe name them explicitely?

  5. I thought this was for creating a review request instead of "viewing"?

  6. 
      
david
reviewbot
  1. This is a review from Review Bot.
    Tool: PEP8 Style Checker
    Processed Files:
    Ignored Files:
    docs/manual/users/review-requests/new-review-request-form.png
    docs/manual/users/review-requests/creating.txt
    docs/manual/users/review-requests/new-review-request.png

  2. 
      
reviewbot
  1. This is a review from Review Bot.
    Tool: Pyflakes
    Processed Files:
    Ignored Files:
    docs/manual/users/review-requests/new-review-request-form.png
    docs/manual/users/review-requests/creating.txt
    docs/manual/users/review-requests/new-review-request.png

  2. 
      
chipx86
  1. 
      
  2. "left-hand" side

  3. Maybe "configured on the server" instead of "connected?"

    I would also start "The first step" on the next paragraph, to help with scanning instructions.

  4. "Once ... first" sounds good. Maybe remove the "first."

  5. If we list the types of repositories, it'll easily grow stale. Let's just say that it's not available for all types of repositories.

  6. "jump-to" looks odd here. "Jump To" would look better. If we had the icon showing up here, that'd be even better.

    1. I'll just say "an icon". It'll be obvious when people look at it.

  7. 
      
david
reviewbot
  1. This is a review from Review Bot.
    Tool: PEP8 Style Checker
    Processed Files:
    Ignored Files:
    docs/manual/users/review-requests/new-review-request-form.png
    docs/manual/users/review-requests/creating.txt
    docs/manual/users/review-requests/new-review-request.png

  2. 
      
reviewbot
  1. This is a review from Review Bot.
    Tool: Pyflakes
    Processed Files:
    Ignored Files:
    docs/manual/users/review-requests/new-review-request-form.png
    docs/manual/users/review-requests/creating.txt
    docs/manual/users/review-requests/new-review-request.png

  2. 
      
chipx86
  1. Ship It!

  2. 
      
david
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to master (85040a4).

Loading...