pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Intro enhancement proposal
3+ messages / 3 participants
[nested] [flat]

* Intro enhancement proposal
@ 2022-08-09 11:13 Elena Indrupskaya <e.indrupskaya@postgrespro.ru>
  2022-08-09 11:18 ` Re: Intro enhancement proposal Daniel Gustafsson <daniel@yesql.se>
  0 siblings, 1 reply; 3+ messages in thread

From: Elena Indrupskaya @ 2022-08-09 11:13 UTC (permalink / raw)
  To: pgsql-docs@lists.postgresql.org

Hello,

It occurred to me that adding some cross-references to intro.sgml could 
add value to the PostgreSQL 15 documentation through a possibility to 
immediately figure out what is meant by specific list items and through 
providing even better navigation. Details are in the attached patch.

Thank you.

-- 
Elena Indrupskaya
Lead Technical Writer
Postgres Professional http://www.postgrespro.com

Attachments:

  [text/x-patch] intro_doc_psql.patch (2.1K, ../../1a666b2e-d373-1c94-1005-1700e023670d@postgrespro.ru/3-intro_doc_psql.patch)
  download | inline diff:
diff --git a/doc/src/sgml/intro.sgml b/doc/src/sgml/intro.sgml
index 63eda059f0..cfbe044746 100644
--- a/doc/src/sgml/intro.sgml
+++ b/doc/src/sgml/intro.sgml
@@ -101,22 +101,22 @@
 
    <itemizedlist spacing="compact">
     <listitem>
-     <simpara>complex queries</simpara>
+     <simpara><link linkend="sql">complex queries</link></simpara>
     </listitem>
     <listitem>
-     <simpara>foreign keys</simpara>
+     <simpara><link linkend="ddl-constraints-fk">foreign keys</link></simpara>
     </listitem>
     <listitem>
-     <simpara>triggers</simpara>
+     <simpara><link linkend="triggers">triggers</link></simpara>
     </listitem>
     <listitem>
-     <simpara>updatable views</simpara>
+     <simpara><link linkend="sql-createview-updatable-views">updatable views</link></simpara>
     </listitem>
     <listitem>
-     <simpara>transactional integrity</simpara>
+     <simpara><link linkend="transaction-iso">transactional integrity</link></simpara>
     </listitem>
     <listitem>
-     <simpara>multiversion concurrency control</simpara>
+     <simpara><link linkend="mvcc">multiversion concurrency control</link></simpara>
     </listitem>
    </itemizedlist>
 
@@ -125,22 +125,22 @@
 
    <itemizedlist spacing="compact">
     <listitem>
-     <simpara>data types</simpara>
+     <simpara><link linkend="extend-type-system">data types</link></simpara>
     </listitem>
     <listitem>
-     <simpara>functions</simpara>
+     <simpara><link linkend="xfunc">functions</link></simpara>
     </listitem>
     <listitem>
-     <simpara>operators</simpara>
+     <simpara><link linkend="xoper">operators</link></simpara>
     </listitem>
     <listitem>
-     <simpara>aggregate functions</simpara>
+     <simpara><link linkend="xaggr">aggregate functions</link></simpara>
     </listitem>
     <listitem>
-     <simpara>index methods</simpara>
+     <simpara><link linkend="xindex">index methods</link></simpara>
     </listitem>
     <listitem>
-     <simpara>procedural languages</simpara>
+     <simpara><link linkend="xplang-install">procedural languages</link></simpara>
     </listitem>
    </itemizedlist>
   </para>


^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: Intro enhancement proposal
  2022-08-09 11:13 Intro enhancement proposal Elena Indrupskaya <e.indrupskaya@postgrespro.ru>
@ 2022-08-09 11:18 ` Daniel Gustafsson <daniel@yesql.se>
  2023-10-28 18:03   ` Re: Intro enhancement proposal Bruce Momjian <bruce@momjian.us>
  0 siblings, 1 reply; 3+ messages in thread

From: Daniel Gustafsson @ 2022-08-09 11:18 UTC (permalink / raw)
  To: Elena Indrupskaya <e.indrupskaya@postgrespro.ru>; +Cc: pgsql-docs@lists.postgresql.org

> On 9 Aug 2022, at 13:13, Elena Indrupskaya <e.indrupskaya@postgrespro.ru> wrote:

> It occurred to me that adding some cross-references to intro.sgml could add value to the PostgreSQL 15 documentation through a possibility to immediately figure out what is meant by specific list items and through providing even better navigation. Details are in the attached patch.

I haven't reviewed the patch in detail yet, but skimming it I think that seems
like a good idea.

--
Daniel Gustafsson		https://vmware.com/






^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: Intro enhancement proposal
  2022-08-09 11:13 Intro enhancement proposal Elena Indrupskaya <e.indrupskaya@postgrespro.ru>
  2022-08-09 11:18 ` Re: Intro enhancement proposal Daniel Gustafsson <daniel@yesql.se>
