Problem/Motivation

The link (https://www.drupal.org/modules/help_topics) provided in the help_topics module in hook_help() is not available in drupal.org.

Proposed resolution

Point link to https://www.drupal.org/documentation/modules/help_topics

Remaining tasks

commit

User interface changes

link points to stub page for the module

API changes

no

Data model changes

no

Release notes snippet

n/a

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

rksyravi created an issue. See original summary.

xjm’s picture

Thanks @rksyravi! The Help Topics module is experimental, so its documentation might not be completed until it is closer to stable. That said, we should probably at least create a stub page or check that the URL is correct.

xjm’s picture

jhodgdon’s picture

Does it actually make sense to make that page? The plan is for the Help Topics module to be merged into the Help module, so we do not really want that documentation to exist when the module is stable. We can make a stub page for now but we would want it to go away...

jhodgdon’s picture

We could also put in a redirect from that URL to the modules/help docs page, and a note at the top of that page about Help Topics beta?

jhodgdon’s picture

Version: 9.0.0-alpha1 » 8.9.x-dev
Status: Active » Needs review
FileSize
1.43 KB

OK, there are actually two problems here.

First: The link in the hook_help for help topics module should be https://www.drupal.org/documentation/modules/help_topics, not https://www.drupal.org/modules/help_topics as it is now.

Second: the correct link didn't go anywhere... I think it should probably be redirected to
https://www.drupal.org/docs/develop/documenting-your-project/help-topic-...
which is a docs page about the new help topics system. So, I've put that redirect in.

We also need a patch to fix the link in help_topics.module, so here is that.

daffie’s picture

Status: Needs review » Reviewed & tested by the community

Looks good to me.

andypost’s picture

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 6: 3113236.patch, failed testing. View results

jhodgdon’s picture

Status: Needs work » Reviewed & tested by the community

Unrelated test failure. I assume this one is known:

Drupal\KernelTests\Core\Action\SaveActionTest::testGetDerivativeDefinitionsassertArraySubset() is deprecated and will be removed in PHPUnit 9.
/var/www/html/vendor/phpunit/phpunit/src/Framework/TestResult.php:691

alexpott’s picture

Category: Task » Bug report
Status: Reviewed & tested by the community » Fixed

Committed and pushed 63cdee3511 to 9.0.x and c179a28bb0 to 8.9.x and 6e9b99da12 to 8.8.x. Thanks!

  • alexpott committed 63cdee3 on 9.0.x
    Issue #3113236 by jhodgdon, rksyravi: Help topics module - documentation...

  • alexpott committed c179a28 on 8.9.x
    Issue #3113236 by jhodgdon, rksyravi: Help topics module - documentation...

  • alexpott committed 6e9b99d on 8.8.x
    Issue #3113236 by jhodgdon, rksyravi: Help topics module - documentation...

Status: Fixed » Closed (fixed)

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

quietone credited shaal.

quietone’s picture

Closed a duplicate, adding credit here.