Handbook page on help module needs better information

wow, i don't even know how this ended up in the archive section, but i've pulled it back into the main handbook http://drupal.org/handbook/modules/help - and marked it as needs updating. marking as critical, since it is essentially useless...

That is not the only module help page that will need an update for Drupal 7. We really need to go through all the handbook/modules/xyz pages and update them. I think (thanks arianek!) that all or at least most of these pages now exist, but many of them need updates for Drupal 7, or need to be written. Do we have an omnibus issue for that, or do we want to file individual issues for every single one of the modules? I see several other individual module issues when I look at the "d7docs" tag link page, but there are a LOT more that need to be done (probably at a doc sprint).

Another note: A couple of the core module pages (e.g. RDF) are still marked as "contrib", and several need updates to the page title to reflect the new module name. It would indeed be a good Sprint task to go through each core module, make sure the Handbook page the Help screen links to is there, complete, well-titled, says 7.x, and is accurate.

I just updated the text on the main http://drupal.org/handbook/modules/help/ page so it makes sense and is in line with the Help text for the module.

Deleting the sub-page altogether as it's really confusing, and the help standard should be sufficient for guiding what should be in there. If anyone things any of this should be posted, let's just put it on the main page (since the content is pretty short).

<p>All user help should be presented using the help module. Some examples of help: </p>
<ul>
  <li>The name of a module (unused, but there).</li>
  <li>The description found on the admin/system/modules page.</li>
  <li>The module's help text, displayed on the admin/help page and through the module's individual help link.</li>
  <li>The help for a distributed-authorization module (if applicable).</li>
  <li>The description of a post type (if applicable).</li>
</ul>

Looks great, Ariane. I agree that the removed text can be dropped. If it goes anywhere, it would go on the module's instruction page i would think. On that, the "For module maintainers, please see the Help text documentation template for Drupal 7." links to a page that claims its valid all the way back to 4.7. Either older versions should be dropped there, or the D7-specificness should be dropped from the main page. Looking at that page, the latter route (dropping the Drupal 7 specificness, it doesn't actually show the arguments passed into hook_help and that's the only minor change i remember)– unless changes for that page which will make it 7-specific are in the works.

I made one change: "according" to "corresponding", seemed be the better word to me. ("Each module's help page also references its corresponding online Drupal handbook module page.") So leaving at needs review.

yay, thanks for the review!

i changed the last sentence to "For module maintainers, please see the Help text documentation template for all core and contributed modules." - I had said D7 because we only created it during the help text overhaul in the winter, but no reason it shouldn't apply to all.

corresponding is totally a better word too. thx!

will leave this open till we get one more - pls mark as fixed if it looks good!

I think this looks pretty good... The one question I had reading this page is "(which can be accessed through the Toolbar's Help menu item)". If someone doesn't have the Toolbar module installed, I think that help is also accessible through the main navigation menu, so maybe this should be mentioned? Other than that, I think it's ready to go.

I wondered how you even get to it without the toolbar, so turned the module off and found that the admin by module dashboard page has links to all the help pages:

http://skitch.com/arianek/dpeea/dashboard-localhost.drupal7

Amended the text to "(which can be accessed through the Toolbar's Help menu item, or via any of the "Get help" links on the administer by module page on the Dashboard's "By module" tab, if you are not using the Toolbar."

I think this is kinda clunky, but if anyone has a sense of how to make it a bit nicer, go for it.

Marking fixed!