pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Tom Lane <tgl@sss.pgh.pa.us>
To: Bruce Momjian <bruce@momjian.us>
Cc: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Re: Doc reference of contrib modules
Date: Mon, 24 Jan 2011 19:06:56 -0500
Message-ID: <28232.1295914016@sss.pgh.pa.us> (raw)
In-Reply-To: <201101242007.p0OK72X22102@momjian.us>
References: <201101242007.p0OK72X22102@momjian.us>

Bruce Momjian <bruce@momjian.us> writes:
> Now that our /contrib documentation is in our SGML manual, I want to
> update our docs to link to the actual contrib module documentation,
> rather than just referencing contrib/module_name.  We used to have to do
> that when we only had READMEs, but now we can do better.

> Patch attached, and I have a github branch of this too:

This proposed patch seems quite inconsistent.  You have removed the term
"contrib" in some places and not others.  I'm fine with just referring
to stuff as "the so-and-so module" without use of the word "contrib",
but if that's what we're going to do then all the references should look
like that.

Also, I see some places where you removed the word contrib *without*
turning the reference into a link.  I think that's a seriously bad idea,
since it leaves the reader with no hint of where to look in our
thousand-page-plus manual.

			regards, tom lane



view thread (14+ messages)  latest in thread

Message-ID: <28232.1295914016@sss.pgh.pa.us>
Permalink:  ../28232.1295914016@sss.pgh.pa.us/
Also on:    postgresql.org/message-id/28232.1295914016@sss.pgh.pa.us

 · 

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: tgl@sss.pgh.pa.us, bruce@momjian.us
  Subject: Re: Doc reference of contrib modules
  In-Reply-To: <28232.1295914016@sss.pgh.pa.us>

* 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