From: Jonathan S. Katz <jkatz@postgresql.org>
To: Magnus Hagander <magnus@hagander.net>
Cc: pgsql-www@lists.postgresql.org <pgsql-www@lists.postgresql.org>
Subject: Re: Release Notes Archive Patch
Date: Fri, 8 Mar 2019 11:21:38 -0800
Message-ID: <961333c1-254b-8fae-4b53-4f6fa0dfe51f@postgresql.org> (raw)
In-Reply-To: <a52310c6-513f-8966-4d91-a06120c444d1@postgresql.org>
References: <e0f09c9a-bd2b-862a-d379-601dfabc8969@postgresql.org>
<CABUevEwzO34DEeAhyb3SFvq4CMnuuHLJFKHjmuVAa-XeEbCTjw@mail.gmail.com>
<bc9038eb-e61d-4cd8-4e01-0b3676d49d68@postgresql.org>
<CABUevExFOu__h+X6YD+XtGKbv5xZKgSsxczYmJrJFo+Zb_GvCA@mail.gmail.com>
<7ec61f14-5507-c073-b25d-247befef90e2@postgresql.org>
<CABUevEwV-CGQeSpaLJVCcQy76+4ObkZMvzRJe_fs1ndrRr4exw@mail.gmail.com>
<a52310c6-513f-8966-4d91-a06120c444d1@postgresql.org>
On 3/2/19 12:22 PM, Jonathan S. Katz wrote:
This is done. Latest version attached.
Per in-person patch review, attached is the latest version.
Noted changes:
1. Fixed bug with previous/next in template
2. Only load the "content" when it is needed, i.e. when looking at the
specific release notes for a (major,minor) version pair
3. Use some arrows to make the collapsible list look more..collapsible
4. Updated some comments
Thanks,
Jonathan
From c884493494e5a29691bc85cb6c085c9cb0caecf8 Mon Sep 17 00:00:00 2001
From: "Jonathan S. Katz" <jonathan.katz@excoventures.com>
Date: Tue, 12 Feb 2019 20:50:48 +0100
Subject: [PATCH 1/2] Create Release Notes archive in the Documentation
section.
This creates a consolidated area to reference all of the notes from
previous releases of PostgreSQL, as current releases only keep the
the notes for that specific major release of PostgreSQL.
---
media/css/main.css | 29 ++++++++++
pgweb/core/templatetags/pgfilters.py | 9 +++
pgweb/docs/views.py | 98 +++++++++++++++++++++++++++++++++
pgweb/urls.py | 2 +
pgweb/util/contexts.py | 1 +
pgweb/util/db.py | 7 +++
templates/docs/release_notes.html | 104 +++++++++++++++++++++++++++++++++++
7 files changed, 250 insertions(+)
create mode 100644 pgweb/util/db.py
create mode 100644 templates/docs/release_notes.html
diff --git a/media/css/main.css b/media/css/main.cssindex e0462ad2..489ac916 100644--- a/media/css/main.css+++ b/media/css/main.css@@ -1294,6 +1294,35 @@ table.sponsor-table tbody tr td:nth-child(3) {
width: 30%;
}
+/** Release Notes */+#release-notes .navheader,+#release-notes .navfooter,+#release-notes .NAVHEADER,+#release-notes .NAVFOOTER,+#release-notes .titlepage,+#release-notes h1.SECT1,+#release-notes .toc {+ display: none;+}++#release-notes .version-list h2:after {+ content: none;+}++.release-notes-list {+ list-style-type: none;+}++.release-notes-list :not(.collapsed) > .right,+.release-notes-list .collapsed > .down {+ display: none;+}++.release-notes-list .collapsed > .right,+.release-notes-list :not(.collapsed) > .down {+ display: block;+}+
/** ALL RESPONSIVE QUERIES HERE */
/* Small devices (landscape phones, 576px and up)*/
diff --git a/pgweb/core/templatetags/pgfilters.py b/pgweb/core/templatetags/pgfilters.pyindex 13f2470c..4edeb95c 100644--- a/pgweb/core/templatetags/pgfilters.py+++ b/pgweb/core/templatetags/pgfilters.py@@ -70,3 +70,12 @@ def dictlookup(value, key):
@register.filter(name='json')
def tojson(value):
return json.dumps(value)
++@register.filter()+def release_notes_pg_minor_version(minor_version, major_version):+ """Formats the minor version number to the appropriate PostgreSQL version.+ This is particularly for very old version of PostgreSQL.+ """+ if str(major_version) in ['0', '1']:+ return str(minor_version)[2:4]+ return minor_versiondiff --git a/pgweb/docs/views.py b/pgweb/docs/views.pyindex 4577f0ce..62f0abb3 100644--- a/pgweb/docs/views.py+++ b/pgweb/docs/views.py@@ -13,6 +13,7 @@ from pgweb.util.helpers import template_to_string
from pgweb.util.misc import send_template_mail
from pgweb.core.models import Version
+from pgweb.util.db import exec_to_dict
from .models import DocPage
from .forms import DocCommentForm
@@ -140,6 +141,103 @@ def manualarchive(request):
'versions': [_VersionPdfWrapper(v) for v in versions],
})
+def release_notes(request, major_version=None, minor_version=None):+ """Contains the main archive of release notes."""+ # this query gets a list of a unique set of release notes for each version of+ # PostgreSQL. From PostgreSQL 9.4+, release notes are only present for their+ # specific version of PostgreSQL, so all legacy release notes are present in+ # 9.3 and older+ # First the query identifies all of the release note files that have been loaded+ # into the docs. We will limit our lookup to release notes from 9.3 on up,+ # given 9.3 has all the release notes for PostgreSQL 9.3 and older+ # From there, it parses the version the release notes are for+ # from the file name, and breaks it up into "major" and "minor" version from+ # our understanding of how PostgreSQL version numbering is handled, which is+ # in 3 camps: 1 and older, 6.0 - 9.6, 10 - current+ # It is then put into a unique set+ # Lastly, we determine the next/previous versions (lead/lag) so we are able+ # to easily page between the different versions in the unique release note view+ # We only include the content if we are doing an actual lookup on an exact+ # major/minor release pair, to limit how much data we load into memory+ sql = """+ SELECT+ {content}+ file, major, minor,+ lag(minor) OVER (PARTITION BY major ORDER BY minor) AS previous,+ lead(minor) OVER (PARTITION BY major ORDER BY minor) AS next+ FROM (+ SELECT DISTINCT ON (file, major, minor)+ {content}+ file,+ CASE+ WHEN v[1]::int >= 10 THEN v[1]::numeric+ WHEN v[1]::int <= 1 THEN v[1]::int+ ELSE array_to_string(v[1:2], '.')::numeric END AS major,+ COALESCE(+ CASE+ WHEN v[1]::int >= 10 THEN v[2]+ WHEN v[1]::int <= 1 THEN '.' || v[2]+ ELSE v[3]+ END::numeric, 0+ ) AS minor+ FROM (+ SELECT+ {content}+ file,+ string_to_array(regexp_replace(file, 'release-(.*)\.htm.*', '\\1'), '-') AS v+ FROM docs+ WHERE file ~ '^release-\d+' AND version >= 9.3+ ) r+ ) rr+ """+ params = []+ # if the major + minor version are provided, then we want to narrow down+ # the results to all the release notes for the minor version, as we need the+ # list of the entire set in order to generate the nice side bar in the release+ # notes+ # otherwise ensure the release notes are returned in order+ if major_version is not None and minor_version is not None:+ # at this point, include the content+ sql = sql.format(content="content,")+ # restrict to the major version, order from latest to earliest minor+ sql = """{}+ WHERE rr.major = %s+ ORDER BY rr.minor DESC""".format(sql)+ params += [major_version]+ else:+ sql = sql.format(content="")+ sql += """+ ORDER BY rr.major DESC, rr.minor DESC;+ """+ # run the query, loading a list of dict that contain all of the release+ # notes that are filtered out by the query+ release_notes = exec_to_dict(sql, params)+ # determine which set of data to pass to the template:+ # if both major/minor versions are present, we will load the release notes+ # if neither are present, we load the list of all of the release notes to list out+ if major_version is not None and minor_version is not None:+ # first, see if any release notes were returned; if not, raise a 404+ if not release_notes:+ raise Http404()+ # next, see if we can find the specific release notes we are looking for+ # format what the "minor" version should look like+ try:+ minor = Decimal('0.{}'.format(minor_version) if major_version in ['0', '1'] else minor_version)+ except TypeError:+ raise Http404()+ release_note = [r for r in release_notes if r['minor'] == minor][0]+ # of course, if nothing is found, return a 404+ if not release_note:+ raise Http404()+ context = {+ 'major_version': major_version,+ 'minor_version': minor_version,+ 'release_note': release_note,+ 'release_notes': release_notes+ }+ else:+ context = { 'release_notes': release_notes }+ return render_pgweb(request, 'docs', 'docs/release_notes.html', context)
@login_required
def commentform(request, itemid, version, filename):
diff --git a/pgweb/urls.py b/pgweb/urls.pyindex d8c664f2..80913c3f 100644--- a/pgweb/urls.py+++ b/pgweb/urls.py@@ -58,6 +58,8 @@ urlpatterns = [
url(r'^docs/$', pgweb.docs.views.root),
url(r'^docs/manuals/$', pgweb.docs.views.manuals),
url(r'^docs/manuals/archive/$', pgweb.docs.views.manualarchive),
+ url(r'^docs/release/$', pgweb.docs.views.release_notes),+ url(r'^docs/release/((?P<major_version>(\d+\.\d+)|\d+)\.(?P<minor_version>\d+))/$', pgweb.docs.views.release_notes),
# Legacy URLs for accessing the docs page; provides a permanent redirect
url(r'^docs/(current|devel|\d+(?:\.\d)?)/(static|interactive)/((.*).html?)?$', pgweb.docs.views.docspermanentredirect),
url(r'^docs/(current|devel|\d+(?:\.\d)?)/(.*).html?$', pgweb.docs.views.docpage),
diff --git a/pgweb/util/contexts.py b/pgweb/util/contexts.pyindex 25c4787e..c38f2480 100644--- a/pgweb/util/contexts.py+++ b/pgweb/util/contexts.py@@ -34,6 +34,7 @@ sitenav = {
{'title': 'Japanese', 'link': 'http://www.postgresql.jp/document/';},
{'title': 'Russian', 'link': 'https://postgrespro.ru/docs/postgresql';},
]},
+ {'title': 'Release Notes', 'link': '/docs/release/'},
{'title': 'Books', 'link': '/docs/books/'},
{'title': 'Online Resources', 'link': '/docs/online-resources/'},
{'title': 'Wiki', 'link': 'https://wiki.postgresql.org';},
diff --git a/pgweb/util/db.py b/pgweb/util/db.pynew file mode 100644index 00000000..a1efae0a--- /dev/null+++ b/pgweb/util/db.py@@ -0,0 +1,7 @@+from django.db import connection++def exec_to_dict(query, params=None):+ curs = connection.cursor()+ curs.execute(query, params)+ columns = [col[0] for col in curs.description]+ return [dict(list(zip(columns, row))) for row in curs.fetchall()]diff --git a/templates/docs/release_notes.html b/templates/docs/release_notes.htmlnew file mode 100644index 00000000..ca74e8d1--- /dev/null+++ b/templates/docs/release_notes.html@@ -0,0 +1,104 @@+{% extends "base/page.html" %}+{% load pgfilters %}++{% block extrahead %}+{% if major_version is not None and minor_version is not None %}+ <base href="/docs/{{ major_version }}/" />+{% endif %}+{% endblock extrahead %}++{%block title%}Release Notes{%endblock%}++{% block contents %}+{% regroup release_notes by major as release_note_groups %}++<div id="release-notes" class="row">+ {% if major_version is not None and minor_version is not None %}+ <div class="col-md-10">+ <section>+ <h1>Release Notes <i class="far fa-file-alt"></i></h1>+ <h2>+ {% if major_version == '0' %}Postgres95{% else %}PostgreSQL{% endif %}+ {{ major_version }}.{{ release_note.minor|release_notes_pg_minor_version:major_version }}+ </h2>+ </section>+ <div id="docContent">+ {{ release_note.content|safe }}+ </div>+ <div class="row">+ <div class="col-md-3">+ {% if release_note.previous is not None %}+ <a href="/docs/release/{{ major_version }}.{{ release_note.previous|release_notes_pg_minor_version:major_version }}/">+ Previous+ </a>+ {% endif %}+ </div>+ <div class="col-md-6 text-center">+ <p>+ <a href="/docs/release/">+ Return to the Release Notes Archive+ </a>+ </p>+ </div>+ <div class="col-md-3 text-right">+ {% if release_note.next is not None %}+ <a href="/docs/release/{{ major_version }}.{{ release_note.next|release_notes_pg_minor_version:major_version }}/">+ Next+ </a>+ {% endif %}+ </div>+ </div>+ </div>+ <div class="col-md-2 version-list">+ <section>+ <h2>Versions</h2>+ </section>+ <ul>+ {% for r in release_notes %}+ <li>+ {% if r.minor == release_note.minor %}+ <strong>+ {{ major_version }}.{{ r.minor|release_notes_pg_minor_version:major_version }}+ </strong>+ {% else %}+ <a href="/docs/release/{{ major_version }}.{{ r.minor|release_notes_pg_minor_version:major_version }}/">+ {{ major_version }}.{{ r.minor|release_notes_pg_minor_version:major_version }}+ </a>+ {% endif %}+ </li>+ {% endfor %}+ </ul>+ </div>+ {% else %}+ <div class="col-md-9">+ <section>+ <h1>Release Notes <i class="far fa-file-alt"></i></h1>+ </section>+ <p>Below is the complete archive of release notes for every version of PostgreSQL.</p>+ <ul class="release-notes-list fa-ul">+ {% for release_note_group in release_note_groups %}+ {% with major_version=release_note_group.grouper %}+ <li>+ <a class="collapsed" href="#release{{ major_version }}" data-toggle="collapse" role="button" aria-expanded="false" aria-controls="release{{ major_version }}">+ <span class="fa-li right"><i class="fas fa-angle-right"></i></span>+ <span class="fa-li down"><i class="fas fa-angle-down"></i></span>+ {% if major_version == 0 %}Postgres95{% else %}PostgreSQL {{ major_version }}{% endif %}+ </a>+ <ul class="collapse release-notes-list" id="release{{ major_version }}">+ {% for release_note in release_note_group.list %}+ <li>+ <a href="/docs/release/{{ major_version }}.{{ release_note.minor|release_notes_pg_minor_version:major_version }}/">+ {{ major_version }}.{{ release_note.minor|release_notes_pg_minor_version:major_version }}+ </a>+ </li>+ {% endfor %}+ </ul>+ </li>+ {% endwith %}+ {% endfor %}+ </ul>+ </div>+ {% endif %}+</div>++{% endblock %}
--
2.14.3 (Apple Git-98)
From ba529fe1ded5c2d66e6910e779dfe218b2944e4c Mon Sep 17 00:00:00 2001
From: "Jonathan S. Katz" <jonathan.katz@excoventures.com>
Date: Wed, 13 Feb 2019 15:22:49 -0500
Subject: [PATCH 2/2] Ensure release notes from older version still load
without 404 errors.
An upcoming change in PostgreSQL keeps only release notes in their
current versions. So e.g., PostgreSQL 11 only has the release notes
for 11.0, 11.1, 11.2 etc.
Thus, for PostgreSQL 9.4 on up, any URLs such as /docs/10/release-9-6-8.html
would return a 404. Additonal, URLs with /current/ and /devel/ would break
as well.
This patch prevents these 404s from occuring by redirecting users accessing
release notes in the 9.4 and above documentation to the older versions
of the release notes by redirecting them to the notes in the specific
version. So in the above example, a user would be redirect to
/docs/9.6/release-9-6-8.html
As we do not have documentation on the website past 7.2, any release
notes from an older version are redirected to the release notes tree
in 7.2
---
pgweb/docs/views.py | 31 ++++++++++++++++++++++++++++++-
1 file changed, 30 insertions(+), 1 deletion(-)
diff --git a/pgweb/docs/views.py b/pgweb/docs/views.pyindex 62f0abb3..54690eec 100644--- a/pgweb/docs/views.py+++ b/pgweb/docs/views.py@@ -5,8 +5,9 @@ from pgweb.util.decorators import login_required, allow_frames, content_sources
from django.db.models import Q
from django.conf import settings
-from decimal import Decimal+from decimal import Decimal, ROUND_DOWN
import os
+import re
from pgweb.util.contexts import render_pgweb
from pgweb.util.helpers import template_to_string
@@ -54,6 +55,34 @@ def docpage(request, version, filename):
return HttpResponsePermanentRedirect("/docs/{0}/{1}.html".format(int(ver), filename))
fullname = "%s.%s" % (filename, extension)
++ # Before looking up the documentation, we need to make a check for release+ # notes. Based on a change, from PostgreSQL 9.4 and up, release notes are+ # only available for the current version (e.g. 11 only has 11.0, 11.1, 11.2)+ # This checks to see if there is a mismatch (e.g. ver = 9.4, fullname = release-9-3-2.html)+ # and perform a redirect to the older version+ if fullname.startswith('release-') and ver >= Decimal("9.4"):+ # figure out which version to redirect to. Note that the oldest version+ # of the docs loaded is 7.2+ release_version = re.sub(r'release-((\d+)(-\d+)?)(-\d+)?.html',+ r'\1', fullname).replace('-', '.')+ # convert to Decimal for ease of manipulation+ release_version = Decimal(release_version)+ # if the version is greater than 10, truncate the number+ if release_version >= Decimal('10'):+ release_version = release_version.quantize(Decimal('1'), rounding=ROUND_DOWN)+ # only proceed if the release version of the documents does not match+ # the calculated release version+ if release_version != ver:+ url = "/docs/"+ if release_version >= Decimal('10'):+ url += "{}/{}".format(int(release_version), fullname)+ elif release_version < Decimal('7.2'):+ url += "7.2/{}".format(fullname)+ else:+ url += "{}/{}".format(release_version, fullname)+ return HttpResponsePermanentRedirect(url)+
page = get_object_or_404(DocPage, version=ver, file=fullname)
versions = DocPage.objects.extra(
where=["file=%s OR file IN (SELECT file2 FROM docsalias WHERE file1=%s) OR file IN (SELECT file1 FROM docsalias WHERE file2=%s)"],
--
2.14.3 (Apple Git-98)
Attachments:
[text/plain] 0001-Create-Release-Notes-archive-in-the-Documentation-se.patch (13.5K, ../961333c1-254b-8fae-4b53-4f6fa0dfe51f@postgresql.org/2-0001-Create-Release-Notes-archive-in-the-Documentation-se.patch)
download | inline diff:
From c884493494e5a29691bc85cb6c085c9cb0caecf8 Mon Sep 17 00:00:00 2001
From: "Jonathan S. Katz" <jonathan.katz@excoventures.com>
Date: Tue, 12 Feb 2019 20:50:48 +0100
Subject: [PATCH 1/2] Create Release Notes archive in the Documentation
section.
This creates a consolidated area to reference all of the notes from
previous releases of PostgreSQL, as current releases only keep the
the notes for that specific major release of PostgreSQL.
---
media/css/main.css | 29 ++++++++++
pgweb/core/templatetags/pgfilters.py | 9 +++
pgweb/docs/views.py | 98 +++++++++++++++++++++++++++++++++
pgweb/urls.py | 2 +
pgweb/util/contexts.py | 1 +
pgweb/util/db.py | 7 +++
templates/docs/release_notes.html | 104 +++++++++++++++++++++++++++++++++++
7 files changed, 250 insertions(+)
create mode 100644 pgweb/util/db.py
create mode 100644 templates/docs/release_notes.html
diff --git a/media/css/main.css b/media/css/main.cssindex e0462ad2..489ac916 100644--- a/media/css/main.css+++ b/media/css/main.css@@ -1294,6 +1294,35 @@ table.sponsor-table tbody tr td:nth-child(3) {
width: 30%;
}
+/** Release Notes */+#release-notes .navheader,+#release-notes .navfooter,+#release-notes .NAVHEADER,+#release-notes .NAVFOOTER,+#release-notes .titlepage,+#release-notes h1.SECT1,+#release-notes .toc {+ display: none;+}++#release-notes .version-list h2:after {+ content: none;+}++.release-notes-list {+ list-style-type: none;+}++.release-notes-list :not(.collapsed) > .right,+.release-notes-list .collapsed > .down {+ display: none;+}++.release-notes-list .collapsed > .right,+.release-notes-list :not(.collapsed) > .down {+ display: block;+}+
/** ALL RESPONSIVE QUERIES HERE */
/* Small devices (landscape phones, 576px and up)*/
diff --git a/pgweb/core/templatetags/pgfilters.py b/pgweb/core/templatetags/pgfilters.pyindex 13f2470c..4edeb95c 100644--- a/pgweb/core/templatetags/pgfilters.py+++ b/pgweb/core/templatetags/pgfilters.py@@ -70,3 +70,12 @@ def dictlookup(value, key):
@register.filter(name='json')
def tojson(value):
return json.dumps(value)
++@register.filter()+def release_notes_pg_minor_version(minor_version, major_version):+ """Formats the minor version number to the appropriate PostgreSQL version.+ This is particularly for very old version of PostgreSQL.+ """+ if str(major_version) in ['0', '1']:+ return str(minor_version)[2:4]+ return minor_versiondiff --git a/pgweb/docs/views.py b/pgweb/docs/views.pyindex 4577f0ce..62f0abb3 100644--- a/pgweb/docs/views.py+++ b/pgweb/docs/views.py@@ -13,6 +13,7 @@ from pgweb.util.helpers import template_to_string
from pgweb.util.misc import send_template_mail
from pgweb.core.models import Version
+from pgweb.util.db import exec_to_dict
from .models import DocPage
from .forms import DocCommentForm
@@ -140,6 +141,103 @@ def manualarchive(request):
'versions': [_VersionPdfWrapper(v) for v in versions],
})
+def release_notes(request, major_version=None, minor_version=None):+ """Contains the main archive of release notes."""+ # this query gets a list of a unique set of release notes for each version of+ # PostgreSQL. From PostgreSQL 9.4+, release notes are only present for their+ # specific version of PostgreSQL, so all legacy release notes are present in+ # 9.3 and older+ # First the query identifies all of the release note files that have been loaded+ # into the docs. We will limit our lookup to release notes from 9.3 on up,+ # given 9.3 has all the release notes for PostgreSQL 9.3 and older+ # From there, it parses the version the release notes are for+ # from the file name, and breaks it up into "major" and "minor" version from+ # our understanding of how PostgreSQL version numbering is handled, which is+ # in 3 camps: 1 and older, 6.0 - 9.6, 10 - current+ # It is then put into a unique set+ # Lastly, we determine the next/previous versions (lead/lag) so we are able+ # to easily page between the different versions in the unique release note view+ # We only include the content if we are doing an actual lookup on an exact+ # major/minor release pair, to limit how much data we load into memory+ sql = """+ SELECT+ {content}+ file, major, minor,+ lag(minor) OVER (PARTITION BY major ORDER BY minor) AS previous,+ lead(minor) OVER (PARTITION BY major ORDER BY minor) AS next+ FROM (+ SELECT DISTINCT ON (file, major, minor)+ {content}+ file,+ CASE+ WHEN v[1]::int >= 10 THEN v[1]::numeric+ WHEN v[1]::int <= 1 THEN v[1]::int+ ELSE array_to_string(v[1:2], '.')::numeric END AS major,+ COALESCE(+ CASE+ WHEN v[1]::int >= 10 THEN v[2]+ WHEN v[1]::int <= 1 THEN '.' || v[2]+ ELSE v[3]+ END::numeric, 0+ ) AS minor+ FROM (+ SELECT+ {content}+ file,+ string_to_array(regexp_replace(file, 'release-(.*)\.htm.*', '\\1'), '-') AS v+ FROM docs+ WHERE file ~ '^release-\d+' AND version >= 9.3+ ) r+ ) rr+ """+ params = []+ # if the major + minor version are provided, then we want to narrow down+ # the results to all the release notes for the minor version, as we need the+ # list of the entire set in order to generate the nice side bar in the release+ # notes+ # otherwise ensure the release notes are returned in order+ if major_version is not None and minor_version is not None:+ # at this point, include the content+ sql = sql.format(content="content,")+ # restrict to the major version, order from latest to earliest minor+ sql = """{}+ WHERE rr.major = %s+ ORDER BY rr.minor DESC""".format(sql)+ params += [major_version]+ else:+ sql = sql.format(content="")+ sql += """+ ORDER BY rr.major DESC, rr.minor DESC;+ """+ # run the query, loading a list of dict that contain all of the release+ # notes that are filtered out by the query+ release_notes = exec_to_dict(sql, params)+ # determine which set of data to pass to the template:+ # if both major/minor versions are present, we will load the release notes+ # if neither are present, we load the list of all of the release notes to list out+ if major_version is not None and minor_version is not None:+ # first, see if any release notes were returned; if not, raise a 404+ if not release_notes:+ raise Http404()+ # next, see if we can find the specific release notes we are looking for+ # format what the "minor" version should look like+ try:+ minor = Decimal('0.{}'.format(minor_version) if major_version in ['0', '1'] else minor_version)+ except TypeError:+ raise Http404()+ release_note = [r for r in release_notes if r['minor'] == minor][0]+ # of course, if nothing is found, return a 404+ if not release_note:+ raise Http404()+ context = {+ 'major_version': major_version,+ 'minor_version': minor_version,+ 'release_note': release_note,+ 'release_notes': release_notes+ }+ else:+ context = { 'release_notes': release_notes }+ return render_pgweb(request, 'docs', 'docs/release_notes.html', context)
@login_required
def commentform(request, itemid, version, filename):
diff --git a/pgweb/urls.py b/pgweb/urls.pyindex d8c664f2..80913c3f 100644--- a/pgweb/urls.py+++ b/pgweb/urls.py@@ -58,6 +58,8 @@ urlpatterns = [
url(r'^docs/$', pgweb.docs.views.root),
url(r'^docs/manuals/$', pgweb.docs.views.manuals),
url(r'^docs/manuals/archive/$', pgweb.docs.views.manualarchive),
+ url(r'^docs/release/$', pgweb.docs.views.release_notes),+ url(r'^docs/release/((?P<major_version>(\d+\.\d+)|\d+)\.(?P<minor_version>\d+))/$', pgweb.docs.views.release_notes),
# Legacy URLs for accessing the docs page; provides a permanent redirect
url(r'^docs/(current|devel|\d+(?:\.\d)?)/(static|interactive)/((.*).html?)?$', pgweb.docs.views.docspermanentredirect),
url(r'^docs/(current|devel|\d+(?:\.\d)?)/(.*).html?$', pgweb.docs.views.docpage),
diff --git a/pgweb/util/contexts.py b/pgweb/util/contexts.pyindex 25c4787e..c38f2480 100644--- a/pgweb/util/contexts.py+++ b/pgweb/util/contexts.py@@ -34,6 +34,7 @@ sitenav = {
{'title': 'Japanese', 'link': 'http://www.postgresql.jp/document/'},
{'title': 'Russian', 'link': 'https://postgrespro.ru/docs/postgresql'},
]},
+ {'title': 'Release Notes', 'link': '/docs/release/'},
{'title': 'Books', 'link': '/docs/books/'},
{'title': 'Online Resources', 'link': '/docs/online-resources/'},
{'title': 'Wiki', 'link': 'https://wiki.postgresql.org'},
diff --git a/pgweb/util/db.py b/pgweb/util/db.pynew file mode 100644index 00000000..a1efae0a--- /dev/null+++ b/pgweb/util/db.py@@ -0,0 +1,7 @@+from django.db import connection++def exec_to_dict(query, params=None):+ curs = connection.cursor()+ curs.execute(query, params)+ columns = [col[0] for col in curs.description]+ return [dict(list(zip(columns, row))) for row in curs.fetchall()]diff --git a/templates/docs/release_notes.html b/templates/docs/release_notes.htmlnew file mode 100644index 00000000..ca74e8d1--- /dev/null+++ b/templates/docs/release_notes.html@@ -0,0 +1,104 @@+{% extends "base/page.html" %}+{% load pgfilters %}++{% block extrahead %}+{% if major_version is not None and minor_version is not None %}+ <base href="/docs/{{ major_version }}/" />+{% endif %}+{% endblock extrahead %}++{%block title%}Release Notes{%endblock%}++{% block contents %}+{% regroup release_notes by major as release_note_groups %}++<div id="release-notes" class="row">+ {% if major_version is not None and minor_version is not None %}+ <div class="col-md-10">+ <section>+ <h1>Release Notes <i class="far fa-file-alt"></i></h1>+ <h2>+ {% if major_version == '0' %}Postgres95{% else %}PostgreSQL{% endif %}+ {{ major_version }}.{{ release_note.minor|release_notes_pg_minor_version:major_version }}+ </h2>+ </section>+ <div id="docContent">+ {{ release_note.content|safe }}+ </div>+ <div class="row">+ <div class="col-md-3">+ {% if release_note.previous is not None %}+ <a href="/docs/release/{{ major_version }}.{{ release_note.previous|release_notes_pg_minor_version:major_version }}/">+ Previous+ </a>+ {% endif %}+ </div>+ <div class="col-md-6 text-center">+ <p>+ <a href="/docs/release/">+ Return to the Release Notes Archive+ </a>+ </p>+ </div>+ <div class="col-md-3 text-right">+ {% if release_note.next is not None %}+ <a href="/docs/release/{{ major_version }}.{{ release_note.next|release_notes_pg_minor_version:major_version }}/">+ Next+ </a>+ {% endif %}+ </div>+ </div>+ </div>+ <div class="col-md-2 version-list">+ <section>+ <h2>Versions</h2>+ </section>+ <ul>+ {% for r in release_notes %}+ <li>+ {% if r.minor == release_note.minor %}+ <strong>+ {{ major_version }}.{{ r.minor|release_notes_pg_minor_version:major_version }}+ </strong>+ {% else %}+ <a href="/docs/release/{{ major_version }}.{{ r.minor|release_notes_pg_minor_version:major_version }}/">+ {{ major_version }}.{{ r.minor|release_notes_pg_minor_version:major_version }}+ </a>+ {% endif %}+ </li>+ {% endfor %}+ </ul>+ </div>+ {% else %}+ <div class="col-md-9">+ <section>+ <h1>Release Notes <i class="far fa-file-alt"></i></h1>+ </section>+ <p>Below is the complete archive of release notes for every version of PostgreSQL.</p>+ <ul class="release-notes-list fa-ul">+ {% for release_note_group in release_note_groups %}+ {% with major_version=release_note_group.grouper %}+ <li>+ <a class="collapsed" href="#release{{ major_version }}" data-toggle="collapse" role="button" aria-expanded="false" aria-controls="release{{ major_version }}">+ <span class="fa-li right"><i class="fas fa-angle-right"></i></span>+ <span class="fa-li down"><i class="fas fa-angle-down"></i></span>+ {% if major_version == 0 %}Postgres95{% else %}PostgreSQL {{ major_version }}{% endif %}+ </a>+ <ul class="collapse release-notes-list" id="release{{ major_version }}">+ {% for release_note in release_note_group.list %}+ <li>+ <a href="/docs/release/{{ major_version }}.{{ release_note.minor|release_notes_pg_minor_version:major_version }}/">+ {{ major_version }}.{{ release_note.minor|release_notes_pg_minor_version:major_version }}+ </a>+ </li>+ {% endfor %}+ </ul>+ </li>+ {% endwith %}+ {% endfor %}+ </ul>+ </div>+ {% endif %}+</div>++{% endblock %}--
2.14.3 (Apple Git-98)
[text/plain] 0002-Ensure-release-notes-from-older-version-still-load-w.patch (3.6K, ../961333c1-254b-8fae-4b53-4f6fa0dfe51f@postgresql.org/3-0002-Ensure-release-notes-from-older-version-still-load-w.patch)
download | inline diff:
From ba529fe1ded5c2d66e6910e779dfe218b2944e4c Mon Sep 17 00:00:00 2001
From: "Jonathan S. Katz" <jonathan.katz@excoventures.com>
Date: Wed, 13 Feb 2019 15:22:49 -0500
Subject: [PATCH 2/2] Ensure release notes from older version still load
without 404 errors.
An upcoming change in PostgreSQL keeps only release notes in their
current versions. So e.g., PostgreSQL 11 only has the release notes
for 11.0, 11.1, 11.2 etc.
Thus, for PostgreSQL 9.4 on up, any URLs such as /docs/10/release-9-6-8.html
would return a 404. Additonal, URLs with /current/ and /devel/ would break
as well.
This patch prevents these 404s from occuring by redirecting users accessing
release notes in the 9.4 and above documentation to the older versions
of the release notes by redirecting them to the notes in the specific
version. So in the above example, a user would be redirect to
/docs/9.6/release-9-6-8.html
As we do not have documentation on the website past 7.2, any release
notes from an older version are redirected to the release notes tree
in 7.2
---
pgweb/docs/views.py | 31 ++++++++++++++++++++++++++++++-
1 file changed, 30 insertions(+), 1 deletion(-)
diff --git a/pgweb/docs/views.py b/pgweb/docs/views.pyindex 62f0abb3..54690eec 100644--- a/pgweb/docs/views.py+++ b/pgweb/docs/views.py@@ -5,8 +5,9 @@ from pgweb.util.decorators import login_required, allow_frames, content_sources
from django.db.models import Q
from django.conf import settings
-from decimal import Decimal+from decimal import Decimal, ROUND_DOWN
import os
+import re
from pgweb.util.contexts import render_pgweb
from pgweb.util.helpers import template_to_string
@@ -54,6 +55,34 @@ def docpage(request, version, filename):
return HttpResponsePermanentRedirect("/docs/{0}/{1}.html".format(int(ver), filename))
fullname = "%s.%s" % (filename, extension)
++ # Before looking up the documentation, we need to make a check for release+ # notes. Based on a change, from PostgreSQL 9.4 and up, release notes are+ # only available for the current version (e.g. 11 only has 11.0, 11.1, 11.2)+ # This checks to see if there is a mismatch (e.g. ver = 9.4, fullname = release-9-3-2.html)+ # and perform a redirect to the older version+ if fullname.startswith('release-') and ver >= Decimal("9.4"):+ # figure out which version to redirect to. Note that the oldest version+ # of the docs loaded is 7.2+ release_version = re.sub(r'release-((\d+)(-\d+)?)(-\d+)?.html',+ r'\1', fullname).replace('-', '.')+ # convert to Decimal for ease of manipulation+ release_version = Decimal(release_version)+ # if the version is greater than 10, truncate the number+ if release_version >= Decimal('10'):+ release_version = release_version.quantize(Decimal('1'), rounding=ROUND_DOWN)+ # only proceed if the release version of the documents does not match+ # the calculated release version+ if release_version != ver:+ url = "/docs/"+ if release_version >= Decimal('10'):+ url += "{}/{}".format(int(release_version), fullname)+ elif release_version < Decimal('7.2'):+ url += "7.2/{}".format(fullname)+ else:+ url += "{}/{}".format(release_version, fullname)+ return HttpResponsePermanentRedirect(url)+
page = get_object_or_404(DocPage, version=ver, file=fullname)
versions = DocPage.objects.extra(
where=["file=%s OR file IN (SELECT file2 FROM docsalias WHERE file1=%s) OR file IN (SELECT file1 FROM docsalias WHERE file2=%s)"],
--
2.14.3 (Apple Git-98)
[application/pgp-signature] signature.asc (832B, ../961333c1-254b-8fae-4b53-4f6fa0dfe51f@postgresql.org/4-signature.asc)
download
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: pgsql-www@postgresql.org
Cc: jkatz@postgresql.org, magnus@hagander.net, pgsql-www@lists.postgresql.org
Subject: Re: Release Notes Archive Patch
In-Reply-To: <961333c1-254b-8fae-4b53-4f6fa0dfe51f@postgresql.org>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
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