You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lenya.apache.org by Andreas Hartmann <an...@apache.org> on 2007/04/27 15:43:24 UTC

Keeping module docs in modules

Hi Lenya devs,

keeping the module docs up to date is IMO likely to become
a PITA. I can imagine that this will be easier if the doc files are
kept in the modules themselves (e.g., $MODULE_HOME/docs).
We could assemble them using Ant (maybe forrestbot can do this).

WDYT?

-- Andreas


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


Re: Keeping module docs in modules

Posted by Michael Wechner <mi...@wyona.com>.
Andreas Hartmann wrote:

>Hi Lenya devs,
>
>keeping the module docs up to date is IMO likely to become
>a PITA. I can imagine that this will be easier if the doc files are
>kept in the modules themselves (e.g., $MODULE_HOME/docs).
>We could assemble them using Ant (maybe forrestbot can do this).
>
>WDYT?
>  
>

+1

Michi

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


-- 
Michael Wechner
Wyona      -   Open Source Content Management   -    Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org
+41 44 272 91 61


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


Re: Keeping module docs in modules

Posted by Joern Nettingsmeier <ne...@folkwang-hochschule.de>.
Andreas Hartmann wrote:
> Joern Nettingsmeier schrieb:
>> Andreas Hartmann wrote:
>>> Hi Lenya devs,
>>>
>>> keeping the module docs up to date is IMO likely to become
>>> a PITA. I can imagine that this will be easier if the doc files are
>>> kept in the modules themselves (e.g., $MODULE_HOME/docs).
>>> We could assemble them using Ant (maybe forrestbot can do this).
>>>
>>> WDYT?
>> +INF
>>
>> i'd love to see all highly code-dependent information directly in the
>> trunk, and the website should pull it automatically.
>>
>> when we finally move to "eating our own dogfood", that will be
>> interesting, because currently lenya is not too good at tapping into
>> external data (cocoon is, but you lose many cool cms features).
> 
> Well, Lenya is not a documentation generation system ...
> If we decide to use Lenya for the website, we'll probably have
> the module docs in a common repository. It won't be necessary
> anymore to keep them in the modules because it's easy enough to
> edit them in the CMS :)

hmm. i prefer editing files while i'm in hack mode...
-- 
jörn nettingsmeier

home://germany/45128 essen/lortzingstr. 11/
http://spunk.dnsalias.org
phone://+49/201/491621

Kurt is up in Heaven now.

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


Re: Keeping module docs in modules

Posted by Andreas Hartmann <an...@apache.org>.
Joern Nettingsmeier schrieb:
> Andreas Hartmann wrote:
>> Hi Lenya devs,
>>
>> keeping the module docs up to date is IMO likely to become
>> a PITA. I can imagine that this will be easier if the doc files are
>> kept in the modules themselves (e.g., $MODULE_HOME/docs).
>> We could assemble them using Ant (maybe forrestbot can do this).
>>
>> WDYT?
> 
> +INF
> 
> i'd love to see all highly code-dependent information directly in the
> trunk, and the website should pull it automatically.
> 
> when we finally move to "eating our own dogfood", that will be
> interesting, because currently lenya is not too good at tapping into
> external data (cocoon is, but you lose many cool cms features).

Well, Lenya is not a documentation generation system ...
If we decide to use Lenya for the website, we'll probably have
the module docs in a common repository. It won't be necessary
anymore to keep them in the modules because it's easy enough to
edit them in the CMS :)

-- Andreas


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


Re: Keeping module docs in modules

Posted by Joern Nettingsmeier <ne...@folkwang-hochschule.de>.
Andreas Hartmann wrote:
> Hi Lenya devs,
> 
> keeping the module docs up to date is IMO likely to become
> a PITA. I can imagine that this will be easier if the doc files are
> kept in the modules themselves (e.g., $MODULE_HOME/docs).
> We could assemble them using Ant (maybe forrestbot can do this).
> 
> WDYT?

+INF

i'd love to see all highly code-dependent information directly in the 
trunk, and the website should pull it automatically.

when we finally move to "eating our own dogfood", that will be 
interesting, because currently lenya is not too good at tapping into 
external data (cocoon is, but you lose many cool cms features).

-- 
jörn nettingsmeier

home://germany/45128 essen/lortzingstr. 11/
http://spunk.dnsalias.org
phone://+49/201/491621

Kurt is up in Heaven now.

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


Re: Keeping module docs in modules

Posted by Thorsten Scherler <th...@apache.org>.
On Fri, 2007-04-27 at 15:43 +0200, Andreas Hartmann wrote:
> Hi Lenya devs,
> 
> keeping the module docs up to date is IMO likely to become
> a PITA. I can imagine that this will be easier if the doc files are
> kept in the modules themselves (e.g., $MODULE_HOME/docs).
> We could assemble them using Ant (maybe forrestbot can do this).
> 

Yeah, sounds nice will think about how we can implement it and report
back.

salu2
-- 
Thorsten Scherler                                 thorsten.at.apache.org
Open Source Java                      consulting, training and solutions


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


Re: Keeping module docs in modules

Posted by Andreas Hartmann <an...@apache.org>.
Andreas Hartmann schrieb:
> Hi Lenya devs,
> 
> keeping the module docs up to date is IMO likely to become
> a PITA. I can imagine that this will be easier if the doc files are
> kept in the modules themselves (e.g., $MODULE_HOME/docs).
> We could assemble them using Ant (maybe forrestbot can do this).

Another advantage is that you can easily build your own custom
documentation if you use custom modules.

-- Andreas


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