Add a section to the docs about automated code review.

Review Request #9328 — Created Oct. 25, 2017 and submitted

Information

Review Board
release-3.0.x
c598243...

Reviewers

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"

chipx86chipx86

Might be nice to have a new directory for automated code review topics, since reviews/ is getting pretty big. Can …

chipx86chipx86

Can we use :term: for "CI" and add an item to the glossary.rst?

chipx86chipx86

Section titles are in Title Case. Here and below.

chipx86chipx86

This can be moved to the top section, since automated review is (officially) new in this release.

chipx86chipx86

Maybe spell out "a review listing issues that need to be fixed".

chipx86chipx86
chipx86
  1. 
      
  2. Show all issues

    Typo in the description: "intregrations"

  3. docs/manual/users/index.rst (Diff revision 1)
     
     
    Show all issues

    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.

    1. I think this makes sense later on, but for now there's only the one page. The docs related to CircleCI and Travis CI live in the integrations section, and there's currently nothing for Review Bot.

  4. Show all issues

    Can we use :term: for "CI" and add an item to the glossary.rst?

  5. Show all issues

    Section titles are in Title Case. Here and below.

  6. Show all issues

    This can be moved to the top section, since automated review is (officially) new in this release.

  7. Show all issues

    Maybe spell out "a review listing issues that need to be fixed".

  8. 
      
david
chipx86
  1. Ship It!
  2. 
      
david
Review request changed
Status:
Completed
Change Summary:
Pushed to release-3.0.x (ca36abc)