[pgpool-hackers: 3392] [PATCH] Doc: Fix wrong conjugations and connectors in what-is-pgpool

Alejandro Roman alejandro at aromnn.com
Sun Aug 25 04:04:38 JST 2019


Hello mailing list,

While reading the docs, I found some typos in the what-is-pgpool page 
that made it harder for me to understand the meaning of the sentences.
I hope this patch can improve the legibility of that paragraph.

On the other side, I wanted to mention that it was also difficult for me
to know how to contribute to this project, at least for sending this
patch for the docs.  I wasn't sure if a doc fix should be sent as a bug
to the bug tracking tool in [1].  Also, I didn't found a CONTRIBUTING
file in the source code neither.  A resource that did help me was this
email thread [2] sent some years ago.  The user was also looking for a
document that describes the workflow for submitting patches.  At the
end, I followed the PostgreSQL project guidelines.

Does such document or web resource exist? If not, what would you say if
I send an initial draft for it. I think it would make it easy for new
contributors to start working in the project. Even if it doesn't state new
guidelines, the document could at least state that this project follows
the PostgreSQL project guidelines and indicate the user where he can
find more information about them.

Alejandro

[1] https://www.pgpool.net/mantisbt/my_view_page.php
[2] http://www.sraoss.jp/pipermail/pgpool-general/2015-June/003846.html
-------------- next part --------------
>From 7913d54156b94d29fcecaceb95780eba426466bc Mon Sep 17 00:00:00 2001
From: Alejandro Roman <alejandro at aromnn.com>
Date: Sat, 24 Aug 2019 13:04:29 -0500
Subject: [PATCH] Doc: Fix wrong conjugations and connectors in what-is-pgpool
 page

While reading the docs, I found these mistakes and they made it harder
for me to understand the meaning of the sentence.

In the first sentence, the 'detaches' and 'continues' conjugations
should be in the normal form when using them after a 'will' statement.
Also, some connectors (e.g. 'the') were missing.
---
 doc/src/sgml/intro.sgml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/src/sgml/intro.sgml b/doc/src/sgml/intro.sgml
index 4abbaef6..a0fa3628 100644
--- a/doc/src/sgml/intro.sgml
+++ b/doc/src/sgml/intro.sgml
@@ -118,10 +118,10 @@
      <term>Automated fail over</term>
      <listitem>
       <para>
-       If one of database servers goes down or becomes unreachable,
-       <productname>Pgpool-II</productname> will detaches it and continues operations using rest
-       of database servers. There are some sophisticated features which
-       help the automated fail over including timeout and retries.
+       If one of the database servers goes down or becomes unreachable,
+       <productname>Pgpool-II</productname> will detach it and will continue operations by using the rest
+       of database servers. There are some sophisticated features that
+       help the automated failover including timeouts and retries.
       </para>
      </listitem>
     </varlistentry>
-- 
2.20.1 (Apple Git-117)



More information about the pgpool-hackers mailing list