struts-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jonathan Asbell" <jasb...@i-2000.com>
Subject Re: *TED* - round 2 of documentation
Date Sun, 08 Jul 2001 16:36:36 GMT
Ok so whats next?

PS. see visual to be included in my explanation


----- Original Message -----
From: "Ted Husted" <husted@apache.org>
To: <struts-dev@jakarta.apache.org>
Sent: Sunday, July 08, 2001 10:30 AM
Subject: Re: *TED* - round 2 of documentation


> We can hyperlink within a PDF. I was thinking it would be listed on it's
> own above the Users Guide, so people would tend to read it first.
>
> Home
> Brochure (PDF)
> Users Guide
> Resources
> Who We Are
> Installation
> Release Notes (nightly)
> Release Notes (1.0)
> TODO list (1.1)
>
> But to keep the brochure non-technical, we should probably move the
> Struts Component overview into the Users Guide. Especially since you
> mentioned that this part wasn't helpful to your developers as part of a
> quick start. ("Struts in a NY minute" ;-)
>
> I agree that the installation page should be refactored, but we might to
> keep that separate from the brochure.
>
> As mentioned, I would especially like to see the installation
> instructions turned upside down, so that people are encouraged to start
> with the WARs, Struts JAR, and the blank application before trying to
> build it from scratch. In practice, I'd say most people may write an
> application or three before needed to actually build Struts for anything
> (if ever).
>
> Jonathan Asbell wrote:
> >
> > One thing to think about is that it may be good to have links so a
reader
> > can jump around.  I'm not sure if this can be done with PDF.
> >
> > Also, are you suggesting to make it downloadable AND part of the user
guide?
> > Thats fine if it can actually stand on its own without references to
other
> > parts of the user documentation.
> >
> > I still have to create some visuals for this stuff anyway.  Also, I need
to
> > do an explanation of the "web.xml" and "struts-config.xml" file
contents,
> > and a very brief but clear, idot-proof, explanation of MVC and how it
fits
> > in struts.  This way java develpers who are green behind the ears wont
run
> > away frustrated like they do with other packages and frameworks.  The
whole
> > point is that we want EVERYONE to be able to use it and play with it.
With
> > that said, I think you just have to make sure that people can read this
> > basic information first
>

Mime
View raw message