Docs intro-gerrit-walkthrough: Rewrite for v2.15 PG UI

Change screen shots and adapt text for the v2.15 PG UI.

Change-Id: Icf4f89f66f69b06cefafd30f180ff4adc778184b
This commit is contained in:
Sven Selberg
2018-06-11 09:05:41 +02:00
parent ad085b8e21
commit d0c00cdc09
11 changed files with 30 additions and 31 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

View File

@@ -4,7 +4,7 @@ To understand how Gerrit works, let's follow a change through its entire
life cycle. This example uses a Gerrit server configured as follows: life cycle. This example uses a Gerrit server configured as follows:
* *Hostname*: gerrithost * *Hostname*: gerrithost
* *HTTP interface port*: 8080 * *HTTP interface port*: 80
* *SSH interface port*: 29418 * *SSH interface port*: 29418
In this walkthrough, we'll follow two developers, Max and Hannah, as they make In this walkthrough, we'll follow two developers, Max and Hannah, as they make
@@ -52,19 +52,20 @@ follows:
---- ----
$ <work> $ <work>
$ git commit $ git commit
[master 9651f22] Change to a proper, yeast based pizza dough. [master 3cc9e62] Change to a proper, yeast based pizza dough.
1 files changed, 3 insertions(+), 2 deletions(-) 1 file changed, 10 insertions(+), 5 deletions(-)
$ git push origin HEAD:refs/for/master $ git push origin HEAD:refs/for/master
Counting objects: 5, done. Counting objects: 3, done.
Delta compression using up to 8 threads. Delta compression using up to 8 threads.
Compressing objects: 100% (2/2), done. Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 542 bytes, done. Writing objects: 100% (3/3), 532 bytes | 0 bytes/s, done.
Total 3 (delta 0), reused 0 (delta 0) Total 3 (delta 0), reused 0 (delta 0)
remote: Processing changes: new: 1, done
remote: remote:
remote: New Changes: remote: New Changes:
remote: http://gerrithost:8080/68 remote: http://gerrithost/#/c/RecipeBook/+/702 Change to a proper, yeast based pizza dough.
remote: remote:
To ssh://gerrithost:29418/RecipeBook.git To ssh://gerrithost:29418/RecipeBook
* [new branch] HEAD -> refs/for/master * [new branch] HEAD -> refs/for/master
---- ----
@@ -79,7 +80,7 @@ review this commit. Clicking on that link takes him to a screen similar to
the following. the following.
.Gerrit Code Review Screen .Gerrit Code Review Screen
image::images/intro-quick-new-review.jpg[Gerrit Review Screen] image::images/intro-quick-new-review.png[Gerrit Review Screen]
This is the Gerrit code review screen, where other contributors can review This is the Gerrit code review screen, where other contributors can review
his change. Max can also perform tasks such as: his change. Max can also perform tasks such as:
@@ -109,14 +110,12 @@ offers other ways for reviewers to find changes, including:
Because Max added Hannah as a reviewer, she receives an email telling her about Because Max added Hannah as a reviewer, she receives an email telling her about
his change. She opens up the Gerrit code review screen and selects Max's change. his change. She opens up the Gerrit code review screen and selects Max's change.
.Gerrit Code Review Screen Notice the *Label status* section above:
image::images/intro-quick-new-review.jpg[Gerrit Review Screen]
Notice the two "Need" lines:
---- ----
* Need Verified Label Status Needs label:
* Need Code-Review * Code-Review
* Verified
---- ----
These two lines indicate what checks must be completed before the change is These two lines indicate what checks must be completed before the change is
@@ -147,13 +146,13 @@ link:user-review-ui.html#reply[summary] comments.
Hannah opts to view the change using Gerrit's side-by-side view: Hannah opts to view the change using Gerrit's side-by-side view:
.Side By Side Patch View .Side By Side Patch View
image::images/intro-quick-review-line-comment.jpg[Adding a Comment] image::images/intro-quick-review-line-comment.png[Adding a Comment]
Hannah reviews the change and is ready to provide her feedback. She clicks the Hannah reviews the change and is ready to provide her feedback. She clicks the
*Review* button on the change screen. This allows her to vote on the change. *REPLY* button on the change screen. This allows her to vote on the change.
.Reviewing the Change .Reviewing the Change
image::images/intro-quick-reviewing-the-change.jpg[Reviewing the Change] image::images/intro-quick-reviewing-the-change.png[Reviewing the Change]
For Hannah and Max's team, a code review vote is a numerical score between -2 For Hannah and Max's team, a code review vote is a numerical score between -2
and 2. The possible options are: and 2. The possible options are:
@@ -175,7 +174,7 @@ link:config-project-config.html[Project Configuration File Format] topic.
Hannah notices a possible issue with Max's change, so she selects a `-1` vote. Hannah notices a possible issue with Max's change, so she selects a `-1` vote.
She uses the *Cover Message* text box to provide Max with some additional She uses the *Cover Message* text box to provide Max with some additional
feedback. When she is satisfied with her review, Hannah clicks the feedback. When she is satisfied with her review, Hannah clicks the
*Publish Comments* button. At this point, her vote and cover message become *SEND* button. At this point, her vote and cover message become
visible to to all users. visible to to all users.
== Reworking the Change == Reworking the Change
@@ -193,18 +192,21 @@ workflow for updating a commit:
$ <checkout first commit> $ <checkout first commit>
$ <rework> $ <rework>
$ git commit --amend $ git commit --amend
[master 30a6f44] Change to a proper, yeast based pizza dough.
Date: Fri Jun 8 16:28:23 2018 +0200
1 file changed, 10 insertions(+), 5 deletions(-)
$ git push origin HEAD:refs/for/master $ git push origin HEAD:refs/for/master
Counting objects: 5, done. Counting objects: 3, done.
Delta compression using up to 8 threads. Delta compression using up to 8 threads.
Compressing objects: 100% (2/2), done. Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 546 bytes, done. Writing objects: 100% (3/3), 528 bytes | 0 bytes/s, done.
Total 3 (delta 0), reused 0 (delta 0) Total 3 (delta 0), reused 0 (delta 0)
remote: Processing changes: updated: 1, done remote: Processing changes: updated: 1, done
remote: remote:
remote: Updated Changes: remote: Updated Changes:
remote: http://gerrithost:8080/68 remote: http://gerrithost/#/c/RecipeBook/+/702 Change to a proper, yeast based pizza dough.
remote: remote:
To ssh://gerrithost:29418/RecipeBook.git To ssh://gerrithost:29418/RecipeBook
* [new branch] HEAD -> refs/for/master * [new branch] HEAD -> refs/for/master
---- ----
@@ -212,13 +214,10 @@ Notice that the output of this command is slightly different from Max's first
commit. This time, the output verifies that the change was updated. commit. This time, the output verifies that the change was updated.
Having uploaded the reworked commit, Max can go back to the Gerrit web Having uploaded the reworked commit, Max can go back to the Gerrit web
interface and look at his change. interface, look at his change and diff the first patch set with his rework in
the second one. Once he has verified that the rework follows Hannahs
.Reviewing the Rework recommendation he presses the *DONE* button to let Hannah know that she can
image::images/intro-quick-review-2-patches.jpg[Reviewing the Rework] review the changes.
Notice that there are now two patch sets associated with this change: the
initial submission and the rework.
When Hannah next looks at Max's change, she sees that he incorporated her When Hannah next looks at Max's change, she sees that he incorporated her
feedback. The change looks good to her, so she changes her vote to a `+2`. feedback. The change looks good to her, so she changes her vote to a `+2`.
@@ -254,7 +253,7 @@ NOTE: The Verifier can be the same person as the code reviewer or a
different person entirely. different person entirely.
.Verifying the Change .Verifying the Change
image::images/intro-quick-verifying.jpg[Verifying the Change] image::images/intro-quick-verifying.png[Verifying the Change]
Unlike the code review check, the verify check is pass/fail. Hannah can provide Unlike the code review check, the verify check is pass/fail. Hannah can provide
a score of either `+1` or `-1`. A change must have at least one `+1` and no a score of either `+1` or `-1`. A change must have at least one `+1` and no
@@ -266,7 +265,7 @@ submitted.
== Submitting the Change == Submitting the Change
Max is now ready to submit his change. He opens up the change in the Code Review Max is now ready to submit his change. He opens up the change in the Code Review
screen and clicks the *Publish and Submit* button. screen and clicks the *SUBMIT* button.
At this point, Max's change is merged into the repository's master branch and At this point, Max's change is merged into the repository's master branch and
becomes an accepted part of the project. becomes an accepted part of the project.