Skip to content

Commit 322f55b

Browse files
committed
doc:: simplify introductory text
Reported-by: Joshua D. Drake Discussion: https://postgr.es/m/[email protected] Author: Joshua D. Drake Backpatch-through: master
1 parent 0ccb657 commit 322f55b

File tree

1 file changed

+45
-49
lines changed

1 file changed

+45
-49
lines changed

doc/src/sgml/postgres.sgml

Lines changed: 45 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,22 @@ break is not needed in a wider output rendering.
3838
<partintro>
3939
<para>
4040
Welcome to the <productname>PostgreSQL</productname> Tutorial. The
41-
following few chapters are intended to give a simple introduction
41+
tutorial is intended to give an introduction
4242
to <productname>PostgreSQL</productname>, relational database
43-
concepts, and the SQL language to those who are new to any one of
44-
these aspects. We only assume some general knowledge about how to
45-
use computers. No particular Unix or programming experience is
46-
required. This part is mainly intended to give you some hands-on
47-
experience with important aspects of the
48-
<productname>PostgreSQL</productname> system. It makes no attempt
49-
to be a complete or thorough treatment of the topics it covers.
43+
concepts, and the SQL language. We assume some general knowledge about
44+
how to use computers and no particular Unix or programming experience is
45+
required. This tutorial is intended to provide hands-on experience with
46+
important aspects of the <productname>PostgreSQL</productname> system.
47+
It makes no attempt to be a comprehensive treatment of the topics it covers.
5048
</para>
5149

5250
<para>
53-
After you have worked through this tutorial you might want to move
54-
on to reading <xref linkend="sql"/> to gain a more formal knowledge
51+
After you have successfully completed this tutorial you will want to
52+
read the <xref linkend="sql"/> section to gain a better understanding
5553
of the SQL language, or <xref linkend="client-interfaces"/> for
56-
information about developing applications for
57-
<productname>PostgreSQL</productname>. Those who set up and
58-
manage their own server should also read <xref linkend="admin"/>.
54+
information about developing applications with
55+
<productname>PostgreSQL</productname>. Those who provision and
56+
manage their own PostgreSQL installation should also read <xref linkend="admin"/>.
5957
</para>
6058
</partintro>
6159

@@ -73,28 +71,26 @@ break is not needed in a wider output rendering.
7371
This part describes the use of the <acronym>SQL</acronym> language
7472
in <productname>PostgreSQL</productname>. We start with
7573
describing the general syntax of <acronym>SQL</acronym>, then
76-
explain how to create the structures to hold data, how to populate
77-
the database, and how to query it. The middle part lists the
78-
available data types and functions for use in
79-
<acronym>SQL</acronym> commands. The rest treats several
80-
aspects that are important for tuning a database for optimal
81-
performance.
74+
how to create tables, how to populate the database, and how to
75+
query it. The middle part lists the available data types and
76+
functions for use in <acronym>SQL</acronym> commands. Lastly,
77+
we address several aspects of importance for tuning a database.
8278
</para>
8379

8480
<para>
85-
The information in this part is arranged so that a novice user can
86-
follow it start to end to gain a full understanding of the topics
81+
The information is arranged so that a novice user can
82+
follow it from start to end and gain a full understanding of the topics
8783
without having to refer forward too many times. The chapters are
8884
intended to be self-contained, so that advanced users can read the
89-
chapters individually as they choose. The information in this
90-
part is presented in a narrative fashion in topical units.
91-
Readers looking for a complete description of a particular command
92-
should see <xref linkend="reference"/>.
85+
chapters individually as they choose. The information is presented
86+
in narrative form with topical units. Readers looking for a complete
87+
description of a particular command are encouraged to review
88+
the <xref linkend="reference"/>.
9389
</para>
9490

