cocoon-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Crossley <cross...@indexgeo.com.au>
Subject RE: reg c2 documentation HOW DO I
Date Sat, 18 Aug 2001 08:13:23 GMT
I fully agree with you Luca. I was trying to sort out
a procedure for handling discussion on the development
of each HOWTO topic. I was not proposing that the final
FAQs be stored on the mailing list. I agree that the actual
QandA entries do belong in the Cocoon2 documentation set.
Others should be free to build their own FAQ collections
if they choose. However, the ideal is to have the main
FAQ repository at Apache Cocoon.

OK, let us assume that we can design and manage a large
FAQ document collection using the Cocoon documentation
format. Then how would we go about developing the content?
I feel that can only be gleaned from discussion that has
occurred on the two cocoon mailing lists.

I look forward to this thread leading to a good solution
for FAQs, because that is definitely needed.

I actually see that the Cocoon documentation may be
cumbersome for management of such a collection. One subject
per page with a reasonable number of topics on each subject
should work. It would need a front index page linking to
each subject page. One large page FAQ like Cocoon1 was
not a workable solution.

cheers, David Crossley

---------------------------------------
> Date: Sat, 18 Aug 2001 09:57:10 +0200
> From: "Luca Morandini" <l.moran@tin.it>
>
> David,
> 	your idea is interesting, but, on the other hand, a mailing list is not
> suited to host FAQs, since it would store obsolete/wrong ones as well, it
> will still need human intervention to sort out the messages.
> 
> 	Moreover, It's quite easy to send new FAQ entries to the Cocoon2 site
> itself.
> 
> 	Hence, I can't see the need for a new FAQ site (or for a mailing list
> enriched by HOWTOs). It would be much better, in my eyes, to make the
> Cocoon2 site richer than spawn new ones.
> 
> Best regards,
> á
> ---------------------------------------------
> áááááááááááááá Luca Morandini
> áááááááááááááá GIS Consultant
> ááááááááááá lmorandini@ieee.org
> ááááááááá +39 0744 59á 85á 1 Office
> ááááááááá +39á0335 681 02 12 Mobile
> http://utenti.tripod.it/lmorandini/index.html
> ---------------------------------------------
> 
> 
> > -----Original Message-----
> > From: David Crossley [mailto:crossley@indexgeo.com.au]
> > Sent: sabato 18 agosto 2001 5.47
> > To: cocoon-users@xml.apache.org
> > Subject: reg c2 documentation HOW DO I
> >
> >
> > I see a good solution that will build upon your proposal
> > to develop FAQ collections. This solution would utilise
> > the power of the cocoon-users community to maintain it
> > and would ensure accurate FAQ entries.
> >
> > Interested people would post their topic to the list
> > in the usual manner and discussion would ensue on that
> > thread. Prepend the Subject with the tag HOWTO:
> > Use a concise yet descriptive subject title.
> >
> > In that way, *anyone* who wants to build an FAQ collection
> > (e.g. you) can glean accurate and up-to-date discussion
> > directly from the list archives.
> >
> > This approach obviously has many benefits, some are:
> > * discussion remains in one central mailing list and
> > so the threads can be followed as per normal
> > * the cocoon-users group can immediately benefit and
> > will be able to contribute to developing the solution
> > * anyone can utilise the HOWTO threads to build their
> > own collections of frequently asked questions
> > * one can even build a local email FAQ archive by using
> > an email client to filter the list broadcast based on title
> > * some relevant HOWTOs can also be added to the Apache
> > Cocoon documentation using the Contrib method (see below)
> > * search engines can utilise the HOWTO content in the
> > mail archives to provide another discovery mechanism
> > * use the power of search engines to restrict the search
> > to documents containing HOWTO in the title
> > * your FAQ collection can even link directly to the
> > relevant discussion thread in the archives.
> >
> > Plea to cocoon-users: use well chosen words for your
> > email messages (especially a descriptive subject line).
> > Search engines thrive on good content. Also, as this is
> > a voluminous list - we need to be able to glance through
> > the list of titles. Postings with inappropriate subject
> > lines will get missed.
> >
> > Your message below refers to the cocoon website and
> > documentation as being "official". Remember that this
> > is an open source project - no officialdom is involved.
> > Everyone and anyone can partake. So some important FAQs
> > will obviously end up in the main documentation set.
> > Anyone can and should contribute those, using the
> > procedure described in the document contrib.html - you
> > need the current Dev Snaphot or cvs checkout (see bottom
> > on the Cocoon site side-bar).
> >
> > So, who is going start the first HOWTO topic thread?
> >
> > regards, David Crossley
> >
> > -----------------------------------
> > >>> java guru at Thu, 16 Aug 2001 21:33:47 +0100 (BST) <<<
> > No offense..But i would love to have the things listed
> > in official faq..but there are tons of things that
> > people are asking on this list repeatedly for which
> > there are two really simple answers..
> >
> > 1. Please search thru the mailing list archive
> > 2. Read the documentation..
> >
> > Honestly, these answers are absolutely proper in their
> > own right. As i mentioned before, the documentation
> > mentioned at the official site is very vast and
> > sufficient..But still people ask "how can do ..."
> > For example, how many time users have asked repeatedly
> > about "How do i run my c2 without running full X
> > server"?..
> >
> > May be i am wrong in my perception...just a thought..
> >
> >  --- Luca Morandini <l.moran@tin.it> wrote: >
> > > I beg your pardon, but... why set up another site,
> > > while we can easily add entries to the official Cocoon FAQ ?
> > >
> > > Best regards,
> > >
> > > P.S.
> > > I wrote a couple of FAQ entries myself... I've just
> > > sent them to Davanum
> > > Srinivas [dims@yahoo.com] and he took care of
> > > putting it (in style :) ) into
> > > the Cocoon2 FAQ: real easy.
> > >
> > > ---------------------------------------------
> > >                Luca Morandini
> > >                GIS Consultant
> > >             lmorandini@ieee.org
> > >           +39 0744 59  85  1 Office
> > >           +39 0335 681 02 12 Mobile
> > > http://utenti.tripod.it/lmorandini/index.html
> > > ---------------------------------------------
> > >
> > > > -----Original Message-----
> > > > From: java guru [mailto:javacocoon@yahoo.co.in]
> > > > Sent: giovedý 16 agosto 2001 16.01
> > > > To: cocoon users
> > > > Subject: reg c2 documentation HOW DO I
> > > >
> > > > Hi Guys.,
> > > > This is regarding quick HOW DO I documentation for
> > > > cocoon2.
> > > >
> > > >   I would like to contribute/host documentation on
> > > > various topics related to c2. I thank the c2 team for
> > > > keeping up with the clear and vast documentation and
> > > > faq on the xml.apache.org site. But as human nature,
> > > > we tend to look for *something-in-one-hour* quick
> > > > receipe books/material.
> > > > So I thought how about compiling our "cocoon-users"
> > > > experiences with c2 into "HOW DO I" receipe.
> > > >
> > > > All of you interested in sharing your experience with
> > > > community are welcomed to write your own story about
> > > > HOW DO I..and send to me for hosting..
> > > >
> > > > Please advice if any such efforts are on the way so
> > > > that the work is not duplicated...
> > > >
> > > > If you decide to give back something to our
> > > > community..please follow few tips
> > > >
> > > > 1. Write the document in any style you want.
> > > > 2. Please dont hesitate to write little details also..
> > > > 3. Please mail to javacocoon@yahoo.co.in with subject
> > > > HOW DO I.
> > > > 4. Please mention your name and/or contact email as i
> > > > can mention that HOW DO I as your experience.
> > > > 5. Please take some time and provide some solid
> > > > examples(code prefered)..
> > > >
> > > > And finally all advices regarding this are highly
> > > > appreciated..
> > > > Thanks everyone..
> > > > =====
> > > > Thanks and have great day
> > > > srini

---------------------------------------------------------------------
Please check that your question has not already been answered in the
FAQ before posting. <http://xml.apache.org/cocoon/faqs.html>

To unsubscribe, e-mail: <cocoon-users-unsubscribe@xml.apache.org>
For additional commands, e-mail: <cocoon-users-help@xml.apache.org>


Mime
View raw message