sourceforge_for_collaborative_development_of_summary_docs

This is part of The Pile, a partial archive of some open source mailing lists and newsgroups.



Subject: Re: Feature sets [was Re: Templating System]
From: Perrin Harkins <perrin@primenet.com>
Date: Thu, 3 Aug 2000 11:36:26 -0700 (PDT)

On Thu, 3 Aug 2000, Drew Taylor wrote:
> > Gunther, has anyone found a good home for such a comparison to be
> > hosted?  It would be cool if it were at perl.apache.org, or even better
> > at www.perl.com or something (since it's not mod_perl specific).  As
> > long as it's easily updatable by its maintainers (and who are they?).
> 
> Excellent question. I was planning to initially host the document on my
> home page. But I'm sure that wouldn't last for too long. I guess the
> initial maintainer would be me, but I would have no problem expanding
> that list in the future. Which brings up the question - how would it be
> maintained? CVS? I'm all ears...

Let's create a http://sourceforge.net project for it, which will give us
an instant CVS and mailing list (for people working on the documents), and
allow everyone to see the work in progress.  Once it's together, we can
figure out how to get onto perl.com and/or perl.apache.org.

===




Subject: Re: Feature sets [was Re: Templating System]
From: Stas Bekman <stas@stason.org>
Date: Thu, 3 Aug 2000 20:55:45 +0200 (CEST)

On Thu, 3 Aug 2000, Perrin Harkins wrote:
> 
> Let's create a http://sourceforge.net project for it, which will give us
> an instant CVS and mailing list (for people working on the documents), and
> allow everyone to see the work in progress.  Once it's together, we can
> figure out how to get onto perl.com and/or perl.apache.org.

Documentation maintenance is a different process from code
maintenance.  I'm telling this on the base of working on the
guide in the last 1.5 years (http://perl.apache.org/guide). 
The maintainer is responsible for keeping the document clean
and consistent.

Therefore it really makes things better if there is an owner
of the documentation project and people submitting the
patches to him or her.

Drew, once you get an initial doc, we will give you a CVS
access to the modperl-site repository, which is given to all
people who do significant contribution to the project. It
shouldn't take a long time.

If in the future you will not be able to maintain someone
else would do that, so there is no problem with that.

Forking the project onto another server isn't really a good
idea.

===

Subject: Re: Feature sets [was Re: Templating System]
From: Stas Bekman <stas@stason.org>
Date: Thu, 3 Aug 2000 21:57:21 +0200 (CEST)

Stas Bekman wrote:
> > 
> > On Thu, 3 Aug 2000, Perrin Harkins wrote:
> > 
> > > On Thu, 3 Aug 2000, Drew Taylor wrote:
> > > > > Gunther, has anyone found a good home for such a comparison to be
> > > > > hosted?  It would be cool if it were at perl.apache.org, or even better
> > > > > at www.perl.com or something (since it's not mod_perl specific).  As
> > > > > long as it's easily updatable by its maintainers (and who are they?).
> > > >
> > > > Excellent question. I was planning to initially host the document on my
> > > > home page. But I'm sure that wouldn't last for too long. I guess the
> > > > initial maintainer would be me, but I would have no problem expanding
> > > > that list in the future. Which brings up the question - how would it be
> > > > maintained? CVS? I'm all ears...
> > >
> > > Let's create a http://sourceforge.net project for it, which will give us
> > > an instant CVS and mailing list (for people working on the documents), and
> > > allow everyone to see the work in progress.  Once it's together, we can
> > > figure out how to get onto perl.com and/or perl.apache.org.
> > 
> > Documentation maintenance is a different process from code maintenance.
> > I'm telling this on the base of working on the guide in the last 1.5
> > years. The maintainer is responsible for keeping the document clean and
> > consistent.
> > 
> > Therefore it really makes things better if there is an owner of the
> > documentation project and people submitting the patches to him or her.
> > 
> > Drew, once you get an initial doc, we will give you a CVS access to the
> > modperl-site repository, which is given to all people who do
> > significant contribution to the project. It shouldn't take a long time.
> Sounds great. Hopefully I will be able to have a first version out this
> weekend. I have been slammed at work this week, so I'll most likely be
> doing the writing on my personal time. I'll post when & where the first
> draft will be located. After that we can talk CVS.

Sure, no problem. One of the current cvs access holders can commit the
first release for you, and then you will be able to continue by
yourself. Obviously getting all the support that you might need on the
way.

I hope that you write the doc is POD :)

> BTW, you probably don't remember me, but we briefly met at ApacheCon and
> I attended your mod_perl classes there (and enjoyed them). :-)

:) 

