Problem/Motivation

According to #3027054-100: Help Topics module roadmap: the path to beta and stable there are no blockers left to mark Help Topics as stable, and to start merging it into the core Help module.

- Last actionable item is #3037230: Finalize the merge of Help Topics into Help

Proposed resolution

- Remove "Experimental" status from Help Topics and mark it as stable core module.

Remaining tasks

- Swap Core (Experimental) for Core in the info file
- Check @internal in php-docs to allow move parts into help module
- Finalize scope of #3037230: Finalize the merge of Help Topics into Help

User interface changes

API changes

Data model changes

Release notes snippet

CommentFileSizeAuthor
#7 3355659-7.patch4.08 KBandypost
#7 interdiff.txt2.83 KBandypost
#6 3355659-6.patch1.25 KBandypost
#6 interdiff.txt448 bytesandypost
#5 3355659-4.patch1.27 KBandypost
#5 interdiff.txt794 bytesandypost
#3 3355659-3.patch504 bytesandypost

Comments

andypost created an issue. See original summary.

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue tags: +Needs issue summary update
Parent issue: » #3027054: Help Topics module roadmap: the path to beta and stable
Related issues: +#3037230: Finalize the merge of Help Topics into Help
andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Active » Needs work
StatusFileSize
new 3355659-3.patch504 bytes

Let's see how tests will run

andypost’s picture

andypost
he/him
Primary language Russian
commented
Related issues: +#3144933: Add help_search plugin to the base admin theme test

And one more fix

andypost’s picture

andypost
he/him
Primary language Russian
commented
StatusFileSize
new interdiff.txt794 bytes
new 3355659-4.patch1.27 KB
andypost’s picture

andypost
he/him
Primary language Russian
commented
StatusFileSize
new interdiff.txt448 bytes
new 3355659-6.patch1.25 KB

and stable is not needed

andypost’s picture

andypost
he/him
Primary language Russian
commented
StatusFileSize
new interdiff.txt2.83 KB
new 3355659-7.patch4.08 KB
amber himes matz’s picture

amber himes matz
she/her
Primary language English
Location Portland, OR USA
commented
Title: Mark Help topics as a module stable » Mark Help topics as a stable module
Issue summary: View changes
Issue tags: -Needs issue summary update

Updated issue summary and title for clarity.

catch’s picture

catch
he/him
Primary language English
commented

#3037230: Finalize the merge of Help Topics into Help suggests that rather than actually mark help topics as stable, we would instead move the code from help topics into the existing help module. With that the existing help_topics module would need to be marked obsolete and eventually removed from core and we just have 'help' with both help topics and hook_help(), and then eventually deprecate hook_help().

I think we definitely don't want two help modules in core, so we either need to merge help topics into help, or change the plan to make help topics the only module in core by deprecating and removing help - however doing so would mean two stable help modules in core until that happens, and 'help' still seems like a good namespace to keep in core, so for me the original plan is better.

So... I think we should mark this as a duplicate of #3037230: Finalize the merge of Help Topics into Help and focus efforts over there instead, but leaving needs work for discussion.

andypost’s picture

andypost
he/him
Primary language Russian
commented

My intent to make it stable is just to find better wording for class-comments, OTOH on the move we probably should spread topics to their modules (it was separate issue) because help (as stable) can't show topics from help_topics (experimental)

So this issue is an attempt to solve chicken-egg loop

+++ b/core/modules/help_topics/src/Controller/HelpTopicPluginController.php
@@ -14,9 +14,7 @@
  * @internal
- *   Help Topic is currently experimental and should only be leveraged by
- *   experimental modules and development releases of contributed modules.
- *   See https://www.drupal.org/core/experimental for more information.

This comment is all over classes, when moving to help module no BC required but wording needs some better wording

catch’s picture

catch
he/him
Primary language English
commented

If we move the help topics API to help module, that would count as stable, then the individual help topics can all move to their respective modules. Or we could just decide to do both at the same time if there's a proper chicken and egg situation.
Although I think it would be possible for help topics module to continue providing the topics for other core modules while that's happening (especially if we get it all done within 8.2's development cycle for example).

andypost’s picture

andypost
he/him
Primary language Russian
commented

Thank you @catch! Then next actionable issue is #3087499: Merge Help Topics classes into Help with BC layer

I still hope it will be just a move of classes with BC phantoms in help topics, then update hook to disable help-topics

I will start in this weekend

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Needs work » Closed (won't fix)
Related issues: +#3087499: Merge Help Topics classes into Help with BC layer

Setting proper status