@ 2023-10-28 18:03   ` Bruce Momjian <bruce@momjian.us>
  0 siblings, 0 replies; 3+ messages in thread

From: Bruce Momjian @ 2023-10-28 18:03 UTC (permalink / raw)
  To: Daniel Gustafsson <daniel@yesql.se>; +Cc: Elena Indrupskaya <e.indrupskaya@postgrespro.ru>; pgsql-docs@lists.postgresql.org

On Tue, Aug  9, 2022 at 01:18:25PM +0200, Daniel Gustafsson wrote:
> > On 9 Aug 2022, at 13:13, Elena Indrupskaya <e.indrupskaya@postgrespro.ru> wrote:
> 
> > It occurred to me that adding some cross-references to intro.sgml could add value to the PostgreSQL 15 documentation through a possibility to immediately figure out what is meant by specific list items and through providing even better navigation. Details are in the attached patch.
> 
> I haven't reviewed the patch in detail yet, but skimming it I think that seems
> like a good idea.

Agreed.  I adjusted some of the links and applied the attached patch to
master.

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

  Only you can decide what is important to you.

Attachments:

  [text/x-diff] master.diff (2.1K, ../../ZT1M5yCYLKj5CFOs@momjian.us/2-master.diff)
  download | inline diff:
diff --git a/doc/src/sgml/intro.sgml b/doc/src/sgml/intro.sgml
index 63eda059f0..fec72481b5 100644
--- a/doc/src/sgml/intro.sgml
+++ b/doc/src/sgml/intro.sgml
@@ -101,22 +101,22 @@
 
    <itemizedlist spacing="compact">
     <listitem>
-     <simpara>complex queries</simpara>
+     <simpara><link linkend="sql">complex queries</link></simpara>
     </listitem>
     <listitem>
-     <simpara>foreign keys</simpara>
+     <simpara><link linkend="ddl-constraints-fk">foreign keys</link></simpara>
     </listitem>
     <listitem>
-     <simpara>triggers</simpara>
+     <simpara><link linkend="triggers">triggers</link></simpara>
     </listitem>
     <listitem>
-     <simpara>updatable views</simpara>
+     <simpara><link linkend="sql-createview-updatable-views">updatable views</link></simpara>
     </listitem>
     <listitem>
-     <simpara>transactional integrity</simpara>
+     <simpara><link linkend="transaction-iso">transactional integrity</link></simpara>
     </listitem>
     <listitem>
-     <simpara>multiversion concurrency control</simpara>
+     <simpara><link linkend="mvcc">multiversion concurrency control</link></simpara>
     </listitem>
    </itemizedlist>
 
@@ -125,22 +125,22 @@
 
    <itemizedlist spacing="compact">
     <listitem>
-     <simpara>data types</simpara>
+     <simpara><link linkend="datatype">data types</link></simpara>
     </listitem>
     <listitem>
-     <simpara>functions</simpara>
+     <simpara><link linkend="functions">functions</link></simpara>
     </listitem>
     <listitem>
-     <simpara>operators</simpara>
+     <simpara><link linkend="functions">operators</link></simpara>
     </listitem>
     <listitem>
-     <simpara>aggregate functions</simpara>
+     <simpara><link linkend="functions-aggregate">aggregate functions</link></simpara>
     </listitem>
     <listitem>
-     <simpara>index methods</simpara>
+     <simpara><link linkend="indexes">index methods</link></simpara>
     </listitem>
     <listitem>
-     <simpara>procedural languages</simpara>
+     <simpara><link linkend="server-programming">procedural languages</link></simpara>
     </listitem>
    </itemizedlist>
   </para>

^ permalink  raw  reply  [nested|flat] 3+ messages in thread


end of thread, other threads:[~2023-10-28 18:03 UTC | newest]

Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2022-08-09 11:13 Intro enhancement proposal Elena Indrupskaya <e.indrupskaya@postgrespro.ru>
2022-08-09 11:18 ` Daniel Gustafsson <daniel@yesql.se>
2023-10-28 18:03   ` Bruce Momjian <bruce@momjian.us>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox