Problem/Motivation

#2920309: Add experimental module for Help Topics should move the help topics from the experimental module to the correct locations - either core/help_topics or each extension (module/theme)'s help_topics directory.

This can only be done as the last step before going Stable, so it is postponed for the moment.

Proposed resolution

Move the topics to their final spots, and remove the special case that the experimental help_topics module can provide topics for other providers that is in the Discovery class.

Remaining tasks

Postponed on #3037230: Finalize the merge of Help Topics into Help
Make a patch. Don't commit the patch until Help Topics is being made stable.

User interface changes

None

API changes

None

Data model changes

None

Release notes snippet

None

CommentFileSizeAuthor
#15 3025577-15.patch2.19 KBAbhisheksingh27
#7 3025577-7.patch2.19 KBandypost

Issue fork drupal-3025577

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

alexpott 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
Status: Postponed » Active

This no longer needs to be postponed. Patch may conflict with #3037229: Extract help topics label from meta tag in Twig files however, as that issue is updating a few topic titles.

As a note, HelpTopicPluginManager is already scanning core, modules, and themes for subdirectories called help_topics. So, we can go ahead and move the topics that are now in core/modules/help_topics/help_topics to new subdirectories.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Closed (duplicate)

It made more sense to me to do this along with #3072312: Review/fix/delete existing help topics, which was rewriting all of these topics that belonged somewhere else. So, closing this as a duplicate.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes
Status: Closed (duplicate) » Active

I recently 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 I am reopening this issue instead of combining it with the other one. Adding a note that it can only be done as a last-minute thing.

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

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should 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.

andypost’s picture

andypost
he/him
Primary language Russian
commented
Version: 8.9.x-dev » 9.1.x-dev
Status: Active » Postponed
StatusFileSize
new 3025577-7.patch2.19 KB

Here's a patch and postpone it #3027054: Help Topics module roadmap: the path to beta and stable

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

That patch looks good. Eventually we'll need to add to the patch so that it also moves all the help topics files to their correct locations, but doing that now (before all the topics exist) would be silly. The tests will fail with this current patch because it removes the exception that topics can live in the help topics main directory instead of their own module directories.

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 » Needs work

I think we can proceed here as it already happening #3343600: Move help topics to actions module

Abhisheksingh27’s picture

Abhisheksingh27 commented
Status: Needs work » Needs review
StatusFileSize
new 3025577-15.patch2.19 KB

Adding Reroll for D10.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Needs review » Needs work

Why do we need to remove this restriction? Or to turn the question around. Why should module A be able to provide a help topic for module B. I might be missing something but I'm not sure why we'd want that.

I would have expected this patch to be the following change

        if ($provider !== $file_name_provider) {
          throw new DiscoveryException("$file file name should begin with '$provider'");
        }

i.e. we remove the help topics special case.

quietone’s picture

quietone commented
Issue summary: View changes
Status: Needs work » Postponed

The help_topics for Action are being moved because the module is being deprecated, it is not because of the work to make Help Topics stable. #3027054: Help Topics module roadmap: the path to beta and stable. In the Issue Summary for that issue it states that parent of this issue is not to be worked on until "all of the required issues above have been resolved, and all the questions answered". There are still 5 issues in that category listed on 3027054 that have not been resolved. I think this needs to wait until #3037230: Finalize the merge of Help Topics into Help is active.

Therefore I am restoring the postponed status.

andypost’s picture

andypost
he/him
Primary language Russian
commented
Related issues: +#3087499: Merge Help Topics classes into Help with BC layer

It should remain postponed until topics are moved to help module, the move in #3087499: Merge Help Topics classes into Help with BC layer

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: Postponed » Needs work

andypost opened merge request !4257

andypost’s picture

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

Created MR

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Beautiful thing to see all those topics landing in their respective modules.

The placement of the files seem to fall in the correct modules to me.

quietone’s picture

quietone commented
Status: Reviewed & tested by the community » Needs work

I checked the file renaming and did not find any errors. I would like to know why test coverage is being removed.

andypost’s picture

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

The test case testDiscoveryExceptionProviderMismatch was removed because it was testing that topics are living in help module (help topics previously) and this why commit message said this barrier is removed

andypost’s picture

andypost
he/him
Primary language Russian
commented

I mean the https://git.drupalcode.org/project/drupal/-/merge_requests/4257/diffs?co... commit

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Remarking.

quietone’s picture

quietone commented

@andypost, thanks. I reread the test more carefully this time. I think this is ready to commit but it is too late for me to do so now.

andypost’s picture

andypost
he/him
Primary language Russian
commented

Rebased after #3336065: Move help topics to tour module

  • larowlan committed 58233075 on 11.x 
    Issue #3025577 by andypost, Abhisheksingh27, jhodgdon, alexpott,...
larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Reviewed & tested by the community » Fixed

Applied on top of #3376261: Move help topics to book module and pushed to 11.x - Thanks!

andypost closed merge request !4257

Status: Fixed » Closed (fixed)

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