Background:
This issue is part of the meta-issue for updating the hook_help texts of the Drupal 8 modules:
#1908570: [meta] Update or create hook_help() texts for D8 core modules

Tasks:
- review / write the hook_help text according to help guidelines http://drupal.org/node/632280
More details are on the meta-issue.

Files: 
CommentFileSizeAuthor
#20 hook_help_user_module-2103043-20.patch6.18 KBJiriK
PASSED: [[SimpleTest]]: [MySQL] 63,662 pass(es).
[ View ]
#20 interdiff-2103043-15-20.txt4.58 KBJiriK
#16 hook_help_user_module-2103043-15.patch6.17 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 59,539 pass(es).
[ View ]
#16 interdiff.txt4.74 KBbatigolix
#12 interdiff.txt6.36 KBbatigolix
#12 hook_help_user_module-2103043-12.patch6.22 KBbatigolix
FAILED: [[SimpleTest]]: [MySQL] 59,229 pass(es), 0 fail(s), and 4 exception(s).
[ View ]
#6 drupal8-updated-roleshelp-2103043-6.patch5.24 KBSree
PASSED: [[SimpleTest]]: [MySQL] 59,101 pass(es).
[ View ]
#4 drupal-updated-roles-2103043-4.patch7.65 KBSree
PASSED: [[SimpleTest]]: [MySQL] 58,695 pass(es).
[ View ]
#3 drupal-updated-roles-2103043-3.patch4.56 KBSree
PASSED: [[SimpleTest]]: [MySQL] 58,411 pass(es).
[ View ]

Comments

Component:user.module» documentation

component

Assigned:Unassigned» Sree

Missing doc on many updated features ... update is needed.

Assigning ....

Also, should I update the corresponding doc page on drupal.org for drupal8 with the updated details?

StatusFileSize
new4.56 KB
PASSED: [[SimpleTest]]: [MySQL] 58,411 pass(es).
[ View ]

Updated about default roles

Status:Active» Needs review
StatusFileSize
new7.65 KB
PASSED: [[SimpleTest]]: [MySQL] 58,695 pass(es).
[ View ]

Updated default roles, bulk operations

Status:Needs review» Needs work

The patch file in #4 has two sections for the user module... weird. Can you make a new patch with just one copy of your intended changes? I wasn't sure which section to review.

Status:Needs work» Needs review
StatusFileSize
new5.24 KB
PASSED: [[SimpleTest]]: [MySQL] 59,101 pass(es).
[ View ]

There was some weird issue with my git ... here is the latest patch which has updated help on user roles

Thanks for the patch. I'm still catching up from the Sprint in Prague...

Some comments:
1) User roles and permissions are explained in detail as an item under issues. Therefore it can be shorter in the About section, and we can get rid of the bracktes that way. May something like as short as
"It also allows users with appropriate permissions to manage user roles and permissions."

2) The link to the online documentation should follow the wording in the Help Text Standard: https://drupal.org/node/632280

3) "Creating users": Maybe instead of saying "If allowed" - add a link to the Account settings page, and phrase it something like:
If the registration settings on the <link>Account settings page</link> allow vistors to create their own account, then ...

4) User roles: There are now is "administrator" as a third role. How about: "Typically there are three pre-defined roles". Explaining them, and then just explain how to add new roles, and that you then can grant additional permissions.
The roles page is not actually in the admin menu, so maybe we need to say that this is part of the People page?

5) Maybe split user roles and permissions, because that's getting a bit long? It needs mentioning that any new role automatically has all the permissions of the authenticated user.

6) Account settings: Maybe the whole issue of Email texts should be moved to a seperate item? The emails are not only for the registration, but also for requesting new passwords, or when an account gets blocked or deleted. Plus the use of the variables in the text might need mentioning.

7) The links need to be changed according to the new routing format, as explained on at https://drupal.org/node/632280

Status:Needs review» Needs work

status update as per #7

