Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1hzqjI-0004PL-Jg for pgsql-docs@arkaria.postgresql.org; Mon, 19 Aug 2019 23:06:24 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.89) (envelope-from ) id 1hzqjH-0001eU-5S for pgsql-docs@arkaria.postgresql.org; Mon, 19 Aug 2019 23:06:23 +0000 Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29]) by malur.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1hzqjG-0001eN-PF for pgsql-docs@lists.postgresql.org; Mon, 19 Aug 2019 23:06:22 +0000 Received: from mail-pl1-x631.google.com ([2607:f8b0:4864:20::631]) by magus.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1hzqjB-0004sU-VZ for pgsql-docs@postgresql.org; Mon, 19 Aug 2019 23:06:21 +0000 Received: by mail-pl1-x631.google.com with SMTP id gn20so1692732plb.2 for ; Mon, 19 Aug 2019 16:06:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=commandprompt-com.20150623.gappssmtp.com; s=20150623; h=subject:to:cc:references:from:organization:message-id:date :user-agent:mime-version:in-reply-to:content-language; bh=1w/PXTu1TnCjV7QKVpNFHW7jhJNc0rGo/2ilbxmf4Qw=; b=HkWAfzXxjes7pOD7yCphZyK2QvssI+JjZkEkbkrE/5XSEEbeg/LqFDS2ILNci815j1 gnQl9OjXlbicYArJqgwugMiF55KPHTuh6Zaw6LV06FQrQecR07TEl75uR6RX1bOp/TzD 1Cgce2n4NWmn4/XBPq0Vle36qEfvg9Gwu7/KwfFs+YyOqn3fzdh0Z5LoI6jw/5cHpejV C1ULjZQAH4taJMo8ZYsefjg863lhZ24fPM6miQjcGEI0fYZ6cJ1gvNyWRjN1hF2NS0oY jRyvK+sBSKG7qpHybEMaElYiXQuRXG2DUgp0EsoToDAmJLDTfROpzD3pZXByaVw9Z2SO eUqA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:organization :message-id:date:user-agent:mime-version:in-reply-to :content-language; bh=1w/PXTu1TnCjV7QKVpNFHW7jhJNc0rGo/2ilbxmf4Qw=; b=d73eQRmCWgKIu8hkhybLJbsFmQrlHOzoGrx4rlMZGNEZV7Ow4KEaK9cDUJGK5jkphZ gdqj92Q/vWU+y0GtUFtm0lA26WaCXM7rRCr2RrBSKmwmAEWu0EY+wIZg8hTWh6dmpFqj vi96YAB5SVkrGrWvwC5cFsLtd9uQ/TTB77ZUaF2YAIu8qEija6xPOD5YRMW+l9MgOhZV k2yPSd8wBmNzEPMpfaJ0grw9OXA42Su5/XL0ElpbZazp/XK1lOzJiapiu7SFznogpEmO VE0HB1KIIp68aOIA19Z86+EiFLv+WUo8BDzmK9MF6T9dTvBbPJR3ENV+tW7JaRZCgTl0 AACg== X-Gm-Message-State: APjAAAXKnAyNZV3Pvy7bi4skPN3Z5VrQ984CGf/EpZF0owts2BxvV8Kt j6uV7PwWOh6qWLpe9t1384NkVAxr7M4zUIt4/Oz0nE63arDXwAd5XKTMAHvrc1xdHAIzvZDMT+S zRcu52OzN7Md33JVNLOr2WV4L+2M68KwvCU55fdOXzpNjMm25leMNuOYQVjGg84wArmFN/rI= X-Google-Smtp-Source: APXvYqw7VDkQCndoc9J4dXRqxQLg8vKbwspaIph49o0FgN4ajr9FrHVhrcMvt1ge6JCCsU7Qxuxr8w== X-Received: by 2002:a17:902:f301:: with SMTP id gb1mr24303170plb.249.1566255616454; Mon, 19 Aug 2019 16:00:16 -0700 (PDT) Received: from [192.168.50.160] (c-73-97-49-9.hsd1.wa.comcast.net. [73.97.49.9]) by smtp.gmail.com with ESMTPSA id v27sm22145483pgn.76.2019.08.19.16.00.14 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 19 Aug 2019 16:00:15 -0700 (PDT) Subject: Re: readability changes to postgres.sgml To: Erik Rijkers , Stephen Frost Cc: pgsql-docs References: <5ac2c96d-37a6-18aa-08c4-327a6fbff24b@commandprompt.com> <20190816002623.GS16436@tamriel.snowman.net> <996bcfe233f558276f4f5962673ba164@xs4all.nl> From: "Joshua D. Drake" Organization: Command Prompt, Inc. Message-ID: <317b2dec-264b-2085-fc9c-10f2feca3693@commandprompt.com> Date: Mon, 19 Aug 2019 16:00:13 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.8.0 MIME-Version: 1.0 In-Reply-To: Content-Type: multipart/mixed; boundary="------------8D1ACFD762FADF74B74041F4" Content-Language: en-US List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Precedence: bulk This is a multi-part message in MIME format. --------------8D1ACFD762FADF74B74041F4 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Team, New version attached with spelling errors fixed. -- Command Prompt, Inc. || http://the.postgres.company/ || @cmdpromptinc Postgres centered full stack support, consulting and development. Advocate: @amplifypostgres || Get help: https://commandprompt.com/ ***** Unless otherwise stated, opinions are my own. ***** --------------8D1ACFD762FADF74B74041F4 Content-Type: text/x-patch; name="postgres.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="postgres.diff" diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml index e59cba7997..a6b77d50eb 100644 --- a/doc/src/sgml/postgres.sgml +++ b/doc/src/sgml/postgres.sgml @@ -31,24 +31,22 @@ Welcome to the PostgreSQL Tutorial. The - following few chapters are intended to give a simple introduction + tutorial is intended to give an introduction to PostgreSQL, relational database - concepts, and the SQL language to those who are new to any one of - these aspects. We only assume some general knowledge about how to - use computers. No particular Unix or programming experience is - required. This part is mainly intended to give you some hands-on - experience with important aspects of the - PostgreSQL system. It makes no attempt - to be a complete or thorough treatment of the topics it covers. + concepts, and the SQL language. We assume some general knowledge about + how to use computers and no particular Unix or programming experience is + required. This tutorial is intended to provide hands-on experience with + important aspects of the PostgreSQL system. + It makes no attempt to be a comprehensive treatment of the topics it covers. - After you have worked through this tutorial you might want to move - on to reading to gain a more formal knowledge + After you have successfully completed this tutorial you will want to + read the section to gain a better understanding of the SQL language, or for - information about developing applications for - PostgreSQL. Those who set up and - manage their own server should also read . + information about developing applications with + PostgreSQL. Those who provision and + manage their own PostgreSQL installation should also read . @@ -66,28 +64,26 @@ This part describes the use of the SQL language in PostgreSQL. We start with describing the general syntax of SQL, then - explain how to create the structures to hold data, how to populate - the database, and how to query it. The middle part lists the - available data types and functions for use in - SQL commands. The rest treats several - aspects that are important for tuning a database for optimal - performance. + how to create tables, how to populate the database, and how to + query it. The middle part lists the available data types and + functions for use in SQL commands. Lastly, + we address several aspects of importance for tuning a database. - The information in this part is arranged so that a novice user can - follow it start to end to gain a full understanding of the topics + The information is arranged so that a novice user can + follow it from start to end and gain a full understanding of the topics without having to refer forward too many times. The chapters are intended to be self-contained, so that advanced users can read the - chapters individually as they choose. The information in this - part is presented in a narrative fashion in topical units. - Readers looking for a complete description of a particular command - should see . + chapters individually as they choose. The information is presented + in narrative form with topical units. Readers looking for a complete + description of a particular command are encouraged to review + the . - Readers of this part should know how to connect to a - PostgreSQL database and issue + Readers should know how to connect to a + PostgreSQL database and issue SQL commands. Readers that are unfamiliar with these issues are encouraged to read first. SQL commands are typically entered @@ -118,32 +114,32 @@ This part covers topics that are of interest to a - PostgreSQL database administrator. This includes - installation of the software, set up and configuration of the - server, management of users and databases, and maintenance tasks. - Anyone who runs a PostgreSQL server, even for + PostgreSQL administrator. This includes + installation, configuration of the server, management of users + and databases, and maintenance tasks. Anyone running + PostgreSQL server, even for personal use, but especially in production, should be familiar - with the topics covered in this part. + with these topics. - The information in this part is arranged approximately in the - order in which a new user should read it. But the chapters are - self-contained and can be read individually as desired. The - information in this part is presented in a narrative fashion in - topical units. Readers looking for a complete description of a - particular command should see . + The information attempts to be in the order in which + a new user should read it. The chapters are self-contained and + can be read individually as desired. The information is presented + in a narrative form in topical units. Readers looking for a complete + description of a command are encouraged to review the + . The first few chapters are written so they can be understood without prerequisite knowledge, so new users who need to set - up their own server can begin their exploration with this part. - The rest of this part is about tuning and management; that material + up their own server can begin their exploration. The rest of this + part is about tuning and management; that material assumes that the reader is familiar with the general use of the PostgreSQL database system. Readers are - encouraged to look at and for additional information. + encouraged review the and parts for additional information. @@ -174,13 +170,13 @@ This part describes the client programming interfaces distributed with PostgreSQL. Each of these chapters can be - read independently. Note that there are many other programming - interfaces for client programs that are distributed separately and + read independently. There are many external programming + interfaces for client programs that are distributed separately. They contain their own documentation ( lists some of the more popular ones). Readers of this part should be - familiar with using SQL commands to manipulate + familiar with using SQL to manipulate and query the database (see ) and of course - with the programming language that the interface uses. + with the programming language of their choice. @@ -198,15 +194,15 @@ This part is about extending the server functionality with user-defined functions, data types, triggers, etc. These are - advanced topics which should probably be approached only after all + advanced topics which should be approached only after all the other user documentation about PostgreSQL has been understood. Later chapters in this part describe the server-side programming languages available in the PostgreSQL distribution as well as - general issues concerning server-side programming languages. It + general issues concerning server-side programming. It is essential to read at least the earlier sections of (covering functions) before diving into the - material about server-side programming languages. + material about server-side programming. --------------8D1ACFD762FADF74B74041F4--