Changes between Version 1 and Version 2 of PeerReviewPlugin/ChangesetReview

Timestamp:

Apr 29, 2021, 10:14:17 AM (3 years ago)

Author:

Cinc-th

Comment:

Added changeset review tutorial

PeerReviewPlugin/ChangesetReview

@@ -5 +5 @@
 The review may be done either on the changeset page or using the dedicated review pages provided by the plugin.
 
+== Creating the review
+A new section is inserted into the changeset page when the current user has sufficient permissions to create a review.
 
+After selecting users it is possible to create the new review. 
+
+{{{#!box width=500
+==== Creating a new review
+[[Image(codereview_changeset_create.png, width=480, border=2)]]
+}}}
+
+== Review details
+Details about the review are shown in the **overview** section of the changeset page. There is a direkt link to open the review page.
+
+{{{#!box width=500
+==== Review information
+[[Image(codereview_changeset_info.png, width=480, border=2)]]
+}}}
+
+== Perform the Review
+It's not necessary to leave the changeset page to perform a review. Every line number of the source file view is a link which opens a dialog to add a comment.
+ 
+{{{#!box width=500
+==== Commenting on a source line
+[[Image(codereview_create_comment_inline.png, width=480, border=2)]]
+}}}
+
+It is possible to reply to existing comments. The user may chose the presentation of the file view, either {{{inline}}} or {{{side by side}}}.
+
+{{{#!box width=500
+==== Comment tree in {{{side by side}}} view
+[[Image(codereview_comment_tree.png, width=480, border=2)]] 
+}}}
+
+== Notes
+* Files which were added or moved with this changeset are only shown as links in the overview section. A file view is not available. Such files must be reviewed using the {{{Code Review}}} page provided by the plugin.
+* You can't add user groups to a review. This means, you can't grant code review permissions to e.g. {{{anonymous}}}. This is a known limitation (see also #12782).
+* To use more advanced features like [../Workflows review workflows] you have to open the review page.