On Tue, 5 Dec 2000, Matt Sergeant wrote:
> On Tue, 5 Dec 2000, Stas Bekman wrote:
>
> > Since we have already started working on mod_perl-2.0, I wanted to get in
> > early and provide the base for the one and only source of mod_perl
> > documentation. These are the things that I see important:
> >
> > 1. *All* pods located under one roof. API, Installation, Configuration,
> > Tips, Trick and more.
>
> Is the guide the best place for tips and tricks? Its certainly the best
> place for hard-core installation configuration and other stuff, but often
> tips and tricks focus on one particular technology. Are we missing out on
> having a place to store smaller tips and tricks (you know where I'm
> thinking of keeping them...) ?
You can always reproduce them at will, I'm advocating the one and only
source. There is too much confusion with the way things are
now. Especially for newbies.
> > 2. Automatic retrieval of pods sections from .pm files and integration in
> > the documentation tree.
>
> Is that really necessary? I assume you mean having the Apache.pm docs as
> part of the guide, and the mod_perl*.pod files also?
Absolutely, the current guide has lots of things duplicated with Apache.pm
docs and the mod_perl*.pod, because it tries to be complete (well the only
thing it doesn't attempt to cover is API). All we need is a well-thought
layout that will make the use and maintenance easy.
> > 3. Automatic generating of html/ps/pdf/other formats. (html/ps/pdf are
> > already working in the guide, other formats to come).
>
> What other formats do you think people want/need?
I don't know. Just trying to keep things open. As suggested in another
reply WAP formats (or the new ones replacing WAP)
> > 5. Commit rights. Should be available for all mod_perl committers, one or
> > more persons will be responsible for keeping the healthy layout of the
> > documentation, review documentation commits. Pretty much making it a
> > real community project and not Stas Bekman's project.
>
> /me spies the ulterior motive behind that :-)
No motives, it's too good to be Stas Bekman :) Others should be able to
join, and contribute more, without having my shade over their head.
> > 6. Mailing list (or reuse of cvs list) for corrections/contributions
>
> Is there anything wrong with using this list for that?
Yes, you don't see all the corrections that I receive in my personal
email. There are quite many of them at times. It'll create unneccesary
traffic for those who aren't interested in these corrections. Believe me I
know what I'm saying here :)
Another item that I've forgotten about, is someone who watches the list
(it was me until now and it's still me) and pickes new problems and their
solutions, new technological tips and tricks and other important stuff
that need to end up in the documentation and not only in the list
archives. Geoff is doing a great job providing the summaries, but someone
is to write down the real details.
> > 7. The relevant parts from the current guide is to be merged into the new
> > guide and eventually freezed as mod_perl-2.0 will become the main product,
> > and mod_perl-1.x will be not supported anymore (I suppose a few years from
> > now).
>
> We probably need to keep two separate projects, going on what is known
> about mod_perl 2.0 so far.
Sure, as I said the 1.x will not die in the next few years. So once
mod_perl 2.0 goes live, /guide will point to the new guide and /guide-1.x
will have the old guide available.
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:[EMAIL PROTECTED] http://apachetoday.com http://jazzvalley.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
