Update the help page

Created on 6 October 2023, about 1 year ago
Updated 18 July 2024, 4 months ago

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
📌 Task
Status

RTBC

Version

1.0

Component

Documentation

Created by

🇺🇸United States cedewey Denver, CO

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @cedewey
  • First commit to issue fork.
  • Merge request !10Issue #3392253: Update the help page → (Open) created by diwakar07
  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update about 1 year ago
    15 pass
  • Status changed to Needs review about 1 year ago
  • 🇮🇳India diwakar07

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

  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update about 1 year ago
    15 pass
  • Status changed to Needs work about 1 year ago
  • 🇺🇸United States cedewey Denver, CO

    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.

  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update about 1 year ago
    15 pass
  • Assigned to diwakar07
  • Status changed to Needs review about 1 year ago
  • 🇮🇳India diwakar07

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

  • Issue was unassigned.
  • Status changed to Needs work 6 months ago
  • 🇮🇳India manish-31

    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.

  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update 6 months ago
    CI error
  • Status changed to Needs review 6 months ago
  • 🇮🇳India diwakar07

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

  • Status changed to RTBC 4 months ago
  • 🇮🇳India manish-31

    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!

Production build 0.71.5 2024