Flesh out the front page of the Administration Guide.

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

Information

Review Board
release-2.5.x
a59fc32...

Reviewers

This change follows up on the Users Guide improvements, fleshing out the
content of the front page of the Administration Guide. This walks admins
through the installation and upgrade steps, and groups the various
settings and configuration steps needed to get started.

Future changes may flesh some of this out more, but for now, it's a much
better experience for new admins, and even old ones trying to locate
something they need to look up.

The plan later on is to add a new section on guides for common setups
(like setting up GitHub, Bitbucket, etc.).

Built the docs and read through them.


Description From Last Updated

Typo: "MysQL"

daviddavid

I think repositories should come before review groups.

daviddavid
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
    
    
  2. 
      
david
  1. 
      
  2. docs/manual/admin/index.rst (Diff revision 1)
     
     
    Show all issues

    Typo: "MysQL"

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

    I think repositories should come before review groups.

    1. I put it there just because review groups are a configuration option in repositories, for access control. I'm open to changing that, though.

    2. I think that for most people, connecting the repository is the first major step towards getting things set up, and will likely happen before they add any other users, much less groups. We talk about access control for everything just under this.

  4. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
    
    
  2. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.5.x (77303b1)
Loading...