Problem/Motivation
The explanation texts on the Configuration page invite the user to do something, for example to manage or configure something.
Some of these texts don't follow the common format, as described in the Help text standard; others are not correct anymore for Drupal8, are somewhat convoluted or confusing, or don't give the user any additional information that isn't already given in the module name.
In some cases, extensive reviewing of the hook_help text of a module has come up with explanations of Uses that are more to the point then the existing link descriptions.
Proposed resolution
Change the descriptions in the *links.menu.yml files that they are correct, consistent, and follow a common format. Because these can result in more changes then what is easy to review, this should be split up into several issues of different priority but without possible conflicts
Remaining tasks
Update the link descriptions in the child issues.
User interface changes
This are UI text changes.
API changes
None.
Data model changes
None.
Beta phase evaluation
Issue category | Bug because the User interface was changed, but the help text was not changed accordingly |
---|---|
Issue priority | Minor |
Disruption | None |
Comment | File | Size | Author |
---|---|---|---|
#28 | drupal_core-module_description-2570997-28-D8.patch | 13.09 KB | snehi |
#26 | 2570997-module-description-configuration-page-26.patch | 12.66 KB | ifrik |
#26 | interdiff-24-26.txt | 0 bytes | ifrik |
#24 | 2570997-module-description-configuration-page-24.patch | 12.61 KB | ifrik |
#24 | interdiff-14-24.txt | 7.27 KB | ifrik |
Comments
Comment #2
ifrikComment #3
ifrikWorking on this during DrupalCon.
Comment #4
ifrikI've checked everything that is displayed on the Configuration page in a minimal install, but the rest still needs to be done.
Comment #5
snehi CreditAttribution: snehi as a volunteer and commentedComment #6
snehi CreditAttribution: snehi as a volunteer and commentedComment #7
snehi CreditAttribution: snehi commentedComment #8
DuaelFrComment #9
peterg.griffin CreditAttribution: peterg.griffin commentedIs this task still being worked on?
Comment #10
peterg.griffin CreditAttribution: peterg.griffin commentedComment #11
mairi CreditAttribution: mairi commentedI will pick this up (DrupalCon Barcelona 2015 mentored sprint - first time sprinter!) and see if I can do some more work on the patch.
Comment #12
mairi CreditAttribution: mairi commentedThis is the contributor task I *think* I'm doing!
https://www.drupal.org/node/2276597
The attached file lists the *links.menu.yml files that need to be reviewed and updated where required, identified using the following command:
find . -name "*links.menu.yml" -print | xargs grep "parent: system.admin_config" | awk -F: '{print $1}' | sort -u > 2570997-files_list.txt
All files listed are currently marked as TODO - I will update as DONE the ones that I get through today (including those that have already been picked up by ifrik).
ETA: working with Andrew Gleeson who has picked up related issue 2276599 and is also a first time sprinter
Comment #13
ifrikThanks Mairi,
that looks like a good way of structuring it.
Comment #14
mairi CreditAttribution: mairi at The University of Edinburgh commentedThis patch includes UI help text changes for files marked as STATUS = DONE and CHANGED = Y in the attached files list txt file. I have checked most, but not all, of these changes in a clean Drupal 8 install. In some cases I couldn't figure out where the description would appear in the interface.
First time sprinter, so hopefully I haven't changed anything I shouldn't have or made anything worse!
Comment #15
mairi CreditAttribution: mairi commentedComment #16
rachel_norfolkAttached a screenshot after #14 and the changes of help text to match standards do appear to have been applied.
Comment #17
rachel_norfolkI have also reviewed the code and the only items that are changed are the descriptions and they do all match the the help text standard.
Comment #18
rachel_norfolkAdding a beta evaluation.
Comment #19
ifrikThanks a lot Mairi for the patch and Rachel for the review and beta-evaluation.
All the changed texts look good.
There are a few more descriptions on the site that I would like to edit as well, such as the Ban module, so I re-open the issue, and I can work on that tomorrow during the Extended sprint.
Comment #20
ifrikNot sure how I changed the relationships with the previous comment...
Comment #23
ifrikWow... I managed to change a lot of issue meta data without intending to do so.
This should be correct now again
Comment #24
ifrikI've reviewed and changed some more of the texts: either because they were not quite correct anymore or less clear then they could be.
I've tried to keep wording consistent with the hook_help texts.
Comment #25
jhodgdonLooking pretty good! A few suggestions:
I think "add feeds" is misleading here -- it sounds like you would be *providing* a feed from your site.
The previous description did not have this problem of being possibly misleading.
I think you can also ban ranges of IP addresses with *, can't you? maybe not... this may be overly specific?
hm, really, configuration items? How about just
Translate site configuration
Could be shortened to
Configure image display styles
needs comma before "and"
Will people know what "internal paths" are?
assure is not right here.
paths? Really it's directories on the web server, I think?
hm. Does it really affect all feeds (created by Views for instance, which is now in core) or just some specific ones?
JS -> JavaScript
maybe remove "whether the site has a"?
comma before "and"
Comment #26
ifrikThanks for the review. This looks like we could have reviewed these description coming from D7 earlier :-)
1. I used "add" here because that is the action the user on the linked page. The previous formulation was really cumbersome. I tried to get around a possible misunderstanding by adding the "import OPMLs" as well.
2. I replaced "individual" by "specific" - that leaves the question whether you can ban visits for blocks a bit more open.
6. I used "internal" to make the it clear that it's only within the site, and different from linking to anything outside.
7. I've used the previous wording of "help you to assure".
9. This looks like a real legacy issue. The page only configures one feed - accessible at rss.xml - but actually this feed is created by feeds as well. (The UI text of this page should be checked and edited as well.)
11. I left the "a" infront of default time zone on purpose, because you can also set it not to have a default time zone.
Comment #27
jhodgdonCareful about assure/ensure:
http://www.quickanddirtytips.com/education/grammar/assure-versus-ensure-...
I think anything we do in the Drupal UI is about "ensure", not "assure", right?
Comment #28
snehi CreditAttribution: snehi at Publicis Sapient for Publicis Sapient commentedUpdating with spell check, suggestion from Jhodgdon, removing additional commas etc.
Please review.
Comment #29
Bojhan CreditAttribution: Bojhan as a volunteer commentedI am not convinced of almost 50% of these changes. Can we discuss this over IRC? This patch is almost to big to review.
Comment #30
jhodgdonMeanwhile, setting status...
Comment #31
snehi CreditAttribution: snehi at Publicis Sapient for Publicis Sapient commentedCan u suggest @Bojhan
Comment #32
ifrikSnehi,
just a short comment: can you in future leave the patch name as it is because otherwise it's difficult to know whether a new patch is just an edited version of an existing one or a completely new one, and can you also provide an interdiff, so that reviewers know what has been changed?
No need to do that now anymore because I'm just about to split the issue up, but good practice in future.
Comment #33
ifrikApparently I hit "Restore last input" at some stage, and it restored the last input from another issue that was open, so the issue summary got totally messed up, and I only fixed some of that previously.
I've now restored that and turned it into a meta issue that can be reviewed more easily.
Comment #34
ifrikI've split up the link descriptions in four issues depending on their priority, keeping all from the System module in one issue.
That should make it more easy to see why they were changed and to review them.
@snehi: I've put some of the commas back, because according to our style guide we need them.
Comment #35
jhodgdonUpdating this issue then.
So... Everyone who supplied a patch on this issue, you might want to go to the child issues and add a comment so you can be credited for the child issue patches. If you only worked on part of the patch, pick the appropriate child issue.
Comment #36
Bojhan CreditAttribution: Bojhan as a volunteer commentedReviewing on the lower level issues.
Comment #37
Bojhan CreditAttribution: Bojhan as a volunteer commentedReviewing on the lower level issues.
Comment #40
ifrikComment #41
joelpittetThis needs follow-up issues created for the patch above as mentioned by @jhodgdon in comment #35
Comment #42
tkoleary CreditAttribution: tkoleary commentedComment #43
MaskyS CreditAttribution: MaskyS at Google Code-In commentedSince all child issues have been closed, I'm going to close this one as well. Please feel free to re-open if required.