turbine-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Quinton McCombs" <qmcco...@nequalsone.com>
Subject RE: RFC: Wiki Turbine 2 User's Guide Outline
Date Fri, 14 Mar 2003 18:30:46 GMT
> -----Original Message-----
> From: Chris K Chew [mailto:chris@fenetics.com] 
> Sent: Friday, March 14, 2003 12:14 PM
> To: Turbine Users List
> Subject: RE: RFC: Wiki Turbine 2 User's Guide Outline
> 
> 
> > I have an idea. I think some of the documentation that 
> already exists 
> > gets overlooked by newcomers because it's organized poorly. As an 
> > example, the TDK how-to has some important basics about 
> developing an 
> > app with Turbine, yet people don't read it because it's 
> under TDK on 
> > the site. I'm waiting for a response from Michael C. 
> Starkie regarding 
> > the thread "newbie create new table" to verify this.
> >
> > I suggest we reorganize the docs, although I don't have a specific 
> > recommendation.
> >
> > What do you think?
> 
> Definitely!
> 
> Humberto Hernandez was also speaking earlier this week about 
> improving how we position Turbine, which is certainly 
> something we must do.
> 
> I pretty much envision the user's guide as eventually 
> replacing the majority of the Turbine documentation.  MySQL 
> is a good example, in my opinion.  A single reference manual 
> will increase the likelihood that it remains up-to-date by 
> keeping all the information in one place.
> 
> A manual won't really cater directly to people perusing the 
> site looking for a new framework (although having one will 
> help position Turbine as having good support and a strong 
> community).  Consequently, we would still need additional 
> information geared towards positioning Turbine for potential 
> new users.
> 
> With these in mind, the areas of documentation might be 
> something like:
> 
> *Introductory "Why Use Turbine" Information
> *Quick Start Tutorial (Build a sample app)
> *Maven-generated Information (Changes, javadoc, etc.)
> *Complete Manual (Concepts, Migration, Troubleshooting, Known 
> Issues, etc.
> SEARCHABLE)
> 

Sounds good to me.

> Any thoughts?
> 
> 
> Thanks,
> Chris
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: turbine-user-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: turbine-user-help@jakarta.apache.org
> 
> 

---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-user-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-user-help@jakarta.apache.org


Mime
View raw message