Re: PL/PgSQL Documentation

Started by Bruce Momjianover 25 years ago6 messagesdocs
Jump to latest
#1Bruce Momjian
bruce@momjian.us

I am CC'ing Thomas and the documentation list. Feel free to look at our
SGML files and submit patches to add to that documentation.

Hello Bruce,

Chris told me that you are the doco guy, so I just wanted to offer to write
some docs:

I learned this weekend PL/PgSQL and I noticed that there is not enough
documentation, since it took me a while to find out that I had to
initialize the language first. I would be willing to write a small doc
explaining on how to get started with PL/PgSQL for other people like me.

Regards,
Stephan
--
Stephan Richter
CBU - Physics and Chemistry Student
Web2k - Web Design/Development & Technical Project Management

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026
#2Thomas Lockhart
lockhart@alumni.caltech.edu
In reply to: Bruce Momjian (#1)

well I am not so familiar of how your documentation is structured, so is it
possible to just send documentation snippets to the lsit or write a new
part in the current documentation?

Yes, it is possible to send snippets or (preferably) patches on the
current sgml docs. For a new doc chapter or section, I can mark it up in
SGML if you find that daunting.

How is the editing process handled?

Arbitrarily and capriciously ;) There are several folks who have
familiarity with the current docs, and who seem to lack any inhibitions
about changing them. So if you send something in, one of us will likely
plop it into the relevant section. Sometimes it is best to run your
ideas and intended contribution by the mailing list to get some feedback
early on. In this case, we know you are looking at the PL/SQL language,
and so plsql.sgml is the likely target. Fire away...

- Thomas

#3Weiping He
laser@zhengmai.com.cn
In reply to: Bruce Momjian (#1)
many chinese version doc added

Ok, I'v finished doing almost all the related docs from English to Chinese,
including most FAQs, anybody interested could view them at:

http://laser.zhengmai.com.cn

Any comment are appreciated.

regards & thanks

Laser

#4Thomas Lockhart
lockhart@alumni.caltech.edu
In reply to: Bruce Momjian (#1)
Re: many chinese version doc added

Ok, I'v finished doing almost all the related docs from English to Chinese,
including most FAQs, anybody interested could view them at:
http://laser.zhengmai.com.cn
Any comment are appreciated.

*Very* impressive. I would comment more if I could read it ;)

Vince, I really like the new look of the site. But I'm having trouble
finding cross references to translated docs. Would they go in a cover
sheet inside the User's Lounge?

- Thomas

#5Bruce Momjian
bruce@momjian.us
In reply to: Thomas Lockhart (#4)
Re: many chinese version doc added

Ok, I'v finished doing almost all the related docs from English to Chinese,
including most FAQs, anybody interested could view them at:
http://laser.zhengmai.com.cn
Any comment are appreciated.

*Very* impressive. I would comment more if I could read it ;)

Vince, I really like the new look of the site. But I'm having trouble
finding cross references to translated docs. Would they go in a cover
sheet inside the User's Lounge?

Can we get the documentation page back online. Dumping people into a
directory listing when they choose documentation is really poor style.
Can we just link to the old documentation page until the new one is
working?

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026
#6Vince Vielhaber
vev@michvhf.com
In reply to: Thomas Lockhart (#4)
Re: many chinese version doc added

On Wed, 13 Sep 2000, Thomas Lockhart wrote:

Ok, I'v finished doing almost all the related docs from English to Chinese,
including most FAQs, anybody interested could view them at:
http://laser.zhengmai.com.cn
Any comment are appreciated.

*Very* impressive. I would comment more if I could read it ;)

Vince, I really like the new look of the site. But I'm having trouble
finding cross references to translated docs. Would they go in a cover
sheet inside the User's Lounge?

It's a bit early in the morning, care to explain? Are you looking for
an index to the docs? If so I'm still working on it, something came up
that dragged me away from things.

Vince.
--
==========================================================================
Vince Vielhaber -- KA8CSH email: vev@michvhf.com http://www.pop4.net
128K ISDN from $22.00/mo - 56K Dialup from $16.00/mo at Pop4 Networking
Online Campground Directory http://www.camping-usa.com
Online Giftshop Superstore http://www.cloudninegifts.com
==========================================================================