Follow up from #1924996: Fix error and improve on module descriptor text for the Extend page
Several modules reference 'administrators' in their description:
Ban
Allows administrators to ban visits from specific IP addresses.
Configuration Manager
Allows administrators to import and export configuration changes.
Menu UI
Allows administrators to customize the site navigation menu.
System
Handles general site configuration for administrators.But it's up to site owners which users can do what, so we shouldn't reference specific roles in the module descriptions. Menu UI is a clear example of functionality that non-admins would often be able to use.
Update the descriptions to remove references to administrators. Possibly review other module descriptions to see if they could be improved?
N/A
N/A
N/A
N/A
| Comment | File | Size | Author |
|---|---|---|---|
| #20 | 3223179-20.patch | 862 bytes | _utsavsharma |
| #18 | descriptions-3223179-18.patch | 1.74 KB | chandravilas |
| #10 | interdiff_4-7.txt | 452 bytes | anul |
| #7 | 3223179-7.patch | 1.75 KB | larsmw |
| #6 | Screenshot from 2021-07-19 16-27-03.png | 222.33 KB | dhirendra.mishra |
Comments
Comment #2
cilefen commentedI would look to other core modules for a template but my instinct is to use gerunds, for example, “Allows banning visits from specific IP addresses” and so on.
Comment #3
pameeela commentedMinor updates to IS for clarity.
Comment #4
imalabyaAdded a patch to update the descriptions
Comment #5
rinku jacob 13 commentedGetting error while applying patch #4 for drupal 9.3.x-dev. Adding screenshot for the reference.
Comment #6
dhirendra.mishra commentedI can confirm that #4 works fine for me..We can go ahead with this.
Comment #7
larsmw commentedCorrected wording of text.
Comment #8
larsmw commentedI have reviewed all module descriptions in core and added a minor correction in the previous comment. This is ready to be committed.
Comment #9
catchThe changes look good to me - more flexible and also, shorter.
@larsmw thanks for fixing the patch, however without an interdiff it's hard to see what the changes are, and we discourage RTBC-ing ones own patches (although if it's a very minor typo change it might be OK with the interdiff).
Comment #10
anul commentedHi Nathaniel,
I am attaching the 'interdiff' file for the difference of #4 and #7 patch here to move this one ahead.
Also I tested 3223179-7.patch on my end. This patch looks great to me.
We are good to move this to RTBC.
Thanks
Anul
Comment #11
eojthebraveThis is a great change. Thanks everyone for working on it. Moving to RTBC.
Comment #12
catchThis conflicts with #3060616: Update the module descriptions on the Extend page to fit the Help texts. Not 100% sure how to resolve it, but cross-linking for now.
Comment #13
mradcliffeI am removing the Novice tag from this issue because there are further Novice tasks to be done on the issue.
Comment #14
eojthebraveIt looks like #3060616: Update the module descriptions on the Extend page to fit the Help texts includes new text for system module, and menu module that removes the word "administrator". It's not the exact same text as here, but it does resolve the issue here of removing the word "administrator" from the the description.
This patch system module:
'Handles general site configuration.'
Other patch:
"Provides user interfaces for core systems."
This patch menu ui module:
'Allows customizing the site navigation menu.'
Other patch:
'Provides a user interface for managing menus.'
That leaves the updated text for Ban, and Configuration Manager module's in this issue. It might be easiest to try and roll that text into the patch in #3060616: Update the module descriptions on the Extend page to fit the Help texts. But if that doesn't happen we can update the patch here to change the text for just the Ban and Configuration Manager modules and it won't conflict with the other issue anymore.
Comment #18
chandravilasComment #19
chandravilasComment #20
_utsavsharma commentedComment #21
pameeela commentedThese were all addressed in #3060616: Update the module descriptions on the Extend page to fit the Help texts so this can be closed.