Role Descriptions

cweagans - July 4, 2009 - 08:49
Project:Drupal
Version:7.x-dev
Component:user system
Category:feature request
Priority:normal
Assigned:cweagans
Status:duplicate
Issue tags:#d7ux, Usability
Description

Because of #480660, the text at /admin/user/roles is now stale. Currently reads:

By default, Drupal comes with two user roles:

* Anonymous user: this role is used for users that don't have a user account or that are not authenticated.
* Authenticated user: this role is automatically granted to all logged in users.

I propose this new text as a replacement:

By default, Drupal comes with three user roles:

* Anonymous user: this role is used for users that don't have a user account or that are not authenticated.
* Authenticated user: this role is automatically granted to all logged in users.
* Administrator: this role grants all permissions and should be used for trusted users only.

I did not include a patch, as the wording will invariably be worked on/modified.

#1

Bojhan - July 4, 2009 - 23:02

Can you give a screenshot, so we can easily review.

#2

keith.smith - July 4, 2009 - 23:52
Status:active» needs review

Starter patch attached. I didn't have time to test (nor make screen shots) so I have no idea whether it even works. I'm bad about getting my quotation marks mixed up, but I'll let the bot test.

All the text there needed a bit of refresh, IMO. I also got rid of some -- IMO -- worthless "example" text, and banished the tags to outside the text like its neighbors.

AttachmentSize
509970.patch 3.14 KB
Testbed results
509970.patchpassedPassed: 11562 passes, 0 fails, 0 exceptions Detailed results

#3

cweagans - July 5, 2009 - 01:02

Updated the patch. You forgot to 'return $output' at the end of that block of code.

Patch and images attached.

AttachmentSize
509970_2.patch 3.12 KB
before.png 67.05 KB
after.png 68.05 KB
Testbed results
509970_2.patchpassedPassed: 11562 passes, 0 fails, 0 exceptions Detailed results

#4

tobiasb - July 5, 2009 - 08:18
Status:needs review» reviewed & tested by the community

#5

Bojhan - July 5, 2009 - 11:24
Status:reviewed & tested by the community» needs review

I am wondering whether this shouldn't just be in the help text of Roles?

#6

keith.smith - July 5, 2009 - 15:51
Status:needs review» needs work

Oops. I also misnamed the "administrator" role.

#7

cweagans - July 6, 2009 - 04:43

Fixed the name of the administrator role.

@Bojhan, it is in the help text of roles..

AttachmentSize
509970_3.patch 3.11 KB
Testbed results
509970_3.patchpassedPassed: 11562 passes, 0 fails, 0 exceptions Detailed results

#8

cweagans - July 6, 2009 - 04:45
Status:needs work» needs review

#9

Bojhan - July 6, 2009 - 10:49

No as in, not on that page, but on a separate help page. It seems to be taking a lot of screen real estate. And after reading it once its useless.

#10

cweagans - July 6, 2009 - 22:36

I agree with you, but in another issue.

Let's just fix the text and then open another issue that can move the text around and make it a little more logical. We can tag that one with d7ux or usability or whatever the current tag is and it'll get some attention that way.

Here's an updated patch that removes the <em&rt; tags that were around the role names.

AttachmentSize
509970_4.patch 3.09 KB
Testbed results
509970_4.patchpassedPassed: 11562 passes, 0 fails, 0 exceptions Detailed results

#11

Bojhan - July 6, 2009 - 23:20

@cweagans : Agreed, looks good to me. If keith is fine with it as well I will mark RTBC

#12

Dries - July 7, 2009 - 09:36

We can't hardcode that help text because the administrator role is only created as part of the default install profile, but not as part of the minimal install profile. Plus, as you can see on the roles administration page, the 'administrator' role can also be renamed or deleted.

I think this is a "won't fix", unless we make the patch a lot more generic and allow people to provide a description or explanation for custom role. That would require more extensive UI changes; i.e. below each role we could provide a description in small print like we did on the permissions administration page. We could then eliminate (rework) parts of the help texts. Could be a really nice clean-up.

#13

keith.smith - July 7, 2009 - 13:51
Status:needs review» needs work

Dries is spot on. We probably need to add a "description' to roles like we did for user permissions, and then in the help text on this page, just mention that a number of roles may be preinstalled by the installation profile.

#14

Bojhan - July 7, 2009 - 14:21

Ohh, no lets not add in functionality for descriptions. Sorry, but I'd rather just kill this text - then spend days working on a viable implementation of help text. I don't see many people not understanding what anonymous, autenticated user and administrator means.

#15

keith.smith - July 7, 2009 - 15:34

Bojhan:

  1. adding descriptions for roles is not that big of a paradigm shift, and follows right in line with what was done with permissions. A single line under a small number of roles is likely to be much less intrusive than the text on this page. That seems, to me, to be the absolutely most straightforward -- and helpful -- way to proceed.
  2. Removing help text is not the answer for all situations.
  3. We've all spent months and months on more viable implementations of help text. (See #299050: Help System - Master Patch.)
  4. Yes, these names are fairly self explanatory. But role names are user entered, and they may not all be as easy to grasp. What if someone created the role name of, for the sake of argument, "editor" and "editor - full". In that case, even if I created them, I might not remember two weeks later what the difference between them might be. Making a note to myself in a role description would seem like a good thing in this case.

#16

cweagans - July 7, 2009 - 17:15
Title:Text at /admin/user/roles needs description of admin role» Role Descriptions
Category:bug report» feature request
Status:needs work» active

Yeah, I'm with keith.smith and Dries on this one.

I'll start hacking on this and see if I can't come up with something decent.

#17

michaelfavia - July 7, 2009 - 17:57

I attacked this #393406: make roles admin look like content types previously.

I don't see many people not understanding what anonymous, autenticated user and administrator means.
This is way off the mark. We are trying to make these "default roles" for anonymous visitors and authenticated users configurable and the decsription WILL help distinguish them when that is the case.

#468768: Remove hardcoded anonymous and authenticated user roles is taking an interesting approach at this and i think it is a bit heavy handed. i would prefer just allowing users to edit the names and descriptions of the original roles as i had done in my patch. If we somehow attach the notification that this is the "authenticate user role" we have a real win win imo.

Keiths 4th pont is also key imo.

#18

cweagans - July 11, 2009 - 00:23
Status:active» duplicate

Yeah, +1 to descriptions, but it looks like you already have a good portion of this done in #393406: make roles admin look like content types, so I'll mark this as duplicate.

Lets make #393406: make roles admin look like content types happen -- big win for Drupal :)

 
 

Drupal is a registered trademark of Dries Buytaert.