#7: Thanks for the detailed review with comments. I ll work on the suggested updates & would submit another patch.

Assigned:Sree» Unassigned

Assigned:Unassigned» batigolix
Issue summary:View changes

Status:Needs work» Needs review
StatusFileSize
new6.22 KB
FAILED: [[SimpleTest]]: [MySQL] 59,229 pass(es), 0 fail(s), and 4 exception(s).
[ View ]
new6.36 KB

The attached patch addresses point 1) to 7) of comment #7

I didnt split up the Account settings section as suggested in 6) of #7

I added a section about managing User fields , as this was missing.
It is a bit experimental as this is the first entity type that mentions this option (?)
So please review in such way that it can be re-used in hook_helps for taxonomy, custom block etc

Status:Needs review» Needs work

Thanks, this is looking pretty good!

There are a few problems with this patch:

a) In the first Uses bullet, there is a URL that isn't actually mentioned in the text and can be removed (@account-settings).

b) In the first Uses bullet, please avoid saying "his". Make it more generic, like "the".

c) Drupal text standards require serial commas, so "user name, account blah blah blah, and password" (requires comma before "and").

d) Unfortunately our standard requires we write "e-mail" not "email". Also, "e-mails" is incorrect, as "mail" and "e-mail" are not countable nouns. Say "e-mail messages".

e) Punctuation:
"By adding fields for e.g., a picture, a biography or address you can a create a custom profile for the users of the website."
should be
"By adding fields for e.g., a picture, a biography, or address, you can a create a custom profile for the users of the website."

f) I think a better heading for "Managing user profile" would be "Managing user fields". I think the text there is pretty good, but it should probably say that user accounts are "an entity type" rather than being plural "entity types". The other modules that allow fields, such as Node, just link to the field module and don't say much, but it's a lot more complicated there because the fields are on individual content types.

The last submitted patch, 12: hook_help_user_module-2103043-12.patch, failed testing.

Patch adresses points a) - f) from #13

I used "Managing user account fields" isntead of the suggested "Managing user fields" as a header

Status:Needs work» Needs review
StatusFileSize
new4.74 KB
new6.17 KB
PASSED: [[SimpleTest]]: [MySQL] 59,539 pass(es).
[ View ]

Patch addresses a) - f) from #13

For f) I chose "Managing user account fields" as a header

Issue tags:+Needs manual testing

I think this is great! We probably need someone to manually test it:
- Make sure all the links work
- Make sure the formatting is OK
- Verify that wherever specific pages, buttons, tab titles, etc. are mentioned, they match what you would see in the user interface.

Assigned:batigolix» Unassigned
Issue tags:+Novice

Status:Needs review» Needs work

I did a manual test of this patch today. It all looks great except a few typographical issues:

a) Uses / Creating and Managing - paragraph does not end in ".".

b) Uses / User roles - the three roles that are set up for me by the Standard profile are actually capitalized. "Anonymous user", "Authenticated user", and "Administrator".

c) Same paragraph: needs a comma before "and Administrator".

d) Uses / Account settings:
"...whenever a module is enabled.), personal contact forms..." ==> no . before the ) here

Status:Needs work» Needs review
StatusFileSize
new4.58 KB
new6.18 KB
PASSED: [[SimpleTest]]: [MySQL] 63,662 pass(es).
[ View ]

My first novice try, hope I did it correctly...

Patch addresses a) - d) from #19

Status:Needs review» Reviewed & tested by the community

Great, thanks!

Nice work.

A patch on an issue tagged "avoid commit conflicts" touches user.module: #1996238: Replace hook_library_info() by *.libraries.yml file

So I'm being extra-careful and will wait to commit this until that other issue is finished.

Status:Reviewed & tested by the community» Fixed
Issue tags:-Needs manual testing

I've been given leave from sun (the owner of that other issue/patch) to go ahead with commits on this file, so I've committed this to 8.x.

Thanks everyone!

Status:Fixed» Closed (fixed)

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