A README.txt would be helpful for initial installation and configuration instructions.

Comments

jonreid created an issue. See original summary.

dbt102’s picture

I 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.

dbt102’s picture

hmmm... 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.

dbt102’s picture

Title: Create a README or INSTALL file » Create a README or HELP plugin

Updated issue title

dbt102’s picture

Assigned: Unassigned » dbt102
dbt102’s picture

see \Drupal\help\HelpSectionPluginInterface for the necessary details (annotation, methods, etc.)

and

\Drupal\help\Plugin\HelpSection\HookHelpSection for a working example

dbt102’s picture

https://www.drupal.org/developing/api/8/plugins

this is the drupal doco on plugins

dbt102’s picture

Pushed new release 8.x-1.0-beta1 to include readme.txt file.

Leaving this issue open to include the Help plugin

dbt102’s picture

Since 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 :-)

dbt102’s picture

Now, 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.

dbt102’s picture

hmmm... found this for instruction on D8 help --> Help text standard (for core and contrib)

dbt102’s picture

Status: Active » Closed (fixed)

Ok worked thru the "Help text standard" doco above, thru a series of other smaller issues so I'm closing this 'meta' like issue out.