9591
<para>
96-
Readers of this part should know how to connect to a
97-
<productname>PostgreSQL</productname> database and issue
92+
Readers should know how to connect to a
93+
<productname>PostgreSQL</productname> database and issue
9894
<acronym>SQL</acronym> commands. Readers that are unfamiliar with
9995
these issues are encouraged to read <xref linkend="tutorial"/>
10096
first. <acronym>SQL</acronym> commands are typically entered
@@ -125,32 +121,32 @@ break is not needed in a wider output rendering.
125121
<partintro>
126122
<para>
127123
This part covers topics that are of interest to a
128-
<productname>PostgreSQL</productname> database administrator. This includes
129-
installation of the software, set up and configuration of the
130-
server, management of users and databases, and maintenance tasks.
131-
Anyone who runs a <productname>PostgreSQL</productname> server, even for
124+
<productname>PostgreSQL</productname> administrator. This includes
125+
installation, configuration of the server, management of users
126+
and databases, and maintenance tasks. Anyone running
127+
<productname>PostgreSQL</productname> server, even for
132128
personal use, but especially in production, should be familiar
133-
with the topics covered in this part.
129+
with these topics.
134130
</para>
135131

136132
<para>
137-
The information in this part is arranged approximately in the
138-
order in which a new user should read it. But the chapters are
139-
self-contained and can be read individually as desired. The
140-
information in this part is presented in a narrative fashion in
141-
topical units. Readers looking for a complete description of a
142-
particular command should see <xref linkend="reference"/>.
133+
The information attempts to be in the order in which
134+
a new user should read it. The chapters are self-contained and
135+
can be read individually as desired. The information is presented
136+
in a narrative form in topical units. Readers looking for a complete
137+
description of a command are encouraged to review the
138+
<xref linkend="reference"/>.
143139
</para>
144140

145141
<para>
146142
The first few chapters are written so they can be understood
147143
without prerequisite knowledge, so new users who need to set
148-
up their own server can begin their exploration with this part.
149-
The rest of this part is about tuning and management; that material
144+
up their own server can begin their exploration. The rest of this
145+
part is about tuning and management; that material
150146
assumes that the reader is familiar with the general use of
151147
the <productname>PostgreSQL</productname> database system. Readers are
152-
encouraged to look at <xref linkend="tutorial"/> and <xref
153-
linkend="sql"/> for additional information.
148+
encouraged review the <xref linkend="tutorial"/> and <xref
149+
linkend="sql"/> parts for additional information.
154150
</para>
155151
</partintro>
156152

@@ -182,13 +178,13 @@ break is not needed in a wider output rendering.
182178
<para>
183179
This part describes the client programming interfaces distributed
184180
with <productname>PostgreSQL</productname>. Each of these chapters can be
185-
read independently. Note that there are many other programming
186-
interfaces for client programs that are distributed separately and
181+
read independently. There are many external programming
182+
interfaces for client programs that are distributed separately. They
187183
contain their own documentation (<xref linkend="external-projects"/>
188184
lists some of the more popular ones). Readers of this part should be
189-
familiar with using <acronym>SQL</acronym> commands to manipulate
185+
familiar with using <acronym>SQL</acronym> to manipulate
190186
and query the database (see <xref linkend="sql"/>) and of course
191-
with the programming language that the interface uses.
187+
with the programming language of their choice.
192188
</para>
193189
</partintro>
194190

@@ -206,15 +202,15 @@ break is not needed in a wider output rendering.
206202
<para>
207203
This part is about extending the server functionality with
208204
user-defined functions, data types, triggers, etc. These are
209-
advanced topics which should probably be approached only after all
205+
advanced topics which should be approached only after all
210206
the other user documentation about <productname>PostgreSQL</productname> has
211207
been understood. Later chapters in this part describe the server-side
212208
programming languages available in the
213209
<productname>PostgreSQL</productname> distribution as well as
214-
general issues concerning server-side programming languages. It
210+
general issues concerning server-side programming. It
215211
is essential to read at least the earlier sections of <xref
216212
linkend="extend"/> (covering functions) before diving into the
217-
material about server-side programming languages.
213+
material about server-side programming.
218214
</para>
219215
</partintro>
220216

0 commit comments

Comments
 (0)