Update the "Creating Review Requests" documentation for the new hotness.
Review Request #4717 — Created Oct. 10, 2013 and submitted
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 |
 chipx86
|
|
|
Maybe "configured on the server" instead of "connected?" I would also start "The first step" on the next paragraph, to … |
chipx86
|
|
|
"Once ... first" sounds good. Maybe remove the "first." |
chipx86
|
|
|
If we list the types of repositories, it'll easily grow stale. Let's just say that it's not available for all … |
chipx86
|
|
|
"jump-to" looks odd here. "Jump To" would look better. If we had the icon showing up here, that'd be even … |
chipx86
|
-
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
PU
-
-
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?
-
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?
-
-
-
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
-
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
-
-
-
Maybe "configured on the server" instead of "connected?"
I would also start "The first step" on the next paragraph, to help with scanning instructions.
-
-
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.
-
"jump-to" looks odd here. "Jump To" would look better. If we had the icon showing up here, that'd be even better.
-
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