Background:

This issue is part of the task to update the hook_help texts of the Drupal 8 modules:
#1908570: [meta] Update or create hook_help() texts for D8 core modules

After completing the main review for the Comment module on #2091299: Update hook_help for Comment module, we discovered #2230177-20: Without Field UI comment module presents a poor UX.

So the hook help for the Comment module needs an update to say that comments can't be managed without the Field UI module installed.

CommentFileSizeAuthor
#10 2488078-8.patch4.49 KBrashid_786
#10 interdiff-2488078-7-8.txt2.87 KBrashid_786
#7 2488078-comment-help-7.patch4.48 KBifrik
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

andypost’s picture

andypost
he/him
Primary language Russian
CreditAttribution: andypost at Skilld commented
Title: Update hook_help for Comment module about » Update hook_help for Comment module about field UI need to manage comment fields
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Issue summary: View changes

Note that there is currently a small patch to the comment_help() function happening on
#2473105: Update hook_help texts that link to modules that can be uninstalled
as well, so this one should probably wait until the other one is committed. Hopefully soon, it's RTBC.

And probably we do not need to do the full "does this comply with standards" review on this issue. This issue is about adding something to the help; the standards review is done. Updating summary.

mark.labrecque’s picture

mark.labrecque
he/him
Primary language English
Location Vancouver
CreditAttribution: mark.labrecque at ImageX commented
Assigned: Unassigned » mark.labrecque
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Active » Postponed

Sorry, probably should postpone on #2473105: Update hook_help texts that link to modules that can be uninstalled, forgot to change status

mark.labrecque’s picture

mark.labrecque
he/him
Primary language English
Location Vancouver
CreditAttribution: mark.labrecque at ImageX commented
Assigned: mark.labrecque » Unassigned
ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Status: Postponed » Needs work

I've changed the status because the issue referred to has been fixed.

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Status: Needs work » Needs review
FileSize
2488078-comment-help-7.patch4.48 KB

I've split the description about enabling and default configuration into two, to add that the Field UI module is required to add a comment field to an entity even though the functionality works without it.

The site doesn't break if the Field UI module is turned off.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Needs work

The docs look great!

There are a few typos in the Enabling section:

a) functionaliy ==> functionality

b) For more information fields and entities ==> ... information on fields and...

c) see the <a href="!field">Field ==> remove extra space before the A tag

Other than that, looks great to me, thanks!

The last submitted patch, 7: 2488078-comment-help-7.patch, failed testing.

rashid_786’s picture

rashid_786 CreditAttribution: rashid_786 as a volunteer commented
FileSize
interdiff-2488078-7-8.txt2.87 KB
2488078-8.patch4.49 KB

Updated patch with suggested changes.

rashid_786’s picture

rashid_786 CreditAttribution: rashid_786 as a volunteer commented
Status: Needs work » Needs review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Reviewed & tested by the community

Thanks! Looks good!

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 10: 2488078-8.patch, failed testing.

Status: Needs work » Needs review

jhodgdon queued 10: 2488078-8.patch for re-testing.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Reviewed & tested by the community
webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick at Acquia commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed to 8.0.x. Thanks!

  • webchick committed a41cddd on 
    Issue #2488078 by rashid_786, ifrik, jhodgdon, andypost: Update...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.