Flesh out the front page of the Users Guide.

Review Request #8484 — Created Oct. 24, 2016 and submitted

Information

Review Board
release-2.5.x
3799680...

Reviewers

Our Review Board manuals have started out with just a plain Table of
Contents, with no introduction or real flow to the rest of the
documentation. This could be frustrating for new users.

This change is the first in a series that aims to modernize our
documentation, guiding users through getting going and pointing them to
more useful content without having to dig or search.

The new front page contains actual content, guiding the user through the
main pieces of the product, and grouping these pieces into digestable
sections.

The content on the pages linked from the main page haven't changed (with
the exception of some pages gaining an :orphan: tag to prevent Sphinx
errors when building). Edits will probably be coming to some of that
pages as I go.

Built the docs and went through them. Didn't see any new errors.


reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/manual/users/reviews/index.rst
        docs/manual/glossary.rst
        docs/manual/users/index.rst
        docs/manual/users/tools/post-review.rst
        docs/manual/users/tools/index.rst
        docs/manual/index.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/users/reviews/index.rst
        docs/manual/glossary.rst
        docs/manual/users/index.rst
        docs/manual/users/tools/post-review.rst
        docs/manual/users/tools/index.rst
        docs/manual/index.rst
    
    
  2. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.5.x (4a4ba30)
Loading...