geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Nanduri, Amarnath" <>
Subject RE: documentation
Date Wed, 13 Aug 2003 15:11:34 GMT
Hi James,

     I think there should be at least a group of developers that deal
exclusively with the documentation. This group responsibility is to
create extensive documentation of the architecture and what assumptions
were made. My thinking is that any person looking at Geronimo for the
first time should not face any hiccups in installing, implementing and
deploying a J2EE application. The documentation should explain precisely
how to go about doing it by providing a sample application and the steps
involved in building and deploying that application (along with any
configuration changes to be made). My belief is that it will jumpstart
application development on the Geronimo platform as there will be less
hurdles to face.
I would volunteer to be a part of this group. In fact I think we should
have a Volunteer - Topic that deals only with documentation. 

         Also if any person is interested in knowing the internals, they
should have the necessary documentation with UML diagrams in place and
how everything fits together. I suggest that every group specified in
this link
cs take care of the necessary design documentation (of the source code
along with UML diagrams) on the stuff they are working on. This will let
any new person joining the group (to contribute) get a head start on the
design and implementation. This way they will be more productive and
also be encouraged, by having fewer hurdles to cross...

I would love feedback on this. Thanks.


Amarnath Nanduri
AgilQuest Corp.
(ph) 804 745 0467 xt 127

-----Original Message-----
From: James Strachan [] 
Sent: Wednesday, August 13, 2003 10:54 AM
Subject: Re: documentation

So far other than the website, all the documentation is in the code in  
javadoc (not much right now unfortunately!) or on the wiki. The more  
documentation the merrier though.

To add documentation to the wiki - just go right ahead - its a wiki. If

anyone fancies submitting any documentation for the website its in the  
geronimo/xdoc directory as plain HTML for now which generates this....

(it'll be moving to the normal incubator site soonish).

By all means please submit those patches...

On Wednesday, August 13, 2003, at 03:46  pm, Nanduri, Amarnath wrote:

> Has any thought been given to the documentation of the project? By
> documentation, I meant both the source code and the configuration and
> internal workings. If not, I would rather we start putting emphasis on
> it from day 1 to ensure that we put together excellent documentation.
> Any thoughts on this? Thanks
> Cheers,
> Amar..
> Amarnath Nanduri
> AgilQuest Corp.
> (ph) 804 745 0467 xt 127
> -----Original Message-----
> From: []
> Sent: Wednesday, August 13, 2003 10:43 AM
> To:
> Subject: cvs commit:
> incubator-geronimo/modules/twiddle/src/java/org/apache/geronimo/ 
> twiddle/
> util - New directory
> jdillon     2003/08/13 07:42:51
> incubator-geronimo/modules/twiddle/src/java/org/apache/geronimo/ 
> twiddle/
> util - New directory
> A9



View raw message