===

Subject: Re: Feature sets [was Re: Templating System]
From: Perrin Harkins <perrin@primenet.com>
Date: Thu, 3 Aug 2000 17:10:51 -0700 (PDT)

On Thu, 3 Aug 2000, Drew Taylor wrote:
> Having recently discovered the joy of CVS, I look forward to it. Awfully
> nice to able to roll back to a previous version - although (knock on
> wood!) I haven't had to use it yet.

I can help if you get stuck.

> > I hope that you write the doc is POD :)
> 
> I suppose I could... I was planning on having a nice checklist of
> features/systems that would be a pain to do in a fixed width font. An
> HTML table would make my life MUCH easier there. Is there something in
> POD that makes tables easier?

Write the text in POD, and put the checklist data in with some neutral
format.  Then we can use a customized pod2html converter on it to generate
a pretty table.  XML would be a nice way to store the raw data.  This
might end up being kind of big for an in-line, so we could do something
like "=table data_file.xml" and keep it in a separate file.  (Or is it
better to use "=for html" and put the rest inside that, so that it still
passes syntax checks for standard POD?)

Stas, do you have code available for the guide generator?  That might come
in handy.

Drew, if this all sounds like too much trouble for the first draft and you
already started in HTML, I'd say just finish that up and we'll distill it
into POD later.  (html2pod?)

===

Subject: Re: Feature sets [was Re: Templating System]
From: ___cliff rayman___ <cliff@genwax.com>
Date: Thu, 03 Aug 2000 17:07:18 -0700

sounds like we need a good templating system to do this for us.
anyone know a good templating system?
sorry - couldn't resist.  :-))


===

Subject: Re: Feature sets [was Re: Templating System]
From: merlyn@stonehenge.com (Randal L. Schwartz)
Date: 03 Aug 2000 17:33:30 -0700

Drew" == Drew Taylor <dtaylor@vialogix.com> writes:

Drew> I suppose I could... I was planning on having a nice checklist of
Drew> features/systems that would be a pain to do in a fixed width font. An
Drew> HTML table would make my life MUCH easier there. Is there something in
Drew> POD that makes tables easier?

Why don't you write it as XML, then use Template::Toolkit and the DOM
interface to generate what you want.

/me shows hint of bias

:-)

===

Subject: Re: Feature sets [was Re: Templating System]
From: Matt Sergeant <matt@sergeant.org>
Date: Fri, 4 Aug 2000 08:00:21 +0100 (BST)

On 3 Aug 2000, (Randal L. Schwartz) wrote:

> >>>>> "Drew" == Drew Taylor <dtaylor@vialogix.com> writes:
> 
> Drew> I suppose I could... I was planning on having a nice checklist of
> Drew> features/systems that would be a pain to do in a fixed width font. An
> Drew> HTML table would make my life MUCH easier there. Is there something in
> Drew> POD that makes tables easier?
> 
> Why don't you write it as XML, then use Template::Toolkit and the DOM
> interface to generate what you want.

Or XML::Simple with TT...

Anyway, I've got a Pod::DocBookXML here somewhere if you want it. That
would allow all authoring in POD, with =for docbook sections doing the
tables. (of course you could do that with HTML too).

===



the rest of The Pile (a partial mailing list archive)

doom@kzsu.stanford.edu