Problem/Motivation

Currently the help page is an unformatted version of the README.md file. It would be better for it to be focused on any extra guidance a site builder needs when first configuring the module.

Steps to reproduce

Visit the current Comment Notify help page at - /admin/help/comment_notify

Proposed resolution

Rewrite the help page to use formatted text that is focused on orienting a site builder to how to set up and configure the module.

Remaining tasks

  1. ✅ Update the README.md file to follow best practices
  2. Create a proper help page
  3. Draft help page text to be concise and helpful
  4. Add a link to the drupal.org documentation
CommentFileSizeAuthor
#10 help-page.png329.18 KBmanish-31
#6 Screenshot from 2023-10-19 19-19-24.png281.79 KBdiwakar07
#6 Screenshot from 2023-10-19 19-19-13.png242.98 KBdiwakar07

Issue fork comment_notify-3392253

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

cedewey created an issue. See original summary.

Diwakar07 made their first commit to this issue’s fork.

Diwakar07 opened merge request !10

diwakar07’s picture

diwakar07 commented
Status: Active » Needs review

Hi, I have updated the Readme.MD file according to latest Drupal standards.
Please review.

cedewey’s picture

cedewey
he/him
Primary language English
Location Denver, CO
commented
Issue summary: View changes
Status: Needs review » Needs work

Hi Diwakar,

This is a great start towards the first step of formatting the text. We should create an actual help page that differs from the README.md file. For example, we don't need info about installing the module on the help page, since a user only sees this page after they've installed and enabled the module.

I think though we can keep these improvements you've made to the README.md file.

Next steps are to create a standalone help page and draft text geared towards sitebuilders explaining how to configure the module.

If you want to take a pass at that, feel free to! Otherwise I'll try and work on this in the next week or two.

diwakar07’s picture

diwakar07 commented
Assigned: Unassigned » diwakar07
Status: Needs work » Needs review
StatusFileSize
new Screenshot from 2023-10-19 19-19-13.png242.98 KB
new Screenshot from 2023-10-19 19-19-24.png281.79 KB

Hi, Thanks for the suggestions.
I have updated the help page accordingly. Adding the screenshots for the updated help page.
Please review.

diwakar07’s picture

diwakar07 commented
Assigned: diwakar07 » Unassigned
manish-31’s picture

manish-31 commented
Status: Needs review » Needs work

Hi @diwakar

Help page looks better now.

I got some trailing whitespaces warnings while applying the patch could you please fix those?

182: trailing whitespace.
      $output .= '<ol> 
187: trailing whitespace.
      <li> Set permissions for commenting as per usual from 
203: trailing whitespace.
      
warning: 3 lines add whitespace errors.

Also, please consider below improvements
- Remove colons from paragraph headings.

- Provide absolute URLs to the configuratin/permission pages.

diwakar07’s picture

diwakar07 commented
Status: Needs work » Needs review

Hi,
I have updated the MR according to the review.
Please review.

manish-31’s picture

manish-31 commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new help-page.png329.18 KB

The MR patch applies successfully without any warnings now.

Reviewed th Readme.md file has been updated as per the Readme.md standards.

Verified the help page contains all the necessary information and documentation links. Attaching Screenshot for reference.

Marking this RTBC.

Thanks!

gnuget’s picture

gnuget
Primary language Spanish
commented
Status: Reviewed & tested by the community » Needs work

  • gnuget committed 51f7b11e on 8.x-1.x authored by diwakar07 
    task: #3392253 Update the help page

By: diwakar07
By: cedewey
By:...
gnuget’s picture

gnuget
Primary language Spanish
commented
Status: Needs work » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.