Date: Wed, 29 Aug 2007 12:43:39 -0500
From: Decibel! <decibel@decibel.org>
To: Josh Berkus <josh@agliodbs.com>
Cc: pgsql-hackers@postgresql.org, Albert Cervera i Areny <albert@nan-tic.com>,
	pgsql-docs@postgresql.org
Subject: Re: [HACKERS] Contrib modules documentation online
Message-ID: <20070829174339.GJ1386@nasby.net>
References: <200708290157.07968.albert@nan-tic.com>
	<200708291009.07942.josh@agliodbs.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="aSMWOr4h/ZU3vZ/E"
Content-Disposition: inline
In-Reply-To: <200708291009.07942.josh@agliodbs.com>
User-Agent: Mutt/1.5.13 (2006-08-11)


--aSMWOr4h/ZU3vZ/E
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Wed, Aug 29, 2007 at 10:09:07AM -0700, Josh Berkus wrote:
> Albert,
>=20
> (crossed over to -docs, where it really belongs)
>=20
> > I've been working on converting the current README files for all contrib
> > modules into sgml and add it to the documentation. There are still some
> > fixes to do but i'd like to have some feedback. Indeed, it wasn't agree=
d to
> > have all if any of the modules together with the core documentation.
> >
> > You can see the docs on [1] in chapter VIII. If you think these could b=
e a
> > good addition, please fill free to comment on how you think sections sh=
ould
> > be organized to be consistent and easy to read.
> >
> > [1] http://www.nan-tic.com/ftp/pgdoc
>=20
> Wow, this is really, really cool!  You're my hero.
>=20
> I'm very strongly in favor of having this documentation.  However, I thin=
k it=20
> might make sense to put "Contrib Modules" as a section under either=20
> "Reference" or "Appendices".  Also, I don't think it's necessary to make =
each=20
> command option a separate subchapter, but I can see how that would be har=
d to=20
> avoid in an automated system. =20
>=20
> Guys, would it be out of the question to do this in 8.3?  Please please?
>=20
> If we go ahead with this, I'll commit to doing a contrib README cleanup s=
o the=20
> doc system works better.

One question... would there still be a README in each contrib directory?
I think getting this stuff in the docs is great, but the README in the
source is also very valuable and I'd hate to lose it.
--=20
Decibel!, aka Jim Nasby                        decibel@decibel.org
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)

--aSMWOr4h/ZU3vZ/E
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.3 (FreeBSD)

iD8DBQFG1bBLdO30qud8SkgRAhffAKC4La/9VbUj7MUi2zHIyqFoLBP+AwCgyI3c
Jw0g/K9J/jF6gAXeBmUFAiM=
=FkA0
-----END PGP SIGNATURE-----

--aSMWOr4h/ZU3vZ/E--