pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Neil Conway <neilc@samurai.com>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Josh Berkus <josh@agliodbs.com>
Cc: pgsql-hackers@postgresql.org, Albert Cervera i Areny <albert@nan-tic.com>
Cc: pgsql-docs@postgresql.org
Subject: Re: [HACKERS] Contrib modules documentation online
Date: Wed, 29 Aug 2007 11:18:44 -0700
Message-ID: <1188411524.32003.6.camel@dell.linuxdev.us.dell.com> (raw)
In-Reply-To: <7046.1188410001@sss.pgh.pa.us>
References: <200708290157.07968.albert@nan-tic.com>
	<200708291009.07942.josh@agliodbs.com>
	<7046.1188410001@sss.pgh.pa.us>

On Wed, 2007-08-29 at 13:53 -0400, Tom Lane wrote:
> Why wouldn't we just remove the README files altogether?  I can't
> see maintaining duplicate sets of documentation.

I agree that duplication is bad, but I think README files in the
individual contrib directories is useful and worth keeping: if I'm about
to install a contrib module and want to learn how to install and use it,
this change would only make that information *more* difficult to find.

I wonder if it would be possible to keep the master version of the
contrib docs as SGML, and generate plaintext READMEs from it during the
documentation build.

-Neil





view thread (29+ messages)  latest in thread

Message-ID: <1188411524.32003.6.camel@dell.linuxdev.us.dell.com>
Permalink:  ../1188411524.32003.6.camel@dell.linuxdev.us.dell.com/
Also on:    postgresql.org/message-id/1188411524.32003.6.camel@dell.linuxdev.us.dell.com

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: neilc@samurai.com, tgl@sss.pgh.pa.us, josh@agliodbs.com, albert@nan-tic.com
  Subject: Re: [HACKERS] Contrib modules documentation online
  In-Reply-To: <1188411524.32003.6.camel@dell.linuxdev.us.dell.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox