flake8
passed.
JSHint
passed.
Add a section to the docs about automated code review.
Review Request #9328 — Created Oct. 25, 2017 and submitted
This currently has a quick description of what status updates are
(including a screenshot of some Review Bot output), and links to the
docs for the CircleCI and Travis CI integrations. In the future we'll
also be able to add docs for Review Bot here.
Built HTML and checked the output.
| Description | From | Last Updated |
|---|---|---|
|
Typo in the description: "intregrations" |
 chipx86
|
|
|
Might be nice to have a new directory for automated code review topics, since reviews/ is getting pretty big. Can … |
chipx86
|
|
|
Can we use :term: for "CI" and add an item to the glossary.rst? |
chipx86
|
|
|
Section titles are in Title Case. Here and below. |
chipx86
|
|
|
This can be moved to the top section, since automated review is (officially) new in this release. |
chipx86
|
|
|
Maybe spell out "a review listing issues that need to be fixed". |
chipx86
|
-
-
-
docs/manual/users/index.rst (Diff revision 1) Might be nice to have a new directory for automated code review topics, since
reviews/is getting pretty big.Can we also make a top-level section in the index doc for anything for automated review? Break it up into an Overview doc, CircleCI, Travis-CI, Review Bot? My goal with the index doc rewrite from a while back is to keep topics shallow so someone looking for a topic can find it more easily without digging into too many levels.
-
docs/manual/users/reviews/automated-review.rst (Diff revision 1) Can we use
:term:for "CI" and add an item to theglossary.rst? -
docs/manual/users/reviews/automated-review.rst (Diff revision 1) Section titles are in Title Case. Here and below.
-
docs/manual/users/reviews/automated-review.rst (Diff revision 1) This can be moved to the top section, since automated review is (officially) new in this release.
-
docs/manual/users/reviews/automated-review.rst (Diff revision 1) Maybe spell out "a review listing issues that need to be fixed".
Description: |
|
|||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Commit: |
|
|||||||||||||||
Diff: |
Revision 2 (+56) |
Checks run (2 succeeded)
flake8
passed.
JSHint
passed.