Describe change info block in review UI documentation
Change-Id: If82101ee0580e84698b8f18b86a5ef2b9061c3fc Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
After Width: | Height: | Size: 138 KiB |
After Width: | Height: | Size: 34 KiB |
After Width: | Height: | Size: 105 KiB |
After Width: | Height: | Size: 104 KiB |
After Width: | Height: | Size: 105 KiB |
After Width: | Height: | Size: 107 KiB |
After Width: | Height: | Size: 37 KiB |
After Width: | Height: | Size: 104 KiB |
After Width: | Height: | Size: 221 KiB |
@@ -106,6 +106,190 @@ is also a link to the commit in the Git web browser.
|
||||
|
||||
image::images/user-review-ui-change-screen-commit-info.png[width=800, link="images/user-review-ui-change-screen-commit-info.png"]
|
||||
|
||||
[[change-info]]
|
||||
=== Change Info Block
|
||||
|
||||
The change info block contains detailed information about the change
|
||||
and offers actions on the change.
|
||||
|
||||
image::images/user-review-ui-change-screen-change-info.png[width=800, link="images/user-review-ui-change-screen-change-info.png"]
|
||||
|
||||
- Change Owner:
|
||||
+
|
||||
The owner of the change is displayed as a link to a list of the owner's
|
||||
changes that have the same status as the currently viewed change.
|
||||
+
|
||||
image::images/user-review-ui-change-screen-change-info-owner.png[width=800, link="images/user-review-ui-change-screen-change-info-owner.png"]
|
||||
|
||||
- Reviewers:
|
||||
+
|
||||
The reviewers of the change are displayed as chip tokens.
|
||||
+
|
||||
For each reviewer there is a tooltip that shows on which labels the
|
||||
reviewer is allowed to vote.
|
||||
+
|
||||
New reviewers can be added by clicking on the `Add...` button. Typing
|
||||
into the pop-up text field activates auto completion of user and group
|
||||
names.
|
||||
+
|
||||
Reviewers can be removed from the change by clicking on the `x` icon
|
||||
in the reviewer's chip token. Removing a reviewer also removes the
|
||||
current votes of the reviewer. The removal of votes is recorded as a
|
||||
message on the change.
|
||||
+
|
||||
Removing reviewers is protected by permissions:
|
||||
|
||||
** Users can always remove themselves.
|
||||
** The change owner may remove any zero or positive score.
|
||||
** Users with the link:access-control.html#category_remove_reviewer[
|
||||
Remove Reviewer] access right, the branch owner, the project owner
|
||||
and Gerrit administrators may remove anyone.
|
||||
|
||||
+
|
||||
image::images/user-review-ui-change-screen-change-info-reviewers.png[width=800, link="images/user-review-ui-change-screen-change-info-reviewers.png"]
|
||||
|
||||
- Project / Branch / Topic:
|
||||
+
|
||||
The name of the project for which the change was done is displayed as a
|
||||
link to the link:user-dashboards.html#project-default-dashboard[default
|
||||
dashboard] of the project. If no default dashboard is defined, the link
|
||||
opens a list of open changes on the project.
|
||||
+
|
||||
Clicking on the settings icon on the right side navigates to the
|
||||
project administration screen.
|
||||
+
|
||||
The name of the destination branch is displayed as a link to a list
|
||||
with all changes on this branch that have the same status as the
|
||||
currently viewed change.
|
||||
+
|
||||
If a topic was assigned to the change it is displayed below the branch.
|
||||
By clicking on the edit icon the topic can be set. This requires the
|
||||
link:access-control.html#category_edit_topic_name[Edit Topic Name]
|
||||
access right. To be able to set a topic on a closed change, the
|
||||
`Edit Topic Name` must be assigned with the `force` flag.
|
||||
+
|
||||
image::images/user-review-ui-change-screen-change-info-project-branch-topic.png[width=800, link="images/user-review-ui-change-screen-change-info-project-branch-topic.png"]
|
||||
|
||||
- Submit Strategy:
|
||||
+
|
||||
The link:project-setup.html#submit_type[submit strategy] that will be
|
||||
used to submit the change. The submit strategy is only displayed for
|
||||
open changes.
|
||||
+
|
||||
image::images/user-review-ui-change-screen-change-info-submit-strategy.png[width=800, link="images/user-review-ui-change-screen-change-info-submit-strategy.png"]
|
||||
+
|
||||
If a change cannot be merged due to path conflicts this is highlighted
|
||||
by a bold red `Cannot Merge` label.
|
||||
+
|
||||
image::images/user-review-ui-change-screen-change-info-cannot-merge.png[width=800, link="images/user-review-ui-change-screen-change-info-cannot-merge.png"]
|
||||
|
||||
- Time of Last Update:
|
||||
+
|
||||
image::images/user-review-ui-change-screen-change-info-last-update.png[width=800, link="images/user-review-ui-change-screen-change-info-last-update.png"]
|
||||
|
||||
- Actions:
|
||||
+
|
||||
Depending on the change state and the permissions of the user, different
|
||||
actions are available on the change:
|
||||
|
||||
** `Merge Change`:
|
||||
+
|
||||
Submits the change and adds it to the merge queue. If possible the
|
||||
change is merged into the destination branch.
|
||||
+
|
||||
The `Merge Change` button is available if the change is submittable and
|
||||
the link:access-control.html#category_submit[Submit] access right is
|
||||
assigned.
|
||||
+
|
||||
It is also possible to submit changes that have merge conflicts. This
|
||||
allows to do the conflict resolution for a change series in a single
|
||||
merge commit and submit the changes in reverse order.
|
||||
|
||||
** `Abandon`:
|
||||
+
|
||||
Abandons the change.
|
||||
+
|
||||
The `Abandon` button is only available if the change is open and the
|
||||
link:access-control.html#category_abandon[Abandon] access right is
|
||||
assigned.
|
||||
+
|
||||
When a change is abandoned, a panel appears that allows one to type a
|
||||
comment message to explain why the change is being abandoned.
|
||||
|
||||
** `Restore`:
|
||||
+
|
||||
Restores the change.
|
||||
+
|
||||
The `Restore` button is only available if the change is abandoned and
|
||||
the link:access-control.html#category_abandon[Abandon] and the
|
||||
link:access-control.html#category_push[Push] access right is
|
||||
assigned.
|
||||
+
|
||||
When a change is restored, a panel appears that allows one to type a
|
||||
comment message to explain why the change is being restored.
|
||||
|
||||
** `Rebase`:
|
||||
+
|
||||
Rebases the change. The rebase is always done with content merge
|
||||
enabled. If the rebase is successful a new patch set with the rebased
|
||||
commit is created. If the rebase fails, there are conflicts that have
|
||||
to be resolved manually.
|
||||
+
|
||||
If the change does not depend on another open change, it is rebased
|
||||
onto the tip of the destination branch.
|
||||
+
|
||||
If the change depends on another open change, it is rebased onto the
|
||||
current patch set of that other change.
|
||||
+
|
||||
The `Rebase` button is only available if the change can be rebased and
|
||||
the link:access-control.html#category_rebase[Rebase] access right is
|
||||
assigned. Rebasing merge commits is not supported.
|
||||
|
||||
** `Cherry-Pick`:
|
||||
+
|
||||
Allows to cherry-pick the change to another branch. The destination
|
||||
branch can be selected from a dialog. Cherry-picking a change creates a
|
||||
new open change on the selected destination branch.
|
||||
+
|
||||
It is also possible to cherry-pick a change to the same branch. This is
|
||||
effectively the same as rebasing it to the current tip of the
|
||||
destination branch. This can be used to remove dependencies on other
|
||||
open changes.
|
||||
+
|
||||
Users can only cherry-pick changes to branches for which they are
|
||||
allowed to upload changes for review.
|
||||
|
||||
** `Publish`:
|
||||
+
|
||||
Publishes the currently viewed draft patch set. If this is the first
|
||||
patch set of a change that is published, the change will be published
|
||||
as well.
|
||||
+
|
||||
The `Publish` button is only available if a draft patch set is viewed
|
||||
and the user is the change owner or has the
|
||||
link:access-control.html#category_publish_drafts[Publish Drafts] access
|
||||
right assigned.
|
||||
|
||||
** `Delete Change` / `Delete Revision`:
|
||||
+
|
||||
Deletes the draft change / the currently viewed draft patch set.
|
||||
+
|
||||
The `Delete Change` / `Delete Revision` buttons are only available if a
|
||||
draft patch set is viewed and the user is the change owner or has the
|
||||
link:access-control.html#category_delete_drafts[Delete Drafts] access
|
||||
right assigned.
|
||||
|
||||
** Further actions may be available if plugins are installed.
|
||||
|
||||
+
|
||||
image::images/user-review-ui-change-screen-change-info-actions.png[width=800, link="images/user-review-ui-change-screen-change-info-actions.png"]
|
||||
|
||||
- Labels & Votes:
|
||||
+
|
||||
Approving votes are colored green; veto votes are colored red.
|
||||
+
|
||||
image::images/user-review-ui-change-screen-change-info-labels.png[width=800, link="images/user-review-ui-change-screen-change-info-labels.png"]
|
||||
|
||||
[[old-change-screen]]
|
||||
=== Old Change Screen
|
||||
|
||||
|