Re: [HACKERS] Help with Documentation?

From: "Thomas G(dot) Lockhart" <lockhart(at)alumni(dot)caltech(dot)edu>
To: Clark Evans <clark(dot)evans(at)manhattanproject(dot)com>
Cc: hackers(at)postgreSQL(dot)org
Subject: Re: [HACKERS] Help with Documentation?
Date: 1998-12-19 02:52:07
Message-ID: 367B14D7.1F4ABF18@alumni.caltech.edu
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> Since I need to learn PosgreSQL, I'd like to help
> with documentation.

Great. Welcome.

> To start, can't seem to get the doc/src/sgml
> to compile. What version of jade do I need
> and what version of the DocBook DTD. Is there
> a link where I can download?

Look in Appendix A of the "integrated" postgres docs (postgres.html). It
describes two methods of installation; from sources and from RPM (for
linux). A few days ago we re-discovered how to install and run on
FreeBSD using available "ports". Linux and FreeBSD are easy; from
sources is more difficult. A detailed description for FreeBSD is in the
works, but the info can be posted now I would think if that is your
platform.

I'm planning on implementing "automatic builds" on the current docs tree
on postgresql.org so that fresh working docs are available routinely.
All the pieces are in place now, just need to put the framework in
place.

As an aside, it is possible to contribute docs without having the
ability to build the output. For the Postgres project, it doesn't matter
much, but imho the jade/docbook toolset is so powerful and useful that
it would be a good opportunity for you to learn a tool for other
projects too.

> After I am able to re-build the documentation,
> could I get access to the CVS server so I can
> update documentation?

At the moment, a relatively limited number of contributors have direct
*write* access to the CVS server. Typically, one gets cvs access after
hammering the current committers hard enough with patches that they get
tired of handling them. Everyone has CVSup and anon-CVS access to read
the server.

As the de facto current docs coordinator, I'll make sure contributions
are used, and would welcome any suggestions (especially backed with
work! :) on document structure and style.

btw, no document contributions or updates have ever been rejected, lost,
or unused.

> My long term goal is to put documentation
> in the database itself, and to provide tools
> to import/export SGML documents to PostgreSQL
> and to crate a "document server" that
> is accessable from the web.

Sounds like a neat project.

- Tom

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Thomas G. Lockhart 1998-12-19 02:58:32 Re: [HACKERS] Upgrades for 6.4.1
Previous Message Bruce Momjian 1998-12-19 02:34:04 Re: [HACKERS] Upgrades for 6.4.1