public inbox for [email protected]  
help / color / mirror / Atom feed
From: Bruce Momjian <[email protected]>
To: Marcos Pegoraro <[email protected]>
Cc: Alvaro Herrera <[email protected]>
Cc: jian he <[email protected]>
Cc: Jelte Fennema-Nio <[email protected]>
Cc: Tom Lane <[email protected]>
Cc: Daniel Gustafsson <[email protected]>
Cc: PostgreSQL Hackers <[email protected]>
Subject: Re: Detailed release notes
Date: Tue, 17 Sep 2024 20:13:20 -0400
Message-ID: <[email protected]> (raw)
In-Reply-To: <CAB-JLwYJ_hA1NTOumL_NAmONq9Y8By0jMvfwDASVX4ArAmqTng@mail.gmail.com>
References: <[email protected]>
	<[email protected]>
	<CAB-JLwYJ_hA1NTOumL_NAmONq9Y8By0jMvfwDASVX4ArAmqTng@mail.gmail.com>

On Tue, Sep 17, 2024 at 03:29:54PM -0300, Marcos Pegoraro wrote:
> Em ter., 17 de set. de 2024 às 05:12, Alvaro Herrera <[email protected]>
> escreveu:
> 
>     Add backend support for injection points (Michael Paquier) [commit 1] [2]
>     [3] [4]
> 
> I think this way would be fine.
> 
> And it would be good to have a 
> target="_blank"
> on commit links so a new window or tab would be opened instead of going back
> and forth. 
> This way you can open these 4 links and then navigate on them to see exactly
> what was done on every commit.

I think trying to add text to each item is both redundant and confusing,
because I am guessing that many people will not even know what a commit
is, and will be confused by clicking on the link.

What I have done is to add text to the top of "Appendix E. Release
Notes" explaining the symbol and what it links to.   Patch attached.

We can still consider a different symbol or number labeling, but I think
this patch is in the right direction.

-- 
  Bruce Momjian  <[email protected]>        https://momjian.us
  EDB                                      https://enterprisedb.com

  When a patient asks the doctor, "Am I going to die?", he means 
  "Am I going to die soon?"


Attachments:

  [text/x-diff] section.diff (897B, ../[email protected]/2-section.diff)
  download | inline diff:
diff --git a/doc/src/sgml/release.sgml b/doc/src/sgml/release.sgml
index cf6ba540876..8d408a50eb1 100644
--- a/doc/src/sgml/release.sgml
+++ b/doc/src/sgml/release.sgml
@@ -69,6 +69,15 @@ For new features, add links to the documentation sections.
    review, so each item is truly a community effort.
   </para>
 
+  <para>
+   Section markers (&sect;) in the release notes link to <ulink
+   url="https://git.postgresql.org/gitweb/?p=postgresql.git"><application>gitweb</application></ulink>
+   pages which show the primary <application>git</application> commit
+   messages and source tree changes responsible for the release note item.
+   There might be additional <application>git</application> commits which
+   are not shown.
+  </para>
+
 <!--
   When beginning a new major-release series, create a new release-NN.sgml
   file, removing the previous one, and change the &-reference here.


view thread (12+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected]
  Subject: Re: Detailed release notes
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

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