Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Problem/Motivation
Currently the module menu description says "Configure Public service announcement notifications". This module does more than that now.
Proposed resolution
Update module menu description to better reflect current capabilities.
Remaining tasks
User interface changes
n/a
API changes
n/a
Data model changes
n/a
Release notes snippet
n/a
Comment | File | Size | Author |
---|---|---|---|
#17 | 3093967-17.patch | 515 bytes | heddn |
|
Comments
Comment #2
WebbehComment #3
WebbehTaking a first stab at this, and glancing at the System-similar menu descriptions, it looks like there's two broad routes to take:
Provide a high-level overview of settings sections
This would be similar to Basic site settings describing the options and settings available:
Provide a broad, generic descriptor of settings
This would be similar to Cron in describing the configuration page at a very high-level:
Comment #4
WebbehAn easy solution would be to approach the latter format first as a broad, generic setting descriptor, such as:
Comment #5
heddnI'll let you take a full hand at what you think is best here. I'm not an expert at UX. Nor do I claim to be one. I like where you are going with your ideas.
Comment #6
WebbehAttaching the associated patch meeting #4.
Comment #7
rkollerI like the suggested descriptor also much better. One related question I am uncertain about. Isn't "Automatic Updates" the modules name. Wouldn't it make sense to make it upper case instead of lower case since it is a name? I ask cuz it relates to https://www.drupal.org/project/automatic_updates/issues/3093866 . There I've used the upper case variant and also plural like the modules name. Should be at least consistent inside the module or even better consistent to the general norm in Drupal (I am not savvy if there are any style and naming conventions in place?).
Comment #8
WebbehPer #7, the only experience I've had with casing is some work I've done for Layout Builder Styles. For that module, the suggestion was to keep first word first letter capitalization casing.
I am unaware of any broader best practices on this, as I do see from contrib space that casing is not standardized across modules and administrative menu items.
Comment #9
heddnI can't quote any specific reference, but the general feedback I have gotten over time is to:
Comment #10
rkollerOh I see. Well the general best practice (for Core and Contrib) is out of the scope of the issue here I suppose but might be reasonable to investigate at a later point somewhere else imho. But at least the strings should be consistent within the Automatic updates module. Then may I suggest to alter the patch to
So the first letter of the module name is upper case and the "s" for updates of the module is added?
Comment #11
WebbehPer, #10, I'm embarrassed to say I was focused on the label and not the description text casing. I believe guidance for that follows #8 and #9, at least from the few examples I saw in core on descriptions versus link labels.
My strategy was not to repeat the module name in the description, since I feel it defeats the point of a description in describing the administrative menu title by repeating it. I compared this to defining a term using the said term, which wouldn't be helpful for anyone!
So, the usage of 'automatic update' there was intended to be broad and not pertaining to the module name.
Comment #12
rkolleruhhhh sorry then! I understood automatic update was the repeated module name! then the string is totally fine. So I will only adjust the string in the issue opened up by me and adjust it there that it is consistent with yours here. :)
Comment #13
heddnHere, I've reworded it a little more. I don't want to have to update things later when the experimental section gets renamed. So let's just drop that part. What do you think?
Comment #15
heddnPushed to 8.x. Needs backport to 7.x.
Comment #16
heddnComment #17
heddnComment #19
heddn