Contrib.social

Be consistent in how entity collection listing permissions are labeled in the permissions UI

Open on Drupal.org →
Created on 19 June 2024, 3 months ago
Updated 2 July 2024, 2 months ago

Problem/Motivation

Discovered while working on 🐛 BlockContentAccessControlHandler requires access block library permission for create Needs review . Standard includes the following entity collection listing permissions (by UI label):

  • Access the Content blocks overview page (description: "Get an overview of all content blocks.")
  • Access the Files overview page (no description)
  • Access the Content overview page (no description)
  • Access the taxonomy vocabulary overview page (description: "Get an overview of all taxonomy vocabularies.")
  • Access media overview (description: "Users with this permission can access the media overview page.")

Several issues:

  1. The descriptions that some of these permissions have are redundant with the information already present in the permission label.

  2. We have a mix of lowercase and Sentence case labeling for the entity types in their respective permissions. It looks particularly weird for the Access the Content blocks overview page permission, since it looks like a "blocks overview page" for "Content" (nodes), rather than an "overview page" for "Content Blocks" (as provided by the block_content module).

  3. There is a mix of singular and plural.

  4. The media label is not a complete phrase.

Proposed resolution

  1. Remove the redundant descriptions for usability.

  2. Standardize on labeling the entity types with lowercase, since they are not proper nouns. E.g.: "the Content Blocks module" is a proper noun, but "a content block" is just a particular kind of content.

    The page title of admin/content/blocks is also "Content blocks"; however, if we are referring to the page title, it should be in italics or quoted. (Adding quotes or italics would be an alternate solution, but might need to be implemented programmatically instead of in the permission YAML, and I think lowercasing is preferable and easier to understand anyway.)

  3. Standardize on the singular, since that is more natural in a sentence when we are not referring specifically to a page title (as per point 2 above).

  4. Make the media overview permission description a complete phrase in accordance with our content guidelines.

Remaining tasks

TBD

The CR and release note for 🐛 BlockContentAccessControlHandler requires access block library permission for create Needs review should be updated if both issues land before 11.1.0.

User interface changes

Entity listing permissions no longer have redundant descriptions and have typographically consistent labels.

API changes

None.

Data model changes

None.

Release notes snippet

Not needed.

📌 Task
Status

Needs work

Version

11.0 🔥

Component
Other  →

Last updated about 7 hours ago

Created by

🇺🇸United States xjm

Live updates comments and jobs are added and updated live.
  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024