Thread: Get docs for contrib on the web somewhere
It would be nice if there was an easy place to see the documentation for the various contrib projects. Would this be hard to setup? I think the plain text would be fine, just need to post the readme's somewhere and link to them. -- Jim C. Nasby, Sr. Engineering Consultant jnasby@pervasive.com Pervasive Software http://pervasive.com work: 512-231-6117 vcard: http://jim.nasby.net/pervasive.vcf cell: 512-569-9461
On Wed, Mar 08, 2006 at 01:50:47PM -0600, Jim C. Nasby wrote: > It would be nice if there was an easy place to see the documentation > for the various contrib projects. Would this be hard to setup? I > think the plain text would be fine, just need to post the readme's > somewhere and link to them. http://developer.postgresql.org/cvsweb.cgi/pgsql/contrib/ has at least the raw files. I'd be delighted to put up something more, tho :) Cheers, D -- David Fetter david@fetter.org http://fetter.org/ phone: +1 415 235 3778 Remember to vote!
On Wed, Mar 08, 2006 at 02:05:44PM -0800, David Fetter wrote: > On Wed, Mar 08, 2006 at 01:50:47PM -0600, Jim C. Nasby wrote: > > It would be nice if there was an easy place to see the documentation > > for the various contrib projects. Would this be hard to setup? I > > think the plain text would be fine, just need to post the readme's > > somewhere and link to them. > > http://developer.postgresql.org/cvsweb.cgi/pgsql/contrib/ has at least > the raw files. I'd be delighted to put up something more, tho :) Yeah, but very few people would ever think to look in CVS for documentation. I think it'd be much better if we could include the README's in the documentation build process somehow... -- Jim C. Nasby, Sr. Engineering Consultant jnasby@pervasive.com Pervasive Software http://pervasive.com work: 512-231-6117 vcard: http://jim.nasby.net/pervasive.vcf cell: 512-569-9461
On Fri, Mar 17, 2006 at 12:22:44PM -0600, Jim C. Nasby wrote: > On Wed, Mar 08, 2006 at 02:05:44PM -0800, David Fetter wrote: > > On Wed, Mar 08, 2006 at 01:50:47PM -0600, Jim C. Nasby wrote: > > > It would be nice if there was an easy place to see the documentation > > > for the various contrib projects. Would this be hard to setup? I > > > think the plain text would be fine, just need to post the readme's > > > somewhere and link to them. > > > > http://developer.postgresql.org/cvsweb.cgi/pgsql/contrib/ has at least > > the raw files. I'd be delighted to put up something more, tho :) > > Yeah, but very few people would ever think to look in CVS for > documentation. I think it'd be much better if we could include the > README's in the documentation build process somehow... I'm all for it. Do you have an idea of how this might work? I suppose some kind of idiot conversion of READMEs to man pages might be appropriate. Dunno about what would happen on Windows. Um, help? Cheers, D -- David Fetter <david@fetter.org> http://fetter.org/ phone: +1 415 235 3778 AIM: dfetter666 Skype: davidfetter Remember to vote!
On Friday 17 March 2006 13:40, David Fetter wrote: > On Fri, Mar 17, 2006 at 12:22:44PM -0600, Jim C. Nasby wrote: > > On Wed, Mar 08, 2006 at 02:05:44PM -0800, David Fetter wrote: > > > On Wed, Mar 08, 2006 at 01:50:47PM -0600, Jim C. Nasby wrote: > > > > It would be nice if there was an easy place to see the documentation > > > > for the various contrib projects. Would this be hard to setup? I > > > > think the plain text would be fine, just need to post the readme's > > > > somewhere and link to them. > > > > > > http://developer.postgresql.org/cvsweb.cgi/pgsql/contrib/ has at least > > > the raw files. I'd be delighted to put up something more, tho :) > > > > Yeah, but very few people would ever think to look in CVS for > > documentation. I think it'd be much better if we could include the > > README's in the documentation build process somehow... > > I'm all for it. Do you have an idea of how this might work? I > suppose some kind of idiot conversion of READMEs to man pages might be > appropriate. Dunno about what would happen on Windows. Um, help? > Could we require contrib authors to provide their documentation as sgml, and then have the doc build process loop in each contrib module as an appendix inside the official docs? -- Robert Treat Build A Brighter Lamp :: Linux Apache {middleware} PostgreSQL
On Fri, Mar 17, 2006 at 04:19:58PM -0500, Robert Treat wrote: > > > Yeah, but very few people would ever think to look in CVS for > > > documentation. I think it'd be much better if we could include the > > > README's in the documentation build process somehow... > > > > I'm all for it. Do you have an idea of how this might work? I > > suppose some kind of idiot conversion of READMEs to man pages might be > > appropriate. Dunno about what would happen on Windows. Um, help? > > > > Could we require contrib authors to provide their documentation as sgml, and > then have the doc build process loop in each contrib module as an appendix > inside the official docs? Can't we just copy the text files over somewhere? Actually, there was talk of improving the way that the contrib installs handled the README's, so maybe part of that could be used here. -- Jim C. Nasby, Sr. Engineering Consultant jnasby@pervasive.com Pervasive Software http://pervasive.com work: 512-231-6117 vcard: http://jim.nasby.net/pervasive.vcf cell: 512-569-9461
"Jim C. Nasby" <jnasby@pervasive.com> writes:
> On Fri, Mar 17, 2006 at 04:19:58PM -0500, Robert Treat wrote:
>> Could we require contrib authors to provide their documentation as sgml, and
>> then have the doc build process loop in each contrib module as an appendix
>> inside the official docs?
> Can't we just copy the text files over somewhere?
I think the entire point of contrib is that it's "not ready for prime
time" code, and one of the ways in which it's likely to be not ready
is not having sgml-format documentation.
If someone wants to step up and do the work to convert the existing
contrib doc files to sgml, I certainly won't stand in the way --- but
I'm not prepared to remove contrib entries just because they don't have
sgml-format docs.
regards, tom lane
On Saturday 18 March 2006 02:00, Tom Lane wrote:
> "Jim C. Nasby" <jnasby@pervasive.com> writes:
> > On Fri, Mar 17, 2006 at 04:19:58PM -0500, Robert Treat wrote:
> >> Could we require contrib authors to provide their documentation as sgml,
> >> and then have the doc build process loop in each contrib module as an
> >> appendix inside the official docs?
> >
> > Can't we just copy the text files over somewhere?
>
> I think the entire point of contrib is that it's "not ready for prime
> time" code, and one of the ways in which it's likely to be not ready
> is not having sgml-format documentation.
>
> If someone wants to step up and do the work to convert the existing
> contrib doc files to sgml, I certainly won't stand in the way --- but
> I'm not prepared to remove contrib entries just because they don't have
> sgml-format docs.
>
Well sure... I'd probably be willing to help out with that, considering that
(in theory) we're going to be removing some of them anyway, so that would cut
down on the work. And this could be a requirement for future contrib items. I
think the real question is would someone be willing to step up and fix the
build process to pull these items into the main docs if they were to be
converted to sgml. I think that's the harder of the two problems to solve.
--
Robert Treat
Build A Brighter Lamp :: Linux Apache {middleware} PostgreSQL