Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
A README.txt would be helpful for initial installation and configuration instructions.
Comments
Comment #2
dbt102 CreditAttribution: dbt102 commentedI agree jonreid. I started to look for documentation guidelines on that very issue and noticed that they had not been updated for Drupal version 8.x yet. I wasn't sure the reason for this.
Maybe they are located someplace else?
Or, maybe the documentation for the documentation guidelines page just needs updated?
Lets check into that and get some good documentation in place for this module.
Comment #3
dbt102 CreditAttribution: dbt102 commentedhmmm... this seems relevant --> https://www.drupal.org/node/2669966
Looks like we could create a new plug-in per today's Drupal 8.1 release.
Comment #4
dbt102 CreditAttribution: dbt102 commentedUpdated issue title
Comment #5
dbt102 CreditAttribution: dbt102 commentedComment #6
dbt102 CreditAttribution: dbt102 commentedsee \Drupal\help\HelpSectionPluginInterface for the necessary details (annotation, methods, etc.)
and
\Drupal\help\Plugin\HelpSection\HookHelpSection for a working example
Comment #7
dbt102 CreditAttribution: dbt102 commentedhttps://www.drupal.org/developing/api/8/plugins
this is the drupal doco on plugins
Comment #8
dbt102 CreditAttribution: dbt102 commentedPushed new release 8.x-1.0-beta1 to include readme.txt file.
Leaving this issue open to include the Help plugin
Comment #9
dbt102 CreditAttribution: dbt102 commentedSince this was new to me I broke the next steps into a couple different issues as I came across them, then contributed those components back as separate commits. So at this point we should have a "Youtube Block" link showing up on the help page that does not crash the whole site if its clicked on :-)
Comment #10
dbt102 CreditAttribution: dbt102 commentedNow, when I click on the "Youtube Block" link on the help page it takes me to a page that reads
"No help is available for module Youtube Block."
So, I'm going to create another issue to define what is actually included there.
Comment #11
dbt102 CreditAttribution: dbt102 commentedhmmm... found this for instruction on D8 help --> Help text standard (for core and contrib)
Comment #12
dbt102 CreditAttribution: dbt102 commentedOk worked thru the "Help text standard" doco above, thru a series of other smaller issues so I'm closing this 'meta' like issue out.