geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Aaron Mulder" <ammul...@alumni.princeton.edu>
Subject Re: Samples && doc
Date Fri, 30 May 2008 19:42:56 GMT
I would only say maybe consider closely the linking to files in SVN.
The ActiveMQ and ServiceMix sites have been plagued by pages that have
"An error occured.  An administrator has been notified." instead of
critical code samples (which is a lie because clearly the
administrator doesn't get a list of all the broken pages or else
they'd presumably tell someone).  I guess it's because there was some
kind of SVN or connectivity issue when the export ran, but it seems
like whole swaths of pages can get that, and they may need to be
corrected one by one by introducing trivial changes so they get
reexported.  I think it would be better to just paste in the sample
and then provide an SVN link next to it if the reader wants to check
for updates or whatever.

Thanks,
       Aaron

On Fri, May 30, 2008 at 2:04 PM, David Jencks <david_jencks@yahoo.com> wrote:
> I'm not thrilled with  the state of the samples docs so I'm going to spend a
> bit more time and see if I can improve them, as well as cleaning up the
> samples a little more.
>
> 1. remove unnecessary ears (that only contain one module) from the sample
> projects
> 2. have a single "how to build and deploy" page
> 3. trim explanations of "geronimo is a server with features" and similar
> info-free text out of the samples docs
> 4. link to feature explanations in the main docs where possible.
> 5. correct at least the most egregious errors and misstatements.
> 6. link into svn from confluence for code samples whenever possible
>
> We'll see how far I get...  comments welcome.
>
> thanks
> david jencks
>
>

Mime
View raw message