Reword authentication-settings.rst Description

Review Request #6894 — Created Feb. 3, 2015 and submitted

Information

Review Board
master
398bcc8...

Reviewers

When the user want to read the manuals, they build their manuals file authentication-settings.html and find out that the description about authentication settings dosent't tell them what to do if they can't login successfully.

I have add extra lines in the authentication-settings.rst file, and after the user build the manuals, and if they can't login successfully, they will know what to do through from the authentication-settings.html file.

I've build the manual docs using make html and get the _build/html/admin/configuration/authentication-settings.html and the format of the html file looks just good to me.

Description From Last Updated

Undo this change.

brenniebrennie

This line is too long. Lines for .rst files are limited to 79 characters in width.

brenniebrennie

This change still needs to be reverted.

mike_conleymike_conley

Should be "fully qualified name"

daviddavid

typo: "fullly" -> "fully"

mike_conleymike_conley

Please remove this added line.

daviddavid

We generally avoid using "please" in the manual. How about "If you can't login, you may need to use the …

daviddavid
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
  2. 
      
SE
brennie
  1. Please remove the issue number from the description and add it to the bugs field. It will be automatically added when the patch is landed. Also please add the students group.

    In addition, please read through https://www.reviewboard.org/docs/codebase/dev/writing-good-descriptions/ and update the description and summary.

  2. Show all issues

    Undo this change.

  3. Show all issues

    This line is too long. Lines for .rst files are limited to 79 characters in width.

  4. 
      
SE
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
  2. 
      
SE
brennie
  1. For the bugs field, we don't need the # mark, just 3636 will suffice. We also don't need the easyFix label in there, either

  2. 
      
SE
mike_conley
  1. Hey Sean,

    You have several open issues on this review request - you can see them in yellow just below the review request details. You're likely not getting additional reviews because you still have open issues that haven't been marked Fixed or Dropped.

    Please go through your open issues and mark them accordingly.

    Also, please read this document on writing good change descriptions. Please also add any testing you've done (when making a documentation change, we expect you to build the documentation to make sure your changes look right. Building the docs can be done by running:

    make html
    

    inside docs/manual).

  2. Show all issues

    This change still needs to be reverted.

  3. 
      
SE
david
  1. 
      
  2. Show all issues

    Should be "fully qualified name"

  3. 
      
SE
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
  2. 
      
mike_conley
  1. 
      
  2. Show all issues

    typo: "fullly" -> "fully"

  3. 
      
SE
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
  2. 
      
david
  1. 
      
  2. Show all issues

    Please remove this added line.

  3. Show all issues

    We generally avoid using "please" in the manual. How about "If you can't login, you may need to use the fully qualified domain name"?

  4. 
      
SE
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/manual/admin/configuration/authentication-settings.rst
    
    
  2. 
      
david
  1. Ship It!
  2. 
      
SE
Review request changed
Status:
Completed
Change Summary:
Pushed to release-2.0.x (11f50bc)