[documentation] [Documentation task] For discussion: Should we remove the "You can" links from module help?

[webchick]

Issue status update for 
http://drupal.org/node/92992
Post a follow up: 
http://drupal.org/project/comments/add/92992

 Project:      Documentation
 Version:      <none>
 Component:    Documentation in CVS
 Category:     tasks
 Priority:     normal
 Assigned to:  Anonymous
 Reported by:  webchick
 Updated by:   webchick
 Status:       active

A very good question. Not 100%. But about 85% at least.


Missing portions are:
- All node modules have links to "create content" which are not found
in administer by module.
- Some modules link off to pages their modules create or add to. For
example, contact module's help page links to the contact form, blog
module's help page links to "my account."


In all other cases, it's the "administer >> something" links.


We could do two things to increase that 85% to 100%:


1. Include an administration link to "create content" for all node
types in the "administer by modules" page.
2. Move references to "oddball" links like "my account" and such to the
actual body text, rather than the "You can" section.


In fact, I think I'll go ahead and roll a patch for #1 right now.




webchick



Previous comments:
------------------------------------------------------------------------

Sun, 05 Nov 2006 03:03:02 +0000 : webchick

A long-standing issue with synchronizing the module help in
admin/help/module_name with that in http://drupal.org/handbook/modules
are those darn "You can" links at the bottom that say things like:


You can



* administer forums at administer >> content management >> forums [1].
* enable the required comment and taxonomy modules at administer >>
site configuration >> modules [2].
* read about the comment module at administer >> help >> comment [3].
* read about the taxonomy module at administer >> help >> taxonomy [4].

The problem is we can't link to actual paths on Drupal.org, since they
will be 404s/403s in many cases, which totally befuddled and frustrated
users. And we made many attempts of encoding these in an arcane way so
that they could be parsed out with a script, but that was also
cumbersome and only ever done for the core pages, not contrib.


Now that 5.0 has the "administer by modules" page, can we safely remove
these links from core help and the admin help text in the handbook
documentation?


[1] http://drupal.org/admin/content/forum
[2] http://drupal.org/admin/settings/modules
[3] http://drupal.org/admin/help/comment
[4] http://drupal.org/admin/help/taxonomy




------------------------------------------------------------------------

Wed, 15 Nov 2006 17:35:04 +0000 : Gábor Hojtsy

Question is if these "you can" lists really overlap with the new per
module admin pages. I am not sure. But by the way, these lists were hard
to translate too (we need to strictly look at the menu item translations
when translating these strings).