Re: [ModuleStatus] First idea (was Re: Spring cleaning: Remove unmaintained modules?)

[Andreas Hartmann <an...@apache.org>]

Florent André schrieb:

[…]

> === Patch to Module.xml ===
> 
> * The idea is to add some tags in order to have "dev status" of each
> module.
 >
> <module xmlns="http://apache.org/lenya/module/1.0">
> <moduleinformations>
>   <objectives> describe why do this module </objective>
>   <longdescription> description that is show to end user</longdescription>
>   <curentstate> dev / usable with care / stable / ... </curentstate>
> </moduleinformations
> <technicalinformations>

I wouldn't require to change the structure of existing elements 
(backwards compatibility).

>   <id>org.apache.lenya.modules.ac</id>
>   <export package="..."/>
>   <depends module="..."/>
>   <package>org.apache.lenya.modules</package>
>   <version>0.1-dev</version>
>   <name>Access control</name>
>   <lenya-version>@lenya.version@</lenya-version>
>   <description>Access control</description>
> </technicalinformations>
> <statusinformations>
>   <curentversion>
>     <developers>
>       <person name=".." email="..." id="DB"/>
>     </developers>
>     <problems> (or warning?)
>       <problem priority=".."> knowing problems </problem>
>     <problems>
>     <changes>
>       <release version="2.1.12" date="..">
>         <action dev="all" type="update">
>       </release>
>     </change>
>     <howtoinstall> installation instructions if any </howtoinstall>
>     <howtouse> how to use module's functions or module's interface
> </howtouse>
>   </curentversion>

The "future versions" section can IMO be omitted, we have bugzilla for 
this purpose.

>   <futureversion>
>     <roadmap>
>       <release version="...">
>         <functionality name=".." context="..">
>           <description> description of the function </description>
>           <codingpointers> 
>              <codingpointer>
>              idea to implement/improve the function, in order to help the
> man who do the code 
>              </codingpointer>
>            </codingpointers>
>        </release>
>      </roadmap>
>   <futureversion>
> </module>
> 
> Some of this tags are inspired by the cocoon file :
> apache-lenya-2.0.2-src/externals/cocoon_2_1_x/status.xml

Maybe the Maven POM would be another alternative?

http://maven.apache.org/pom.html#More_Project_Information

I really hope we'll move to Maven someday, this might simplify the 
migration.

> Maybe this proposal is a little bit complicated, but I think that this
> informations will be useful for potential co-dev and for (end-)user  : see
> what is the module spirits, his status and his future capabilities.

Is it realistic to assume that this information will be added? Well, I 
guess we'll see :)

[…]

> === SVN browsing ===
> 
> Andreas : "ATM the code to update the SVN changes is in the forrest module,
> which is rather confusing. I think we should create a new module for this
> purpose."
> ==> @andreas : Do you have a pointer (class or pipeline name) to the code
> in the forrest module ?

Sure, this is the usecase which updates the changes:

http://svn.apache.org/viewvc/lenya/docu/modules/forrest/java/src/org/apache/lenya/modules/forrest/UpdateChanges.java?view=log

-- Andreas


-- 
Andreas Hartmann, CTO
BeCompany GmbH
http://www.becompany.ch
Tel.: +41 (0) 43 818 57 01


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