The current documentation under the readme may not be clear enough. I'll write/complete it before getting the 1.0 out.

- Create a handbook page.
- Review the readme and reference the handbook where available.
- create advanced help files.

Before final publication I would like anyone natural english speaker make a quick review of it, as it's not my first laguange.

CommentFileSizeAuthor
#4 README.txt10.53 KBilo
#2 README.txt10.7 KBilo
#1 496448_documentation.patch15.14 KBilo

Comments

ilo’s picture

ilo commented
Status: Active » Needs review
StatusFileSize
new 496448_documentation.patch15.14 KB

I've just modified the readme. My idea is to include this as handbook page. It would be great if someone could just view or review my english.

ilo’s picture

ilo commented
StatusFileSize
new README.txt10.7 KB

Forget the patch, I just uploaded the whole readme.txt file for the review.

deekayen’s picture

deekayen commented
Status: Needs review » Needs work
  • It's not necessary to comment the $Id$ tag in a txt file with PHP syntax
  • Drupal and PHP should be capitalized IMO
  • deniying => denying
  • "Login Security" is the capitalization on the project page, so "Login security" should match
  • add comma: "With Login security, a site administrator"
  • add colon: "two options:"
  • lowercase t: "Request Time delay:"
  • the "On", "when", "It's", and "on" have different cases after the colons in the list. choose one.
  • remove really, it's a less professional adjective: "It's really common"
  • happend => happened
  • multiple cases of "Maximun" => Maximum
  • lowercase t: "Any host Trying to guess"
ilo’s picture

ilo commented
Status: Needs work » Needs review
StatusFileSize
new README.txt10.53 KB

Ok, I've fixed all of them. Thanks for the review deekayen. Should I commit or would you (or any one else) like to make another review? Included in this comment is the fixed txt version.

deekayen’s picture

deekayen commented
Status: Needs review » Reviewed & tested by the community

go ahead

ilo’s picture

ilo commented
Status: Reviewed & tested by the community » Fixed

Commited to head and d6.x-1.x-dev

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

  • ilo committed c15aec5 on 6.x-1.x, 8.x-1.x 
    #500358 fixed the variable %name to populate into watchdog messages #...