[documentation] module pages linking to handbook pages

[Steven Peck]

I responded, it's a great idea... I'm not doing it :)  Of course, they also wanted 300 forums. :O
 
In the project page, there is a place to link to Documentation and it will automatically be displayed.  This would be an excellent spot to put this information.  Now someone needs to go do it.  Also, is there a page about contributing modules?  If so, then it needs to be updated to mention that documentation goes in the handbook/contrib tree and how to get the alias created.  Someone blogged about me when I mentioned where module documentation goes, so obviously we need something.  If no one does this before I get to the developers handbook, then I'll do it then.  Trying to stay sequentially focused.
 
Note: I will intermittantly not move anything as I play World of Warcraft and make sure my familiy still lives in the same house :)
 
-sp

________________________________

From: documentation-bounces at drupal.org on behalf of Charlie Lowe
Sent: Wed 1/11/2006 1:55 PM
To: A list for documentation writers
Subject: [documentation] module pages linking to handbook pages



Someone has just made the suggestion that project module pages should
link to handbook pages:

http://drupal.org/node/44233#comment-82569

I think could be a big plus because


1) The individual project pages are often the first place someone goes
for looking at module when thinking of using it. Good place to link
directly to help. Seems an obvious place.

2) The Drupal modules and features pages often provide additional
information about a module which could help people in choosing what
module to download or pointing them to additional help when they have a
problem.

3) Providing a link from the individual project module pages could
create incentive for contrib module developers to assist in keeping the
docs updated and to provide additional docs.

Additionally, it seems like it would only help to have all the theme
projects link to the general theme help sections. Translations, too.

Charlie

--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/



-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.drupal.org/pipermail/documentation/attachments/20060112/f9034cf5/attachment.htm