Provide help page

Created on 6 November 2023, over 1 year ago
Updated 23 November 2023, over 1 year ago

Problem/Motivation

It would be nice to have some documentation available in the drupal directly.

List all associated routes in the module.

📌 Task
Status

Needs work

Version

2.0

Component

Documentation

Created by

🇸🇮Slovenia useernamee Ljubljana

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

Merge Requests

Comments & Activities

  • Issue created by @useernamee
  • 🇸🇮Slovenia useernamee Ljubljana
  • First commit to issue fork.
  • Status changed to Needs review over 1 year ago
  • 🇮🇳India ankithashetty Karnataka, India

    MR created. The details on the help page might need some more details, so will need a review from maintainers.

    Before the fix: There were no 'Help', or 'Configure' links.

    After fix: Able to see 'Help' and 'Configure' links.

    (on /admin/help/ohdear_integration page)

    Thanks!

  • Status changed to RTBC over 1 year ago
  • 🇵🇭Philippines kenyoOwen

    Hi ankithashetty

    I reviewed and tested your MR!16 and confirmed that it adds a help page button and a help page for the module. I added screenshots for reference.

    Thank You.

  • Status changed to Needs work over 1 year ago
  • 🇸🇮Slovenia useernamee Ljubljana

    Thank you for the MR it is a good starting point.

    I have some comments regarding the information on the help page. I think it should be structured in a way that is the most helpful for the site builders. So we'd need a list of routes the module provides:
    - settings page
    - json healthcheck results endpoint
    - ohdear data inside drupal Show most valueable data from ohdear inside drupal Needs work

    It should also have a section on the drush commands available and a short explanation on its relation with the monitoring module.

Production build 0.71.5 2024