This is postponed on:

a) #2920309: Add experimental module for Help Topics being committed

b) #3027054: Help Topics module roadmap: the path to beta and stable having all the other tasks being done.

So the task for this module is to finally merge the Help Topics module into the core Help module for stable release. Sub-tasks:

CommentFileSizeAuthor
#26 3037230-26.diff13.07 KBandypost

Issue fork drupal-3037230

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

jhodgdon created an issue. See original summary.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes

Added a child issue with another task as part of this issue.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes

I asked in Slack and found out from @xjm that all of the code *and topics* related to the Help Topics module need to stay under core/modules/help_topics until we are Stable. So, minor update to the issue summary here.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes

Adding one more issue related to #5, replacing one of the bullet items there with an actual issue.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes

Added #3144933: Add help_search plugin to the base admin theme test

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Postponed » Active
Related issues: +#3219923: Add tests to enforce correct use of help_topic_link and help_route_link functions, +#3355659: Mark Help topics as a stable module

All conversions are done so it's time for final merge or keep them separated

Amber Himes Matz made their first commit to this issue’s fork.

Amber Himes Matz opened merge request !3934

amber himes matz’s picture

amber himes matz
she/her
Primary language English
Location Portland, OR USA
commented
Issue summary: View changes

Updated IS to remove mention of Stable/Classy.

I’m not sure what else needs to be done with regard to adding templates to core admin themes.

I’ve opened a MR that:

- Adds new help topic in core Help module to replace Help Topic module overview in its hook_help.
- Moves help.help_topic route case to help_help().
- Deletes help_topic.module, as all other hooks are already being moved in #3087499: Merge Help Topics classes into Help with BC layer.

amber himes matz’s picture

amber himes matz
she/her
Primary language English
Location Portland, OR USA
commented
Status: Active » Needs review

This is ready for review. The following items from the IS are addressed in this MR:

  • Merging the hook_help() from the experimental Help Topics module into existing topics
  • Making sure that no help topics mention the Help Topics module (because it will be part of the Help module instead).

I also opened #3358340: Update help.help_topic_search to remove mention of Help Topics module which will need to wait until #3087499: Merge Help Topics classes into Help with BC layer is committed.

All other points except for the “the standard things done in Core to finalize a module such as adding templates to core admin themes, etc” are covered in related issues.

That being said, there may be something else that @andypost thinks should go into this issue, that isn’t part of the MR in #3087499: Merge Help Topics classes into Help with BC layer.

andypost’s picture

andypost
he/him
Primary language Russian
commented

Thank you! That's exactly chicken/egg issue I stuck to figure out!

I think I need to review/check all @internal mentions in topics to be sure that all classes without BC has it

Ref https://www.drupal.org/about/core/policies/core-change-policies/bc-policy

andypost’s picture

andypost
he/him
Primary language Russian
commented
Related issues: +#2687107: Reorganize topics into sensible outline, and/or write more topics

btw We may reconsider to open after final merge #2687107-41: Reorganize topics into sensible outline, and/or write more topics

smustgrave’s picture

smustgrave commented
Status: Needs review » Needs work

Only moving to NW as there appear to be failures in the MR.

Have not tested yet.

amber himes matz’s picture

amber himes matz
she/her
Primary language English
Location Portland, OR USA
commented
Status: Needs work » Needs review

Latest push restores help_topics.module as suggested by @andypost -- it just provides a message saying that Help Topics has been moved to Help module.

I thought I had already done this, but apparently not -- I merged the output from Help Topics' module overview to Help modules. So Help module's module overview page now includes info about Help Topics.

Finally, I updated the branch target to 11.x as requested.

andypost’s picture

andypost
he/him
Primary language Russian
commented

It looks ready so now should wait for merge of #3087499: Merge Help Topics classes into Help with BC layer

smustgrave’s picture

smustgrave commented
Status: Needs review » Needs work

Seems some failures in MR but based on #23 this is postponed

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue summary: View changes

Final merge should mark help topic module obsolete https://www.drupal.org/docs/core-modules-and-themes/deprecated-and-obsolete

andypost’s picture

andypost
he/him
Primary language Russian
commented
StatusFileSize
new 3037230-26.diff13.07 KB

Squashed commits and now it's not clear if this changes from the MR could me added to #3087499: Merge Help Topics classes into Help with BC layer

Here's diff (rebase MR on top of 3087499)

amber himes matz’s picture

amber himes matz
she/her
Primary language English
Location Portland, OR USA
commented

Yes, I think it makes sense to incorporate the changes here into #3087499 instead.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Needs work » Postponed

Moved to #3087499-51: Merge Help Topics classes into Help with BC layer

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Postponed » Active

Proper starts

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue summary: View changes

updated IS a bit

andypost’s picture

andypost
he/him
Primary language Russian
commented

it will need to update https://www.drupal.org/about/core/policies/core-change-policies/experime...

andypost’s picture

andypost
he/him
Primary language Russian
commented

Filed #3370070: Update Maintainers for the Help module

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue summary: View changes
benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented

After #3087499: Merge Help Topics classes into Help with BC layer, all the classes under help_topics/src/ are simply wrappers for the corresponding classes in the help module.

Should we also mark those classes as deprecated? Maybe we do not have to, since they are already marked @internal. But I think this comment from https://www.drupal.org/about/core/policies/core-change-policies/bc-polic... applies:

Even for internal APIs, core contributors should always try to follow the deprecation process first, or document in issue discussions why deprecation is not used.

andypost’s picture

andypost
he/him
Primary language Russian
commented

The main point is not to add them is that help topics module is experimental and should not contain API

andypost’s picture

andypost
he/him
Primary language Russian
commented

Filed patch for the last issue #3074040-15: Move testing of help topic rendering into child of GenericModuleTestBase

All others are RTBC)

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue summary: View changes

one more commited #3358340: Update help.help_topic_search to remove mention of Help Topics module

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue summary: View changes
andypost’s picture

andypost
he/him
Primary language Russian
commented

The only one is left #3144933: Add help_search plugin to the base admin theme test

Amber Himes Matz closed merge request !3934

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue summary: View changes
andypost’s picture

andypost
he/him
Primary language Russian
commented

Filed quick-fix #3377604: Remove leftover mentions of help_topics namespace in help module

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Active » Fixed

The quick-fix needs docs team review so can live on its own #3377604: Remove leftover mentions of help_topics namespace in help module

I find this epic complete and polishing will happen as docs evolving

Status: Fixed » Closed (fixed)

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