Problem/Motivation
The help text of the Content Moderation module does not follow the Help text standards as described in https://www.drupal.org/help-text-standards.
The descriptions should be so generic that they work for example for different admin themes where links are not displayed as blue buttons, and they should contain the relevant links.
Proposed resolution
Editing the text according to the standard.
Remaining tasks
Edit the headers in the Uses sectionEdit the Uses descriptionsAdd the relevant links is the Uses descriptions
User interface changes
This is a UI text change
Comment | File | Size | Author |
---|---|---|---|
#33 | interdiff.txt | 2.87 KB | pritish.kumar |
#33 | edit_hook_help_text_for-2830832-33.patch | 1.48 KB | pritish.kumar |
#31 | edit_hook_help_text_for-2830832-30.patch | 2.72 KB | Roya-Rateshtari |
#21 | edit_hook_help_text_for-2830832-21.patch | 1.38 KB | Jeff Cardwell |
#16 | edit_hook_help_text_for-2830832-16.patch | 1.29 KB | Jeff Cardwell |
Comments
Comment #2
ifrikComment #3
chanderbhushan CreditAttribution: chanderbhushan as a volunteer and at gai Technologies Pvt Ltd for gai Technologies Pvt Ltd commentedHi,
I have added patch for links.
Comment #4
kiwimind CreditAttribution: kiwimind at Investis Digital commented:permission
vs:permissions
.Otherwise, looks good and reads fine.
Comment #5
th_tushar CreditAttribution: th_tushar as a volunteer commentedUpdated the patch. Looks good now.
Comment #7
timmillwoodPatch fails to apply, so needs rerolling.
Comment #8
KeeneganI tried to reroll #5 with https://www.drupal.org/patch/reroll.
I had a conflict,
I removed the "first" part and kept the "second" one, I hope it was the right thing to do. It's my first contribution, so if I did something wrong tell me what please :)
Comment #10
timmillwood@Keenegan - I think we needed to keep a mixture of the "first" and "second" sections. The failing tests are because the help text is now missing some expected components.
Comment #11
th_tushar CreditAttribution: th_tushar as a volunteer commentedRerolled the patch.
Comment #13
KeeneganRe-rolling again
Comment #16
Jeff Cardwell CreditAttribution: Jeff Cardwell as a volunteer commentedThe original help page was changed greatly in another commit (Add a workflow component, ui module, and implement it in content moderation) since this issue was opened. This is why the patches are failing. Because of the extensive nature of those changes, It appears that the changes in this issue may no longer be applicable. However, there are two places where
<dd>
elements are closed with</p>
tags in the new file as well. I have corrected these tags and created a new patch reflecting only this change.Comment #17
rocketeerbkw CreditAttribution: rocketeerbkw commentedComment #18
kiwimind CreditAttribution: kiwimind at Investis Digital commentedThis patch got a bit simpler! Even more straightforward.
All seems to make sense, especially in light of some of the other changes being made as mentioned by @rocketeerbkw.
Thanks.
Comment #19
ifrikThanks a lot,
but this text doesn't quite follow the UI text standards for it and still misses the links, as lined out in the description of this issue.
I'll come back with more detailed comment later today.
Comment #20
kiwimind CreditAttribution: kiwimind at Investis Digital commentedApologies, I thought that this ticket was heading towards the simpler end of the scale, rather than just reproducing what had already been done in #13.
Comment #21
Jeff Cardwell CreditAttribution: Jeff Cardwell as a volunteer commentedI added back in a link to the permissions page in the uses section, but it seems strange to do so since it is listed as an administration page immediately after. Additionally, the state of the module seems to be a bit in flux. Perhaps it is settling down now. The link to the documentation is live, but the documentation does not reflect the current design of the module.
Comment #22
rakesh.gectcrOnes you worked the issue and uploaded patch, please change the status to 'Needs review';
Comment #23
prash_98 CreditAttribution: prash_98 commentedThe patch of #21 applies well and I guess the status can be changed to RTBC.
Comment #24
ifrikThe help text is not available to users if the module is not enabled, so the point about enabling the module needs to be removed.
There are some uses missing: such as that workflows need to be added to entity types to become available, or that users can their own states. These need explaining.
It's also worth mentioning that the module overwrites the default "Edit" tab and "Save" button with custom values.
I only had an initial look at the module, so I don't know what other functionality is there, but what ever there is needs to be described in the help text.
Comment #25
xjm@prash_98, keep in mind again that the automated testing infrastructure tells us whether the patch applies, so we do not need people to review that. What we do need people to review is whether the issue has a correct scope, whether it passes the core gates, whether the solution completely fixes the problem without introducing other problems, and whether it's the best solution we can come up with. See the patch review guide for more information. Thanks for your contributions!
Thanks @ifrik, agreed. For contributors on this issue, the best way to decide what to put in the help text is to test the module and see what it does, considering what features should be explained, if there are any gotchas, etc.
Comment #26
prash_98 CreditAttribution: prash_98 commented@xjm will surely keep in mind for the other issues.
Comment #27
prash_98 CreditAttribution: prash_98 at Google Summer of Code commented@xjm,
The module is failing to get installed. The site crashes on enabling the module.
Comment #28
timmillwood@prash_98 - Can you open a new issue with the issues you are getting when enabling the module?
Comment #29
prash_98 CreditAttribution: prash_98 at Google Summer of Code commented@timmillwood -Yes would open one.
Comment #30
kimble CreditAttribution: kimble as a volunteer commentedWorking on this @Baltimore2017.
Comment #31
Roya-Rateshtari CreditAttribution: Roya-Rateshtari as a volunteer commentedI applied the patch #21 and it fixed the Uses description tags, and I noticed the links to workflow was missing. I just added the link to workflow.
Comment #32
rakesh.gectcrPlease follow the coding standard.
Please read https://www.drupal.org/docs/develop/standards/coding-standards#indenting
Comment #33
pritish.kumar CreditAttribution: pritish.kumar at OpenSense Labs commentedCorrected the coding standards errors.
Comment #36
ifrikThe help text has been updated as part of another commit and doesn't need changing anymore.
Comment #37
dmkelner CreditAttribution: dmkelner commented@ifrik, can you point to where this was done?