First pass at 3.3 release notes
authorDan Wells <dbw2@calvin.edu>
Thu, 28 Feb 2019 20:44:46 +0000 (15:44 -0500)
committerDan Wells <dbw2@calvin.edu>
Thu, 28 Feb 2019 20:49:04 +0000 (15:49 -0500)
Ran create_release_notes.sh, cleaned up the output a bit, and removed
the separate files.  Still TODO are acknowledgments and combing out
any upgrade notes.

Signed-off-by: Dan Wells <dbw2@calvin.edu>
12 files changed:
docs/RELEASE_NOTES_3_3.adoc [new file with mode: 0644]
docs/RELEASE_NOTES_NEXT/Administration/marc-export-copy-status.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/Administration/pingest-specify-record-atrributes.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/Architecture/postgresql10.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/Architecture/ubuntu-bionic.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/Cataloging/vandelay-angular-port.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/Circulation/patron-guardian-field.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/Circulation/privacy_waiver.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/Client/angular-booking-admin.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/Client/angular-catalog-exp.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/OPAC/UPC_Advanced_Search.adoc [deleted file]
docs/RELEASE_NOTES_NEXT/OPAC/add_booking_reservations_to_opac.adoc [deleted file]

diff --git a/docs/RELEASE_NOTES_3_3.adoc b/docs/RELEASE_NOTES_3_3.adoc
new file mode 100644 (file)
index 0000000..73e73a9
--- /dev/null
@@ -0,0 +1,273 @@
+Evergreen 3.3 Release Notes
+===========================
+:toc:
+:numbered:
+
+Upgrade notes
+-------------
+TODO
+
+
+New Features
+------------
+
+Administration
+~~~~~~~~~~~~~~
+
+Include Item Status in marc_export Items Export
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The marc_export program now includes the item status in the 852 subfield s when exporting items.
+
+Ability to Reingest Certain Record Attributes In pingest.pl
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+An option, `--attr`, has been added to the `pingest.pl` support script
+that allows the user to specify which record attributes to reingest.
+This option is used to specify which record attribute(s) to reingest.
+It can be used one or more times to specify one or more attributes to
+ingest.  It can be omitted to reingest all record attributes.  This
+option is ignored if the `--skip-attrs` option is used.
+
+The `--attr` option is most useful after doing something specific that
+requires only a partial ingest of records.  For instance, if you add a
+new language to the `config.coded_value_map` table, you will want to
+reingest the `item_lang` attribute on all of your records.  The
+following command line will do that, and only that, ingest:
+
+----
+$ /openils/bin/pingest.pl --skip-browse --skip-search --skip-facets \
+    --skip-display --attr=item_lang
+----
+
+
+
+Architecture
+~~~~~~~~~~~~
+
+Database Support for PostgreSQL 10
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The Evergreen database can now be built with PostgreSQL version 10.
+
+This update has implications for developers who write PgTap tests.  In
+versions of PostgreSQL prior to 10, one could write `\set ECHO` to
+disable the echoing of commands as they were run.  In PostgreSQL
+version 10, using `\set` without a value is an error.  One should now
+write `\set ECHO none` in order to disable the echoing of commands.
+This latter form works in all versions of PostgreSQL currently
+supported by Evergreen.
+
+Database Upgrade
+++++++++++++++++
+If you upgrade your database from a PostgreSQL version of 9.5, or
+lower, to PostgreSQL versions 9.6 or 10, you will need to recreate 3
+indexes in additon to the normal database upgrade steps.  The index
+recreation is necessary because of changes to the PostgreSQL
+`unaccent` extension module.
+
+The following snippet of SQL code will do the necessary steps:
+
+[source,sql]
+------------------------------------------------------------------------
+DROP INDEX actor_usr_first_given_name_unaccent_idx;
+DROP INDEX actor_usr_second_given_name_unaccent_idx;
+DROP INDEX actor_usr_family_name_unaccent_idx;
+CREATE INDEX actor_usr_first_given_name_unaccent_idx ON actor.usr
+      (evergreen.unaccent_and_squash(first_given_name));
+CREATE INDEX actor_usr_second_given_name_unaccent_idx ON actor.usr
+      (evergreen.unaccent_and_squash(second_given_name));
+CREATE INDEX actor_usr_family_name_unaccent_idx ON actor.usr
+      (evergreen.unaccent_and_squash(family_name));
+------------------------------------------------------------------------ 
+
+
+Ubuntu 18.04 Bionic Beaver
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+Evergreen can now be installed on Ubuntu 18.04 Bionic Beaver.  To
+install the prerequisites, use ubuntu-bionic as the Makefile.install
+target.
+
+This update also fixes a Perl warning in the HoldNotify module that is
+an error in the version of Perl (5.26) that is installed on Ubuntu
+18.04.
+
+
+
+
+Cataloging
+~~~~~~~~~~
+
+MARC Import/Export Interface Update (Angular Port)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+This MARC Import/Export (AKA Vandelay) interface is now built on
+Angular(6) instead of Dojo.  The functionality is consistent with the
+previous version of the interface, with minor UI adjustments to match
+the Angular style, plus one new interface called 'Recent Imports'
+
+Import Templates
+++++++++++++++++
+Users may now saves sets of import attributes from the MARC import form as 
+named templates.  Users may select a default template, applied on page load 
+by default, and users may delete existing templates.
+
+Recent Imports Tab
+++++++++++++++++++
+This is a new interface which allows users to see active and recent
+Vandelay sesssions originating from the same workstation or logged in
+user account.  Active sessions include real-time progress information so
+the user may track the progress without refreshing the page.
+
+This interface makes it possible to exit the main import tab or the
+Vandelay interface altogether and return at a later time to check on
+import progress.  It also allows users to kick-off multiple imports at
+the same time and follow the status of each in one interace.
+
+
+
+Circulation
+~~~~~~~~~~~
+
+Patron Parent/Guardian Field
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Patrons now have a new dedicated parent/guardian field.  This field is 
+editable in the patron edit interface, displays in the patron
+summary side bar on the browser client, and is search-able from the
+patron search interface in the browser client.
+
+Patron Editor
++++++++++++++
+In addition to the standard "show" and "suggest" visibility settings, 
+the new guardian field comes with a library setting 
+'ui.patron.edit.guardian_required_for_juv' ("GUI: Juvenile account 
+requires parent/guardian").  When this setting is applied, a value 
+will be required in the patron editor when the juvenile flag is active.
+
+Upgrade Notes
++++++++++++++
+Sites who traditionally store parent/guardian information in the
+patron 'Secondary Identification' field can migrate values from this
+field to the new guardian field with the following SQL:
+
+[source,sql]
+-------------------------------------------------------------------------
+BEGIN;
+
+-- 1. Find the local ID of the parent/guardian identification type
+
+SELECT * FROM config.identification_type;
+
+-- 2. On my test system, the id is "101".  It will vary!.
+-- Migrate the value from the ident2 field to the guardian field.
+
+UPDATE actor.usr 
+    SET guardian = ident_value2 
+WHERE 
+    ident_type2 = 101 -- !! CHANGE TO SUIT
+    AND ident_value2 IS NOT NULL 
+    AND ident_value2 <> '';
+
+-- 3. delete the original secondary identification data
+
+UPDATE actor.usr 
+    SET ident_value2 = NULL, ident_type2 = NULL
+WHERE
+    ident_type2 = 101; -- !! CHANGE TO SUIT
+
+COMMIT;
+-------------------------------------------------------------------------
+
+
+Allow Others to Use My Account (Privacy Waiver)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Patrons who wish to authorize other people to use their account may
+now do so via My Account.  In the Search and History Preferences tab
+under Account Preferences, a new section labeled "Allow others to use
+my account" allows patrons to enter a name and indicate that the
+specified person is allowed to place holds, pickup holds, view
+borrowing history, or check out items on their account.  This
+information is displayed to circulation staff in the patron account
+summary in the web client.  (Staff may also add, edit, and remove
+entries via the patron editor.)
+
+A new library setting, "Allow others to use patron account (privacy
+waiver)," is used to enable or disable this feature.
+
+
+
+Client
+~~~~~~
+
+Booking Administration Moved To Angular
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The Administration => Booking Administration pages have been ported to
+Angular using the new Angular grids.  Entry points from both AngularJS
+and Angular apps point to the new interfaces.
+
+Option to Enable Experimental Angular Staff Catalog
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A new org unit setting labeled 'GUI: Enable Experimental Angular 
+Staff Catalog' (ui.staff.angular_catalog.enabled) has been added, allowing
+sites to enable a menu option in the browser client for accessing
+the experimental Angular staff catalog.
+
+When set to true, a new entry in the navigation bar appears in the
+Cataloging menu labled "Staff Catalog (Experimental)".
+
+New Features (Since 3.2)
+++++++++++++++++++++++++
+ * Pub date filter
+ * Copy location filter
+ * Group formats and editions
+ * Identifier search
+ * MARC search
+ * Browse search
+ * Place holds
+ * Record baskets and actions
+ * Record detail tabs/actions point to AngularJS versions where needed.
+ * Record detail View In Catalog button
+
+
+
+OPAC
+~~~~
+
+View upcoming booking reservations in the OPAC
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A new tab in the My Account section of the OPAC shows
+patrons information about reservations on their account.
+Here, patrons can check on upcoming reservations, as 
+well as reservations they currently have checked out.
+
+Note: this interface pulls its timezone from the Library
+Settings Editor.  Make sure that you have a timezone
+listed for your library in the Library Settings Editor
+before using this feature.
+
+Display UPC as Option for Public Catalog Advanced Search
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The Numeric Search tab of the public catalog Advanced Search
+now includes an option to search by UPC (Universal Product Code).
+
+
+
+Acknowledgments
+---------------
+The Evergreen project would like to acknowledge the following
+organizations that commissioned developments in this release of
+Evergreen:
+
+TODO
+
+We would also like to thank the following individuals who contributed
+code, translations, documentations patches and tests to this release of
+Evergreen:
+
+TODO
+
+
+We also thank the following organizations whose employees contributed
+patches:
+
+TODO
+
+We regret any omissions.  If a contributor has been inadvertently
+missed, please open a bug at http://bugs.launchpad.net/evergreen/
+with a correction.
diff --git a/docs/RELEASE_NOTES_NEXT/Administration/marc-export-copy-status.adoc b/docs/RELEASE_NOTES_NEXT/Administration/marc-export-copy-status.adoc
deleted file mode 100644 (file)
index 7c7d287..0000000
+++ /dev/null
@@ -1,3 +0,0 @@
-Include Item Status in marc_export Items Export
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The marc_export program now includes the item status in the 852 subfield s when exporting items.
diff --git a/docs/RELEASE_NOTES_NEXT/Administration/pingest-specify-record-atrributes.adoc b/docs/RELEASE_NOTES_NEXT/Administration/pingest-specify-record-atrributes.adoc
deleted file mode 100644 (file)
index 2f3bf7e..0000000
+++ /dev/null
@@ -1,21 +0,0 @@
-Ability to Reingest Certain Record Attributes In pingest.pl
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-An option, `--attr`, has been added to the `pingest.pl` support script
-that allows the user to specify which record attributes to reingest.
-This option is used to specify which record attribute(s) to reingest.
-It can be used one or more times to specify one or more attributes to
-ingest.  It can be omitted to reingest all record attributes.  This
-option is ignored if the `--skip-attrs` option is used.
-
-The `--attr` option is most useful after doing something specific that
-requires only a partial ingest of records.  For instance, if you add a
-new language to the `config.coded_value_map` table, you will want to
-reingest the `item_lang` attribute on all of your records.  The
-following command line will do that, and only that, ingest:
-
-----
-$ /openils/bin/pingest.pl --skip-browse --skip-search --skip-facets \
-    --skip-display --attr=item_lang
-----
-
diff --git a/docs/RELEASE_NOTES_NEXT/Architecture/postgresql10.adoc b/docs/RELEASE_NOTES_NEXT/Architecture/postgresql10.adoc
deleted file mode 100644 (file)
index a4f3d06..0000000
+++ /dev/null
@@ -1,34 +0,0 @@
-Database Support for PostgreSQL 10
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The Evergreen database can now be built with PostgreSQL version 10.
-
-This update has implications for developers who write PgTap tests.  In
-versions of PostgreSQL prior to 10, one could write `\set ECHO` to
-disable the echoing of commands as they were run.  In PostgreSQL
-version 10, using `\set` without a value is an error.  One should now
-write `\set ECHO none` in order to disable the echoing of commands.
-This latter form works in all versions of PostgreSQL currently
-supported by Evergreen.
-
-Database Upgrade
-++++++++++++++++
-If you upgrade your database from a PostgreSQL version of 9.5, or
-lower, to PostgreSQL versions 9.6 or 10, you will need to recreate 3
-indexes in additon to the normal database upgrade steps.  The index
-recreation is necessary because of changes to the PostgreSQL
-`unaccent` extension module.
-
-The following snippet of SQL code will do the necessary steps:
-
-[source,sql]
-------------------------------------------------------------------------
-DROP INDEX actor_usr_first_given_name_unaccent_idx;
-DROP INDEX actor_usr_second_given_name_unaccent_idx;
-DROP INDEX actor_usr_family_name_unaccent_idx;
-CREATE INDEX actor_usr_first_given_name_unaccent_idx ON actor.usr
-      (evergreen.unaccent_and_squash(first_given_name));
-CREATE INDEX actor_usr_second_given_name_unaccent_idx ON actor.usr
-      (evergreen.unaccent_and_squash(second_given_name));
-CREATE INDEX actor_usr_family_name_unaccent_idx ON actor.usr
-      (evergreen.unaccent_and_squash(family_name));
------------------------------------------------------------------------- 
diff --git a/docs/RELEASE_NOTES_NEXT/Architecture/ubuntu-bionic.adoc b/docs/RELEASE_NOTES_NEXT/Architecture/ubuntu-bionic.adoc
deleted file mode 100644 (file)
index 5fc8d0b..0000000
+++ /dev/null
@@ -1,9 +0,0 @@
-Ubuntu 18.04 Bionic Beaver
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-Evergreen can now be installed on Ubuntu 18.04 Bionic Beaver.  To
-install the prerequisites, use ubuntu-bionic as the Makefile.install
-target.
-
-This update also fixes a Perl warning in the HoldNotify module that is
-an error in the version of Perl (5.26) that is installed on Ubuntu
-18.04.
diff --git a/docs/RELEASE_NOTES_NEXT/Cataloging/vandelay-angular-port.adoc b/docs/RELEASE_NOTES_NEXT/Cataloging/vandelay-angular-port.adoc
deleted file mode 100644 (file)
index 2baa53b..0000000
+++ /dev/null
@@ -1,28 +0,0 @@
-MARC Import/Export Interface Update (Angular Port)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This MARC Import/Export (AKA Vandelay) interface is now built on
-Angular(6) instead of Dojo.  The functionality is consistent with the
-previous version of the interface, with minor UI adjustments to match
-the Angular style, plus one new interface called 'Recent Imports'
-
-Import Templates
-++++++++++++++++
-
-Users may now saves sets of import attributes from the MARC import form as 
-named templates.  Users may select a default template, applied on page load 
-by default, and users may delete existing templates.
-
-Recent Imports Tab
-++++++++++++++++++
-
-This is a new interface which allows users to see active and recent
-Vandelay sesssions originating from the same workstation or logged in
-user account.  Active sessions include real-time progress information so
-the user may track the progress without refreshing the page.
-
-This interface makes it possible to exit the main import tab or the
-Vandelay interface altogether and return at a later time to check on
-import progress.  It also allows users to kick-off multiple imports at
-the same time and follow the status of each in one interace.
-
diff --git a/docs/RELEASE_NOTES_NEXT/Circulation/patron-guardian-field.adoc b/docs/RELEASE_NOTES_NEXT/Circulation/patron-guardian-field.adoc
deleted file mode 100644 (file)
index c629214..0000000
+++ /dev/null
@@ -1,52 +0,0 @@
-Patron Parent/Guardian Field
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Patrons now have a new dedicated parent/guardian field.  This field is 
-editable in the patron edit interface, displays in the patron
-summary side bar on the browser client, and is search-able from the
-patron search interface in the browser client.
-
-Patron Editor
-+++++++++++++
-
-In addition to the standard "show" and "suggest" visibility settings, 
-the new guardian field comes with a library setting 
-'ui.patron.edit.guardian_required_for_juv' ("GUI: Juvenile account 
-requires parent/guardian").  When this setting is applied, a value 
-will be required in the patron editor when the juvenile flag is active.
-
-Upgrade Notes
-+++++++++++++
-
-Sites who traditionally store parent/guardian information in the
-patron 'Secondary Identification' field can migrate values from this
-field to the new guardian field with the following SQL:
-
-[source,sql]
--------------------------------------------------------------------------
-BEGIN;
-
--- 1. Find the local ID of the parent/guardian identification type
-
-SELECT * FROM config.identification_type;
-
--- 2. On my test system, the id is "101".  It will vary!.
--- Migrate the value from the ident2 field to the guardian field.
-
-UPDATE actor.usr 
-    SET guardian = ident_value2 
-WHERE 
-    ident_type2 = 101 -- !! CHANGE TO SUIT
-    AND ident_value2 IS NOT NULL 
-    AND ident_value2 <> '';
-
--- 3. delete the original secondary identification data
-
-UPDATE actor.usr 
-    SET ident_value2 = NULL, ident_type2 = NULL
-WHERE
-    ident_type2 = 101; -- !! CHANGE TO SUIT
-
-COMMIT;
--------------------------------------------------------------------------
-
diff --git a/docs/RELEASE_NOTES_NEXT/Circulation/privacy_waiver.adoc b/docs/RELEASE_NOTES_NEXT/Circulation/privacy_waiver.adoc
deleted file mode 100644 (file)
index d59f652..0000000
+++ /dev/null
@@ -1,15 +0,0 @@
-Allow Others to Use My Account (Privacy Waiver)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Patrons who wish to authorize other people to use their account may
-now do so via My Account.  In the Search and History Preferences tab
-under Account Preferences, a new section labeled "Allow others to use
-my account" allows patrons to enter a name and indicate that the
-specified person is allowed to place holds, pickup holds, view
-borrowing history, or check out items on their account.  This
-information is displayed to circulation staff in the patron account
-summary in the web client.  (Staff may also add, edit, and remove
-entries via the patron editor.)
-
-A new library setting, "Allow others to use patron account (privacy
-waiver)," is used to enable or disable this feature.
-
diff --git a/docs/RELEASE_NOTES_NEXT/Client/angular-booking-admin.adoc b/docs/RELEASE_NOTES_NEXT/Client/angular-booking-admin.adoc
deleted file mode 100644 (file)
index 399ee02..0000000
+++ /dev/null
@@ -1,7 +0,0 @@
-Booking Administration Moved To Angular
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The Administration => Booking Administration pages have been ported to
-Angular using the new Angular grids.  Entry points from both AngularJS
-and Angular apps point to the new interfaces.
-
diff --git a/docs/RELEASE_NOTES_NEXT/Client/angular-catalog-exp.adoc b/docs/RELEASE_NOTES_NEXT/Client/angular-catalog-exp.adoc
deleted file mode 100644 (file)
index 8f6a3c2..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-Option to Enable Experimental Angular Staff Catalog
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-A new org unit setting labeled 'GUI: Enable Experimental Angular 
-Staff Catalog' (ui.staff.angular_catalog.enabled) has been added, allowing
-sites to enable a menu option in the browser client for accessing
-the experimental Angular staff catalog.
-
-When set to true, a new entry in the navigation bar appears in the
-Cataloging menu labled "Staff Catalog (Experimental)".
-
-New Features (Since 3.2)
-++++++++++++++++++++++++
-
- * Pub date filter
- * Copy location filter
- * Group formats and editions
- * Identifier search
- * MARC search
- * Browse search
- * Place holds
- * Record baskets and actions
- * Record detail tabs/actions point to AngularJS versions where needed.
- * Record detail View In Catalog button
-
-
diff --git a/docs/RELEASE_NOTES_NEXT/OPAC/UPC_Advanced_Search.adoc b/docs/RELEASE_NOTES_NEXT/OPAC/UPC_Advanced_Search.adoc
deleted file mode 100644 (file)
index d0c9fbd..0000000
+++ /dev/null
@@ -1,4 +0,0 @@
-Display UPC as Option for Public Catalog Advanced Search
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The Numeric Search tab of the public catalog Advanced Search
-now includes an option to search by UPC (Universal Product Code).
diff --git a/docs/RELEASE_NOTES_NEXT/OPAC/add_booking_reservations_to_opac.adoc b/docs/RELEASE_NOTES_NEXT/OPAC/add_booking_reservations_to_opac.adoc
deleted file mode 100644 (file)
index fb724c3..0000000
+++ /dev/null
@@ -1,13 +0,0 @@
-View upcoming booking reservations in the OPAC
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-A new tab in the My Account section of the OPAC shows
-patrons information about reservations on their account.
-Here, patrons can check on upcoming reservations, as 
-well as reservations they currently have checked out.
-
-Note: this interface pulls its timezone from the Library
-Settings Editor.  Make sure that you have a timezone
-listed for your library in the Library Settings Editor
-before using this feature.
-