Thread: Fwd: Would like to help with documentation for Postgres 11

On Sun, Jul 29, 2018 at 11:50:40AM -0500, Michael Goldshteyn wrote:
> I would like to offer some help writing and improving the English
> documentation for some of the new features and changes in Postgres 11. If I
> can get an email of where such help would be appreciated, so I can choose a
> feature I am familiar with, I would be glad to help.

The documentation is expected to be commited with the feature, so what's
currently in place is expected to be adequate and accuate.

You could review any documentation changes since v10.  Any issues or
improvements you can discuss or send patch to -hackers.

Maybe something like:
git log -p REL_10_4..REL_11_BETA2 doc/
..or just git diff which would not show commits separately but also would not
show multiple updates for same feature (like: commit: feature... commit:
improve documentation... commit: fix typos... commit: change default)

Alternately you can look at the pg11 release notes (or git log?) for list of
features and check that corresponding documentation exists and is accurate.
That could conceivably expose implementation bugs, eg. with edge cases.
git log REL_10_4..REL_11_BETA2

Justin

Justin Pryzby <pryzby@telsasoft.com> writes:
> On Sun, Jul 29, 2018 at 11:50:40AM -0500, Michael Goldshteyn wrote:
>> I would like to offer some help writing and improving the English
>> documentation for some of the new features and changes in Postgres 11. If I
>> can get an email of where such help would be appreciated, so I can choose a
>> feature I am familiar with, I would be glad to help.

> The documentation is expected to be commited with the feature, so what's
> currently in place is expected to be adequate and accuate.

There is, however, a fair amount of stuff that was written by people whose
first language isn't English, and it shows.  So plain old copy-editing
is surely welcome, if you have a mind to do that.

            regards, tom lane

> Justin Pryzby <pryzby@telsasoft.com> writes:
>> On Sun, Jul 29, 2018 at 11:50:40AM -0500, Michael Goldshteyn wrote:
>>> I would like to offer some help writing and improving the English
>>> documentation for some of the new features and changes in Postgres 11. If I
>>> can get an email of where such help would be appreciated, so I can choose a
>>> feature I am familiar with, I would be glad to help.
> 
>> The documentation is expected to be commited with the feature, so what's
>> currently in place is expected to be adequate and accuate.
> 
> There is, however, a fair amount of stuff that was written by people whose
> first language isn't English, and it shows.  So plain old copy-editing
> is surely welcome, if you have a mind to do that.

BTW, the CommitFest application seems not to pick up threads other
than in pgsql-hackers. This is usually fine. However if people want to
contribute document *only* patches and send it to pgsql-docs then
tries to register it into CF, the CF app does not recognize it. I am
not sure if this is intended behavior or not.

Best regards,
--
Tatsuo Ishii
SRA OSS, Inc. Japan
English: http://www.sraoss.co.jp/index_en.php
Japanese:http://www.sraoss.co.jp