Update upgrade instructions

Genericize version numbers, plus a few minor tweaks.

Eventually we probably need to start building the docs from tags, and
let the main branch use real placeholders.

Signed-off-by: Dan Wells <dbw2@calvin.edu>

diff --git a/docs/installation/server_upgrade.adoc b/docs/installation/server_upgrade.adoc
index 9554a99..72b2a1a 100644 (file)
--- a/docs/installation/server_upgrade.adoc
+++ b/docs/installation/server_upgrade.adoc
@@ -7,7 +7,7 @@ Software Prerequisites
 ~~~~~~~~~~~~~~~~~~~~~~
 
   * **PostgreSQL**: The minimum supported version is 9.4.
-  * **Linux**: Evergreen 2.12.0 has been tested on Debian Stretch (9.0),
+  * **Linux**: Evergreen 3.X.X has been tested on Debian Stretch (9.0),
     Debian Jessie (8.0), Ubuntu Xenial Xerus (16.04), and Ubuntu Bionic Beaver (18.04).
     If you are running an older version of these distributions, you may want
     to upgrade before upgrading Evergreen. For instructions on upgrading these
@@ -42,12 +42,12 @@ osrf_control --localhost --stop-all
  .. Back up the /openils directory.
 . Upgrade OpenSRF. Download and install the latest version of OpenSRF from
 the https://evergreen-ils.org/opensrf-downloads/[OpenSRF download page].
-. As the *opensrf* user, download and extract Evergreen 2.12.0:
+. As the *opensrf* user, download and extract Evergreen 3.X.X:
 +
 [source, bash]
 -----------------------------------------------
-wget https://evergreen-ils.org/downloads/Evergreen-ILS-2.12.0.tar.gz
-tar xzf Evergreen-ILS-2.12.0.tar.gz
+wget https://evergreen-ils.org/downloads/Evergreen-ILS-3.X.X.tar.gz
+tar xzf Evergreen-ILS-3.X.X.tar.gz
 -----------------------------------------------
 +
 [NOTE]
@@ -57,7 +57,7 @@ For the latest edition of Evergreen, check the https://evergreen-ils.org/egdownl
 +
 [source, bash]
 ---------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.12.0
+cd /home/opensrf/Evergreen-ILS-3.X.X
 ---------------------------------------------
 +
 On the next command, replace `[distribution]` with one of these values for your
@@ -80,7 +80,7 @@ make -f Open-ILS/src/extras/Makefile.install [distribution]
 +
 [source, bash]
 ------------------------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.12.0
+cd /home/opensrf/Evergreen-ILS-3.X.X
 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
 make
 ------------------------------------------------------------
@@ -91,7 +91,7 @@ These instructions assume that you have also installed OpenSRF under /openils/.
 +
 [source, bash]
 ------------------------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.12.0
+cd /home/opensrf/Evergreen-ILS-3.X.X
 make install
 ------------------------------------------------------------
 +
@@ -102,8 +102,8 @@ can supply `STAFF_CLIENT_STAMP` during the `make install` step like this:
 +
 [source, bash]
 ------------------------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.12.0
-make STAFF_CLIENT_STAMP_ID=rel_2_12_rc install
+cd /home/opensrf/Evergreen-ILS-3.X.X
+make STAFF_CLIENT_STAMP_ID=rel_3_x_x install
 ------------------------------------------------------------
 +
 . As the *root* user, change all files to be owned by the opensrf user and group:
@@ -120,7 +120,7 @@ chown -R opensrf:opensrf /openils
 ------------------------------------------------------------
 cd /openils/var/web/xul/
 rm server
-ln -sf rel_2_12_rc/server server
+ln -sf rel_3_x_x/server server
 ------------------------------------------------------------
 +
 . As the *opensrf* user, update opensrf_core.xml and opensrf.xml by copying the
@@ -140,7 +140,7 @@ Copying these configuration files will remove any customizations you have made t
 +
 [source, bash]
 -------------------------------------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.12.0
+cd /home/opensrf/Evergreen-ILS-3.X.X
 perl Open-ILS/src/support-scripts/eg_db_config --update-config --service all \
 --create-offline --database evergreen --host localhost --user evergreen --password evergreen
 -------------------------------------------------------------------------
@@ -164,21 +164,21 @@ The diff command can be used to show the differences between the distribution ve
 +
 [source, bash]
 ----------------------------------------------------------
-cp /home/opensrf/Evergreen-ILS-2.12.0/Open-ILS/examples/apache/eg_startup /etc/apache2/eg_startup
+cp /home/opensrf/Evergreen-ILS-3.X.X/Open-ILS/examples/apache/eg_startup /etc/apache2/eg_startup
 ----------------------------------------------------------
 +
 .. Update /etc/apache2/eg_vhost.conf by copying the example from Open-ILS/examples/apache/eg_vhost.conf.
 +
 [source, bash]
 ----------------------------------------------------------
-cp /home/opensrf/Evergreen-ILS-2.12.0/Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/eg_vhost.conf
+cp /home/opensrf/Evergreen-ILS-3.X.X/Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/eg_vhost.conf
 ----------------------------------------------------------
 +
 .. Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/examples/apache/eg.conf.
 +
 [source, bash]
 ----------------------------------------------------------
-cp /home/opensrf/Evergreen-ILS-2.12.0/Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/eg.conf
+cp /home/opensrf/Evergreen-ILS-3.X.X/Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/eg.conf
 ----------------------------------------------------------
 
 Upgrade the Evergreen database schema
@@ -201,28 +201,13 @@ anything goes wrong during the upgrade.
 =============
 Evergreen provides incremental upgrade scripts that allow you to upgrade
 from one minor version to the next until you have the current version of
-the schema. For example, if you want to upgrade from 2.5.1 to 2.12.0, you
+the schema. For example, if you want to upgrade from 2.9.0 to 2.11.0, you
 would run the following upgrade scripts:
 
-- 2.5.1-2.5.2-upgrade-db.sql
-- 2.5.2-2.5.3-upgrade-db.sql
-- 2.5.3-2.6.0-upgrade-db.sql (this is a major version upgrade)
-- 2.6.2-2.6.3-upgrade-db.sql
-- 2.6.3-2.7.0-upgrade-db.sql (this is a major version upgrade)
-- 2.7.0-2.7.1-upgrade-db.sql
-- 2.7.1-2.7.2-upgrade-db.sql
-- 2.7.2-2.7.3-upgrade-db.sql
-- 2.7.3-2.7.4-upgrade-db.sql
-- 2.7.4-2.8.0-upgrade-db.sql (this is a major version upgrade)
-- 2.8.0-2.8.1-upgrade-db.sql
-- 2.8.1-2.8.2-upgrade-db.sql
-- 2.8.2-2.8.3-upgrade-db.sql
-- 2.8.3-2.8.4-upgrade-db.sql
-- 2.8.4-2.9.0-upgrade-db.sql (this is a major version upgrade)
 - 2.9.0-2.9.1-upgrade-db.sql
 - 2.9.1-2.9.2-upgrade-db.sql
 - 2.9.2-2.9.3-upgrade-db.sql
-- 2.9.3-2.10.0-upgrade-db.sql
+- 2.9.3-2.10.0-upgrade-db.sql (this is a major version upgrade)
 - 2.10.0-2.10.1-upgrade-db.sql
 - 2.10.1-2.10.2-upgrade-db.sql
 - 2.10.2-2.10.3-upgrade-db.sql
@@ -231,38 +216,11 @@ would run the following upgrade scripts:
 - 2.10.5-2.10.6-upgrade-db.sql
 - 2.10.6-2.10.7-upgrade-db.sql
 - 2.10.7-2.11.0-upgrade-db.sql (this is a major version upgrade)
-- 2.11.0-2.11.1-upgrade-db.sql
-- 2.11.1-2.11.2-upgrade-db.sql
-- 2.11.2-2.11.3-upgrade-db.sql
-- 2.11.3-2.12.0-upgrade-db.sql (this is a major version upgrade)
 
-Note that you do *not* want to run additional 2.5 scripts to upgrade to the
-newest version of 2.5, since currently there is no automated way to upgrade
-from 2.5.4+ to 2.6. Only upgrade as far as necessary to reach the major
-version upgrade script (in this example, as far as 2.5.3).
-
-To upgrade across multiple major versions (e.g. from 2.3.0 to 2.12.0), use
-the same logic to utilize the provided major version upgrade scripts. For
-example:
-
-- 2.3-2.4.0-upgrade-db.sql
-- 2.3-2.4-supplemental.sh
-- (run all incremental scripts from 2.4.0 to 2.4.3)
-- 2.4.3-2.5.0-upgrade-db.sql
-- (run all incremental scripts from 2.5.0 to 2.5.3)
-- 2.5.3-2.6.0-upgrade-db.sql
-- (run all incremental scripts from 2.6.0 to 2.6.3)
-- 2.6.3-2.7.0-upgrade-db.sql
-- (run all incremental scripts from 2.7.0 to 2.7.4)
-- 2.7.4-2.8.0-upgrade-db.sql
-- (run all incremental scripts from 2.8.0 to 2.8.4)
-- 2.8.4-2.9.0-upgrade-db.sql
-- (run all incremental scripts from 2.9.0 to 2.9.3)
-- 2.9.3-2.10.0-upgrade-db.sql
-- (run all incremental scripts from 2.10.0 to 2.10.7)
-- 2.10.7-2.11.0-upgrade-db.sql
-- (run all incremental scripts from 2.11.0 to 2.11.3)
-- 2.11.3-2.12.0-upgrade-db.sql
+Note that you do *not* necessarily want to run additional upgrade scripts to
+upgrade to the newest version, since currently there is no automated way, for
+example to upgrade from 2.9.4+ to 2.10. Only upgrade as far as necessary to
+reach the major version upgrade script (in this example, as far as 2.9.3).
 
 =============
 
@@ -277,8 +235,8 @@ as a user with the ability to connect to the database server.
 
 [source, bash]
 ----------------------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.12.0/Open-ILS/src/sql/Pg
-psql -U evergreen -h localhost -f version-upgrade/2.11.3-2.12.0-upgrade-db.sql evergreen
+cd /home/opensrf/Evergreen-ILS-3.X.X/Open-ILS/src/sql/Pg
+psql -U evergreen -h localhost -f version-upgrade/3.X.W-3.X.X-upgrade-db.sql evergreen
 ----------------------------------------------------------
 
 [TIP]