Reword authentication-settings.rst Description
Review Request #6894 — Created Feb. 3, 2015 and submitted
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.rstfile, and after the user build the manuals, and if they can't login successfully, they will know what to do through from theauthentication-settings.htmlfile.
I've build the manual docs using
make htmland get the_build/html/admin/configuration/authentication-settings.htmland the format of the html file looks just good to me.
| Description | From | Last Updated |
|---|---|---|
|
Undo this change. |
 brennie
|
|
|
This line is too long. Lines for .rst files are limited to 79 characters in width. |
brennie
|
|
|
This change still needs to be reverted. |
 mike_conley
|
|
|
Should be "fully qualified name" |
 david
|
|
|
typo: "fullly" -> "fully" |
mike_conley
|
|
|
Please remove this added line. |
david
|
|
|
We generally avoid using "please" in the manual. How about "If you can't login, you may need to use the … |
david
|
-
Please remove the issue number from the description and add it to the
bugsfield. It will be automatically added when the patch is landed. Also please add thestudentsgroup.In addition, please read through https://www.reviewboard.org/docs/codebase/dev/writing-good-descriptions/ and update the description and summary.
-
-
SE
- Description:
-
~ authentication-settings.rst description reword(easyFix bug #3636)
~ In the doc file authentication-settings.rst, the description here may not make it easy enough to understand how to do when we can't login successfully.
+ + Additional lines are added to make the description more easy to understand what to do if there's a login problem.
- Bugs:
-
#3636, easyFix
- Commit:
0e1a77bdb00f6421d1e74d2b2847c5d74cc567fa6357ab353e526079654d51e9241ddd592b2c534d
-
Tool: Pyflakes Ignored Files: docs/manual/admin/configuration/authentication-settings.rst Tool: PEP8 Style Checker Ignored Files: docs/manual/admin/configuration/authentication-settings.rst
-
For the
bugsfield, we don't need the#mark, just3636will suffice. We also don't need the easyFix label in there, either
SE
-
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 htmlinside docs/manual).
-
SE
- Description:
-
~ In the doc file authentication-settings.rst, the description here may not make it easy enough to understand how to do when we can't login successfully.
~ 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.
~ Additional lines are added to make the description more easy to understand what to do if there's a login problem.
~ I have add extra lines in the
authentication-settings.rstfile, and after the user build the manuals, and if they can't login successfully, they will know what to do through from theauthentication-settings.htmlfile. - Testing Done:
-
+ I've build the manual docs using
make htmland get the_build/html/admin/configuration/authentication-settings.htmland the format of the html file looks just good to me.
SE
- Change Summary:
-
Change some descriptions
- Commit:
-
6357ab353e526079654d51e9241ddd592b2c534d2098d39a4f6d56fb9c74fb0897f755968c25ccff
-
Tool: Pyflakes Ignored Files: docs/manual/admin/configuration/authentication-settings.rst Tool: PEP8 Style Checker Ignored Files: docs/manual/admin/configuration/authentication-settings.rst
SE
- Change Summary:
-
Changed a typo.
- Commit:
-
2098d39a4f6d56fb9c74fb0897f755968c25ccffa94509f3b469e8137dd1d79d2744b1014032873b
-
Tool: PEP8 Style Checker Ignored Files: docs/manual/admin/configuration/authentication-settings.rst Tool: Pyflakes Ignored Files: docs/manual/admin/configuration/authentication-settings.rst
Tool: Pyflakes Ignored Files: docs/manual/admin/configuration/authentication-settings.rst Tool: PEP8 Style Checker Ignored Files: docs/manual/admin/configuration/authentication-settings.rst