[pgpool-hackers: 3797] Re: Need more documentation?

[Bo Peng]

Hi Ishii-san,

Thank you for adding new documentations.

Sorry for late response after your commit.
I think the starting/stopping section should be moved to "Chapter 2. Installation of Pgpool-II"
and follow a "Installation from source" section?
Because "Starting/stopping Pgpool-II" from RPM installation is in "2.10. Installation from RPM".
What do you think?

How about making a "2.4 Installation from source" section like following:
 
------------- brefore ------------
2.4. Getting The Source
2.5. Installing Pgpool-II
2.6. Installing pgpool_recovery
2.7. Installing pgpool-regclass
2.8. Creating insert_lock table
2.9. Compiling and installing documents
----------------------------------

 => change to

------------- after -------------
2.4 Installation from source 
  2.4.1. Getting The Source 
  2.4.2. Installing Pgpool-II
  2.4.3. Installing pgpool_recovery
  2.4.4. Installing pgpool-regclass
  2.4.5. Creating insert_lock table
  2.4.6. Compiling and installing documents
  2.4.7. Starting Pgpool-II and PostgreSQL  <= new
  2.4.8. Stopping Pgpool-II and PostgreSQL  <= new
-------------------------------

Additionally, how about add the description of
starting pgpool in non-daemon mode with "-n" option.

Below is an old tutorial of "Starting/Stopping pgpool-II"
https://www.pgpool.net/docs/pgpool-II-2.3/tutorial-en.html#start-shutdown

On Tue, 01 Sep 2020 18:23:15 +0900 (JST)
Tatsuo Ishii <ishii at sraoss.co.jp> wrote:

> Documents pushed along with Japanese documents.
> 
> > Ok, I have written proposed documents.
> > 
> > 3.1. The Pgpool-II User Account
> > 3.2. Configuring pcp.conf
> > 3.3. Configuring Pgpool-II
> > 3.4. Configuring backend information
> > 3.5. Starting Pgpool-II and PostgreSQL <-- New
> > 3.6. Stopping Pgpool-II and PostgreSQL <-- New
> > 3.7. Temporarily Shutting Down PostgreSQL <-- New
> > 
> > Patch attached. Also I have uploaded compiled HTML files.
> > 
> > https://tatsuo-ishii.github.io/pgpool-II/current/runtime.html

> >> Hi Pgpool developers,
> >> 
> >> I noticed that there's no chapter for starting/stopping Pgpool-II in
> >> our documentation. There are similar chapters in PostgreSQL
> >> documentation:
> >> 
> >> https://www.postgresql.org/docs/12/runtime.html
> >> 
> >> 18.1. The PostgreSQL User Account
> >> 18.2. Creating a Database Cluster
> >> 18.3. Starting the Database Server
> >> 18.4. Managing Kernel Resources
> >> 18.5. Shutting Down the Server
> >> 18.6. Upgrading a PostgreSQL Cluster
> >> 18.7. Preventing Server Spoofing
> >> 18.8. Encryption Options
> >> 18.9. Secure TCP/IP Connections with SSL
> >> 18.10. Secure TCP/IP Connections with GSSAPI Encryption
> >> 18.11. Secure TCP/IP Connections with SSH Tunnels
> >> 18.12. Registering Event Log on Windows
> >> 
> >> While we only have:
> >> 
> >> 3.1. The Pgpool-II User Account
> >> 3.2. Configuring pcp.conf
> >> 3.3. Configuring Pgpool-II
> >> 3.4. Configuring backend information
> >> 
> >> I think at least we need something like:
> >> 
> >> 3.5. Starting Pgpool-II and PostgreSQL
> >> 3.6. Stopping Pgpool-II and PostgreSQL
> >> 
> >> Additionally we may want to have:
> >> 
> >> 3.7. Maintaining Pgpool-II and PostgreSQL
> >> 
> >> which describes how to change configurations, how to upgrade software
> >> with minimal downtime.
> >> 
> >> Best regards,
> >> --
> >> Tatsuo Ishii
> >> SRA OSS, Inc. Japan
> >> English: http://www.sraoss.co.jp/index_en.php
> >> Japanese:http://www.sraoss.co.jp
> >> _______________________________________________
> >> pgpool-hackers mailing list
> >> pgpool-hackers at pgpool.net
> >> http://www.pgpool.net/mailman/listinfo/pgpool-hackers
> _______________________________________________
> pgpool-hackers mailing list
> pgpool-hackers at pgpool.net
> http://www.pgpool.net/mailman/listinfo/pgpool-hackers


-- 
Bo Peng <pengbo at sraoss.co.jp>
SRA OSS, Inc. Japan