[documentation] Links to module pages from contributed modules

Kieran Lal kieran at civicspacelabs.org
Mon Jan 16 20:05:17 UTC 2006


On Jan 15, 2006, at 8:25 PM, Boris Mann wrote:

>> We have 80 or so modules in a consistent format right now.  We  
>> have published guidelines on what the format is going to be for  
>> Administration Help for modules.  Please don't go and change just  
>> a few to be a new format.  It causes confusion and inconsistency.
>
> Hmmm...ouch. So I can't improve that section at all until we go  
> through a huge reorganization process. I understand why...it's just  
> tough to stomache. So...I guess I should go in and back out my  
> changes?

No, don't back them out.  But if you want to keep going then we need  
to put some serious work going forward.  Are you up for it?

>
>>   Angela and CSL have invested time and resources in creating  
>> scripts to automatically create patches from these pages.   We  
>> need to know what impact changing the format is going to have on  
>> generating those patches.
>
> I agree with your statements...this is THE problem with having this  
> both be admin help and documentation. There are areas where the two  
> are fundamentally at odds.
>
>> I think we should make improvements as you have suggested, but we  
>> need to consider other improvements and make a plan for how these  
>> will get implemented per the documentation coordinator's single  
>> source vision for the module administration help pages.
>
> Hmm. I don't think that sits only with the documentation  
> coordinator, unfortunately, as all those nasty developers will have  
> a say in how this gets done at a code level. I *think* there are  
> some technology solutions/thinking need in this area which, as you  
> say...we're going to need to think about and discuss.
>
> --
> Boris Mann
> Vancouver 778-896-2747 San Francisco 415-367-3595
> SKYPE borismann
> http://www.bryght.com
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>



More information about the documentation mailing list