[drupal-docs] [drupal-devel] [task] Admin help in core modules

[Kieran Lal]

On Sep 20, 2005, at 11:33 PM, Dries Buytaert wrote:

>
> On 17 Sep 2005, at 01:12, Kieran Lal wrote:
>
>> Please review the admin help patch.  It needs to be updated to the  
>> latest admin help for Drupal after all the comments are removed  
>> and documentation updated to address those comments.
>>
>
> FYI, I'm OK with committing the help patch at any time during the  
> code freeze.  Read: you have the time it takes to review and  
> massage this patch.  The sooner the better though.  As soon the  
> patch hits core people can start using the documentation (think:  
> release candidates) and translators can start updating their  
> translations.
>
> I'll try my best to review this patch later this week.  I'll also  
> invite Gabor and Gerhard to review this patch.  Their background  
> with both documentation, translations and Drupal development make  
> them perfectly qualified to review it.  Neither are native English,  
> so even if they choose to review this patch, we need people to  
> proof-read the documentation.

We just completed a review of the comments for the Drupal handbook  
pages and updated the documentation accordingly. We should now  
generate a new patch once we have some peer review of those pages.

An important part of making admin help useful is updating the in page  
help text to point to admin help.  As some have commented, they don't  
use the admin help.  We need to re-educate Drupal users that admin  
help has improved and links to the handbook.

Perhaps we can do this in a couple of phases.  Get some review of the  
existing patch, commit it.  Update all administration interfaces to  
point to the new admin help for a module.  Then upgrade it again for  
the latest improvements after the Docs team has had a few weeks to  
review these pages.

Cheers,
Kieran

>
> --
> Dries Buytaert  ::  http://www.buytaert.net/
>
> -- 
> [ drupal-docs | http://lists.drupal.org/listinfo/drupal-docs ]
>
>