From: | Bruce Momjian <bruce(at)momjian(dot)us> |
---|---|
To: | Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> |
Cc: | PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org> |
Subject: | Re: Doc reference of contrib modules |
Date: | 2011-01-25 03:33:04 |
Message-ID: | 201101250333.p0P3X4d19935@momjian.us |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-docs |
[ repost with compressed diff]
Tom Lane wrote:
> Bruce Momjian <bruce(at)momjian(dot)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.
OK, I found a few more places; new patch attached. I also updated
github:
https://github.com/bmomjian/postgres/compare/master...contrib_links
> 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
Well, the only place I did that was with tsearch2, and I had already
linked to it in the paragraph above so it seemed duplicative to do it
again. I did call it "module". You can see the result here:
http://momjian.us/tmp/pgsql/textsearch-migration.html
Suggestions?
--
Bruce Momjian <bruce(at)momjian(dot)us> http://momjian.us
EnterpriseDB http://enterprisedb.com
+ It's impossible for everything to be true. +
Attachment | Content-Type | Size |
---|---|---|
/rtmp/contrib_links.gz | application/x-gzip | 7.1 KB |
From | Date | Subject | |
---|---|---|---|
Next Message | Josh Kupershmidt | 2011-01-25 04:30:58 | Re: Doc reference of contrib modules |
Previous Message | Tom Lane | 2011-01-25 00:06:56 | Re: Doc reference of contrib modules |