Problem/Motivation

Need proper Help overview page for the project. It difficult to anyone to understand the configuration of this module. Having the proper documentation of the configuration pages it will help to others.
https://www.drupal.org/node/632280

Proposed Solution
Provide the proper Help overview documentation for the project

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Praveen Neelanathan created an issue. See original summary.

praveenneelu’s picture

I applied a patch for Help overview page. Recommendations are welcome to update this issue. Kindly Review.

praveenneelu’s picture

Status: Active » Needs review
krina.addweb’s picture

Status: Needs review » Needs work

@Praveen Neelanathan, Thanks for the efforts. I checked your patch using simplytest.me and found that it does not apply as it shows The patch URL "https://www.drupal.org/files/issues/2019-05-16/help_overview-3054994-#1...." failed by HTTP status 404. error. Can you please share the correct patch. Thanks!

praveenneelu’s picture

@krina.addweb,

Thanks for your reply. The correct patch url is https://www.drupal.org/files/issues/2019-05-16/help_overview-3054994-%23...

Please check it.

praveenneelu’s picture

Status: Needs work » Needs review
krina.addweb’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
20.99 KB
21.64 KB
100.43 KB

@Praveen Neelanathan, Thanks for the patch. Your patch is working fine. I tested the patch in my local. PFA for the changes done.

praveenneelu’s picture

@krina.addweb
I saw the attachments, Thanks for your work.

scuba_fly’s picture

Status: Reviewed & tested by the community » Needs work

Thank you for your patch!

For the future please don't use # in the patch name. That makes it easier to apply and test the patch.

+++ b/social_media.module
@@ -33,4 +33,19 @@ function social_media_mail($key, &$message, $params) {
+function social_media_help($route_name, \Drupal\Core\Routing\RouteMatchInterface $route_match) {

We could improve here to use a use statement for the RouteMatchInterface.

+++ b/social_media.module
@@ -33,4 +33,19 @@ function social_media_mail($key, &$message, $params) {
+     }

The } is not indented correctly

Also, hook help should return an empty string if the route does not match.

Ensure that hook_help() can return an empty string and not cause the block to display.

See help_page_test.module file.

Sorry for being strict about this.
I made a few changes before commit, see my commit below in a few minutes.

To be honest the string concatenation is not the nicest solution. But Drupal core also uses this, so let's commit this.

  • scuba_fly committed 2c1a78b on 8.x-1.x
    Issue #3054994 by Praveen Neelanathan, krina.addweb, scuba_fly: Need...
scuba_fly’s picture

Status: Needs work » Fixed

My commit hook also detected some code style issues so I fixed that as well.

Status: Fixed » Closed (fixed)

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