I'm in favor of the distributed documentation. It should also make maintaining the docs a little more straightforward.
Cheers, nick On 9/20/03 3:40 PM, "Vincent Massol" <[EMAIL PROTECTED]> wrote: > Hi, > > I'd like to do some brainstorming on how we want to manage the Cactus > documentation in the future. ATM, we have a monolithic documentation/ > project which contains the full documentation for all modules. > > Note: The modules are: framework, samples/servlet, samples/jetty, > samples/ejb, integration/ant, integration/eclipse/*, etc > > There is another way of doing this, by distributing the documentation to > the respective modules: the documentation related to the framework will > go in the framework module, etc. And the general documentation will go > in the master project (whatever we want to call it). > > Something like: > > jakarta-cactus > |_ framework > |_ xdocs > |_ [doc related to the framework module] > |_ [other modules] > |_ xdocs > |_ [general master docs] > > The published website, would also mirror this: > > /www/jakarta.apache.org/cactus/[version] > |_ [general master docs] > |_ framework > |_ [doc related to the framework module] > > In my opinion, the advantages are: > > - each module is self-contained and standalone (in term of artifacts it > generates, build, and in term of documentation), thus leading in a more > modular build (and more scalable) > > - it will allow to easily move to a Maven build (which require this > structure to work as is - Otherwise, we won't be able to easily benefit > from a lot of the nice features related to documentation and reports) > > - Cactus has moved from a single project to modules which are now > clearly identified. Moving the documentation is the last step in this > direction. > > Any disadvantage? > > What do you think? > > Thanks > -Vincent > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
