You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lenya.apache.org by florent andré <fl...@4sengines.com> on 2010/09/13 19:14:32 UTC

Module documentation (was : Re: svn commit: r996319 - in /lenya/contributions/2_0_X/modules/quiz/samples: default.xml lenyaquiz.xml samples.xml)


On 09/13/2010 06:33 PM, Rudolf Korhummel wrote:
> HI Florent, hi all,
>
...
>
> BTW: Where should we put the documentation of the contributions ?

IMO the best is in a "docs" folder inside the module (myModule/docs/).

First, we are sure that each module have embedded up to date documentation

Secondly, if we find a common structure inside this "docs" folder, we 
can easily create a lenya module that display this documentation on the 
website.

WDYT ?

++

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: Module documentation (was : Re: svn commit: r996319 - in /lenya/contributions/2_0_X/modules/quiz/samples: default.xml lenyaquiz.xml samples.xml)

Posted by Rudolf Korhummel <ru...@korhummel.de>.
Am 13.09.2010 um 19:14 schrieb florent andré:

>
>
> On 09/13/2010 06:33 PM, Rudolf Korhummel wrote:
>> HI Florent, hi all,
>>
> ...
>>
>> BTW: Where should we put the documentation of the contributions ?
>
> IMO the best is in a "docs" folder inside the module (myModule/docs/).
>
> First, we are sure that each module have embedded up to date  
> documentation
>
> Secondly, if we find a common structure inside this "docs" folder,  
> we can easily create a lenya module that display this documentation  
> on the website.
>
> WDYT ?
>
> ++


+1

A good idea I think.

Rudolf

>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
> For additional commands, e-mail: dev-help@lenya.apache.org
>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org