[Erp5-dev] Experimental repository documentation structure

[Rafael Monnerat]

I think that that experimental stuff is really great. In some cases we 
can find some very interesting stuff in there. But I think that create 
too much experimental stuff you can create some parts impossible to 
maintain. IMHO, experimental code stuff should be reviewed and included 
part by part in main code, of course if this case provides a good 
behavior and tested.

Notes that some experimental code can propose a new design of one tool, 
like a new production process or modules that use Linear Programming for 
Optimize Sales (just one example). In these cases can be create a non 
experimental stuff but some real bt5, like "erp5_another_trade" and 
stored at some community repository. (I think NEXEDI can provide it as 
experimental)

I'm not sure if was clear enough because my bad english, but I think 
that the code and documentation should be centralized and merger as much 
as possible, in order to not create unmaintainable parts used by unhappy 
ERP5 clients :) .

Rafael Monnerat


Łukasz Nowak wrote:
> Hello,
> 
> Right now there is only two wikipages documenting experimental related
> repository - one introduction[1] and one for erp5_forge_experimental
> Business Template[2].
> 
> As more and more tools appears on this repository (and I really am
> documentation freak ;) ) I'd like to propose documentation system for
> those tools.
> 
> Structure might be quite simple:
>  * HowToUseExperimental - introduction about experimental with
> disclaimers, only one listed on HowTo wikipage
> and links to proper sections - might be merged/based/replace
> ExperimentalRepository wikipage
>  * HowToUseExperimentalForge - documentation for erp5_forge_experimental
>  * HowToUseExperimentalCore - documentation for erp5_core_experimental
>  * HowToUseExperimentalProductExperimental - documentation for
> Products/Experimental
>  * more HowTos for proper projects in experimental repository.
> 
> Projects owners/admins/developers/contributors shall be required to keep
> up to date documentation. As editing wikipages is very easy not too much
> additional work will be needed.
> 
> What do you think about proposed structure? Is it ok to update ERP5
> wiki to such one?
> 
> And more - is it possible to add wikimacro, eg [[ExpDisc]], which will
> show disclaimer about:
>  * how experimental is experimental
>  * that it is totally unsupported (by Nexedi, might even not be
> supported by project owners, etc)
>  * use on your own risk, etc
> 
> Such way every HowToUseExperimental.* page would have this macro on top
> to inform readers what is all about.
> 
> Regards,
> Luke
> 
> [1] http://www.erp5.org/ExperimentalRepository
> [2] http://www.erp5.org/HowToUseExperimentalForge
> 
> PS. What do you think about experimental forge documentation?[2] Is it
> informative enough? I'd like to note, that time consumed on updating
> such documentation is very, very short (read: cheap), I've got some
> positive feedback, but I'd like to know your opinion.
>