Mailing-List: contact dev-help@geronimo.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@geronimo.apache.org
Received-SPF: pass (asf.osuosl.org: domain of eljotpl@gmail.com designates
 66.249.82.204 as permitted sender)
DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws;
        s=beta; d=gmail.com;
        h=received:message-id:date:from:to:subject:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references;
        b=rZam57tLHl5ZH3xmX1eLDiELDB0whM4xLIJ2T46gDnE0SjeIeqx5Ab1LwfDm0BcUmyLiToemYvIgk6T6aH+r8vi4isrEbOd9YtosCMSLK2vERL7Sa3QDFiVXT7cxb10TDz2xJ4dWwu6VkjdbJRUTAZZReUy0s/GhdV+9ROTrDz0=
Message-ID: <1b5bfeb50601240029t57261178q@mail.gmail.com>
Date: Tue, 24 Jan 2006 09:29:15 +0100
From: Jacek Laskowski <eljotpl@gmail.com>
To: dev@geronimo.apache.org
Subject: Re: [VOTE] Documentation in Confluence, MoinMoin, or..
In-Reply-To: <43D44B07.2000901@pobox.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline
References: <43D0F56E.2020305@Golux.Com> <43D44B07.2000901@pobox.com>

2006/1/23, Geir Magnusson Jr <geir@pobox.com>:
> I don't understand - The need for documentation under source control is
> important, and we need to find a solution that ensure that is possible.
>
> I think that a documentation system should be a combination of
>
> - reasonably easy to use
> - versionable
> - able to be used offline
> - extractable into an open and transformable format for reuse
>
> Wikis that I've used fail on #2, #3 and #4.

Hi Geir,

Isn't it an issue for the whole Apache org? Haven't I seen some emails
about it on general@incubator recently? I think it's not only us who
straggle with the issue and I'd be very pleased to have some sort of
Confluence with SVN support so that content could be easily made
offline and committed to a repo *and* the the same time introduce
changes thru Confluence and have them checked into the repo, too.

> I'm also curious about how in-code documentation can be integrated, via
> something like Doxygen or -ish.

I don't know it at all. Do you have any insights on its features?
Something you know after having worked with it for a while?

> I realize the clear majority is for Confluence, but these factors should
> be considered.

Absolutely! (but shame on me since I had not as I had voted).

Off looking for some information about Doxygen...

> geir

--
Jacek Laskowski
http://www.laskowski.org.pl