public inbox for [email protected]
help / color / mirror / Atom feedDOCS - Add introductory paragraph to Getting Started chapter
3+ messages / 2 participants
[nested] [flat]
* DOCS - Add introductory paragraph to Getting Started chapter
@ 2026-02-18 09:28 Dragos Andriciuc <[email protected]>
2026-02-18 17:24 ` Re: DOCS - Add introductory paragraph to Getting Started chapter Andreas Karlsson <[email protected]>
0 siblings, 1 reply; 3+ messages in thread
From: Dragos Andriciuc @ 2026-02-18 09:28 UTC (permalink / raw)
To: pgsql-hackers
Hello,
The "Getting Started" chapter currently lacks an introductory paragraph explaining its scope.
This patch adds a brief introduction describing the topics covered in the chapter.
Patch attached.
Attachments:
[application/octet-stream] 0001-Add-introductory-paragraph-to-Getting-Started-chapter.patch (1.1K, 3-0001-Add-introductory-paragraph-to-Getting-Started-chapter.patch)
download | inline diff:
From 355348ec409e15a017ee36a8d05a0914769442fb Mon Sep 17 00:00:00 2001
From: Dragos Andriciuc <[email protected]>
Date: Tue, 17 Feb 2026 12:25:03 +0200
Subject: [PATCH] Add introductory paragraph to Getting Started chapter
---
doc/src/sgml/start.sgml | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/doc/src/sgml/start.sgml b/doc/src/sgml/start.sgml
index 0263a700591..28d05d89644 100644
--- a/doc/src/sgml/start.sgml
+++ b/doc/src/sgml/start.sgml
@@ -3,6 +3,15 @@
<chapter id="tutorial-start">
<title>Getting Started</title>
+ <para>
+ This chapter provides a practical introduction to working with <productname>PostgreSQL</productname>.
+ It describes how to install the software, explains basic architectural concepts, and shows how
+ to create and access a database.
+
+ The purpose of this chapter is to help you set up a working <productname>PostgreSQL</productname>
+ environment and become familiar with the fundamental components involved in everyday use.
+ </para>
+
<sect1 id="tutorial-install">
<title>Installation</title>
--
2.43.0
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: DOCS - Add introductory paragraph to Getting Started chapter
2026-02-18 09:28 DOCS - Add introductory paragraph to Getting Started chapter Dragos Andriciuc <[email protected]>
@ 2026-02-18 17:24 ` Andreas Karlsson <[email protected]>
2026-02-19 09:58 ` Re: DOCS - Add introductory paragraph to Getting Started chapter Dragos Andriciuc <[email protected]>
0 siblings, 1 reply; 3+ messages in thread
From: Andreas Karlsson @ 2026-02-18 17:24 UTC (permalink / raw)
To: Dragos Andriciuc <[email protected]>; pgsql-hackers
On 2/18/26 10:28 AM, Dragos Andriciuc wrote:
> The "Getting Started" chapter currently lacks an introductory paragraph
> explaining its scope.
>
> This patch adds a brief introduction describing the topics covered in
> the chapter.
>
> Patch attached.
I have not looked at the actual contents of the change but did you
intend to add one or two paragraphs? You intent is a bit unclear since
you have added a double newline within a <para> tag. If you intended two
paragraphs it should be two <para> tags and if not there shouldn't be a
double newline.
Have you set it up so you can render the documentation to HTML locally?
Andreas
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: DOCS - Add introductory paragraph to Getting Started chapter
2026-02-18 09:28 DOCS - Add introductory paragraph to Getting Started chapter Dragos Andriciuc <[email protected]>
2026-02-18 17:24 ` Re: DOCS - Add introductory paragraph to Getting Started chapter Andreas Karlsson <[email protected]>
@ 2026-02-19 09:58 ` Dragos Andriciuc <[email protected]>
0 siblings, 0 replies; 3+ messages in thread
From: Dragos Andriciuc @ 2026-02-19 09:58 UTC (permalink / raw)
To: Andreas Karlsson <[email protected]>; +Cc: pgsql-hackers
Thanks for pointing that out. The intention was to add two paragraphs and
it is now corrected to use
two separate <para> tags. Attached is v2 of the patch.
I have verified that the docs build and render correctly in HTML locally.
On Wed, Feb 18, 2026 at 7:25 PM Andreas Karlsson <[email protected]> wrote:
> On 2/18/26 10:28 AM, Dragos Andriciuc wrote:
> > The "Getting Started" chapter currently lacks an introductory paragraph
> > explaining its scope.
> >
> > This patch adds a brief introduction describing the topics covered in
> > the chapter.
> >
> > Patch attached.
>
> I have not looked at the actual contents of the change but did you
> intend to add one or two paragraphs? You intent is a bit unclear since
> you have added a double newline within a <para> tag. If you intended two
> paragraphs it should be two <para> tags and if not there shouldn't be a
> double newline.
>
> Have you set it up so you can render the documentation to HTML locally?
>
> Andreas
>
>
>
Attachments:
[application/octet-stream] v2-0001-Add-introductory-paragraph-to-Getting-Started-chapter.patch (1.1K, 3-v2-0001-Add-introductory-paragraph-to-Getting-Started-chapter.patch)
download | inline diff:
From c52769a10a13aeecf81e9b15ca59012ff77a0477 Mon Sep 17 00:00:00 2001
From: Dragos Andriciuc <[email protected]>
Date: Tue, 17 Feb 2026 12:25:03 +0200
Subject: [PATCH] Add introductory paragraph to Getting Started chapter
v2:
- Add paragraph tag to second paragraph
---
doc/src/sgml/start.sgml | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/doc/src/sgml/start.sgml b/doc/src/sgml/start.sgml
index 0263a700591..8ab857aa0a6 100644
--- a/doc/src/sgml/start.sgml
+++ b/doc/src/sgml/start.sgml
@@ -3,6 +3,17 @@
<chapter id="tutorial-start">
<title>Getting Started</title>
+ <para>
+ This chapter provides a practical introduction to working with <productname>PostgreSQL</productname>.
+ It describes how to install the software, explains basic architectural concepts, and shows how
+ to create and access a database.
+ </para>
+
+ <para>
+ The purpose of this chapter is to help you set up a working <productname>PostgreSQL</productname>
+ environment and become familiar with the fundamental components involved in everyday use.
+ </para>
+
<sect1 id="tutorial-install">
<title>Installation</title>
--
2.43.0
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2026-02-19 09:58 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2026-02-18 09:28 DOCS - Add introductory paragraph to Getting Started chapter Dragos Andriciuc <[email protected]>
2026-02-18 17:24 ` Andreas Karlsson <[email protected]>
2026-02-19 09:58 ` Dragos Andriciuc <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox