From 5a182463d3067fe475fa50055927854085f45468 Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Fri, 3 Aug 2012 09:21:18 -0400 Subject: [PATCH] Documentation: adjust documentation for 2_3 release. Comment out chapters in root.txt except for basic documentation. Update upgrade instructions for the 2.3 alpha2 release. Signed-off-by: Robert Soulliere --- docs/installation/server_upgrade.txt | 24 +++--- docs/root.txt | 106 +++++++++++++-------------- 2 files changed, 65 insertions(+), 65 deletions(-) diff --git a/docs/installation/server_upgrade.txt b/docs/installation/server_upgrade.txt index c1e6650594..c3f13178e6 100644 --- a/docs/installation/server_upgrade.txt +++ b/docs/installation/server_upgrade.txt @@ -42,12 +42,12 @@ osrf_ctl.sh -l -a stop_all .. Back up the /openils directory. . Upgrade OpenSRF. Download and install the latest version of OpenSRF from the http://evergreen-ils.org/opensrf.php[OpenSRF download page]. -. As the opensrf user, download and extract Evergreen 2.2: +. As the opensrf user, download and extract Evergreen 2.3: + [source, bash] ----------------------------------------------- -wget http://evergreen-ils.org/downloads/Evergreen-ILS-2.2.0.tar.gz -tar xzf Evergreen-ILS-2.2.0.tar.gz +wget http://evergreen-ils.org/downloads/Evergreen-ILS-2.3.0_alpha2.tar.gz +tar xzf Evergreen-ILS-2.3.0_alpha2.tar.gz ----------------------------------------------- + [NOTE] @@ -57,7 +57,7 @@ For the latest edition of Evergreen, check the http://evergreen-ils.org/download + [source, bash] ---------------------------------------------- -cd /home/opensrf/Evergreen-ILS-2.2.0 +cd /home/opensrf/Evergreen-ILS-2.3.0_alpha2 --------------------------------------------- + On the next command, replace `[distribution]` with one of these values for your @@ -76,7 +76,7 @@ make -f Open-ILS/src/extras/Makefile.install [distribution] + [source, bash] ------------------------------------------------------------ -cd /home/opensrf/Evergreen-ILS-2.2.0 +cd /home/opensrf/Evergreen-ILS-2.3.0.alpha2 ./configure --prefix=/openils --sysconfdir=/openils/conf make ------------------------------------------------------------ @@ -85,8 +85,8 @@ make + [source, bash] ------------------------------------------------------------ -cd /home/opensrf/Evergreen-ILS-2.2.0 -make STAFF_CLIENT_STAMP_ID=rel_2_2_0 install +cd /home/opensrf/Evergreen-ILS-2.3.0.alpha2 +make STAFF_CLIENT_STAMP_ID=rel_2_3.0.alpha2 install ------------------------------------------------------------ + . As the root user, change all files to be owned by the opensrf user and group: @@ -100,7 +100,7 @@ chown -R opensrf:opensrf /openils + [source, bash] ----------------------------------------------------------- -cd /home/opensrf/Evergreen-ILS-2.2.0 +cd /home/opensrf/Evergreen-ILS-2.3.0.alpha2 perl Open-ILS/src/support-scripts/eg_db_config.pl \ --create-offline --user evergreen --password evergreen \ @@ -113,7 +113,7 @@ perl Open-ILS/src/support-scripts/eg_db_config.pl \ ----------------------------------------------------------- cd /openils/var/web/xul/ rm server -ln -s rel_2_2_0/server +ln -s rel_2_3_0_alpha2/server ---------------------------------------------------------- + . As the opensrf user, update opensrf_core.xml and opensrf.xml by copying the @@ -146,7 +146,7 @@ opensrf.xml.example, then: [source, bash] ------------------------------------------------------------------------- cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml -cd /home/opensrf/Evergreen-ILS-2.2.0 +cd /home/opensrf/Evergreen-ILS-2.3.0.alpha2 perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all \ --database evergreen --host localhost --user evergreen --password evergreen ------------------------------------------------------------------------- @@ -179,8 +179,8 @@ database server connection information: [source, bash] ---------------------------------------------------------- -cd /home/opensrf/Evergreen-ILS-2.2.0/Open-ILS/src/sql/Pg -psql -U evergreen -h localhost -f version-upgrade/2.1-2.2-upgrade-db.sql evergreen +cd /home/opensrf/Evergreen-ILS-2.3.0.alpha2/Open-ILS/src/sql/Pg +psql -U evergreen -h localhost -f version-upgrade/2.2-2_3_0_alpha2-upgrade-db.sql evergreen ---------------------------------------------------------- Restart Evergreen and Test diff --git a/docs/root.txt b/docs/root.txt index 965ef8d33e..f49a722beb 100644 --- a/docs/root.txt +++ b/docs/root.txt @@ -60,7 +60,7 @@ in over a dozen countries worldwide. // Push titles down one level. :leveloffset: 1 -include::RELEASE_NOTES_2_2.txt[] +include::RELEASE_NOTES_2_3.txt[] // Return to normal title levels. :leveloffset: 0 @@ -88,7 +88,7 @@ include::installation/server_installation.txt[] include::installation/server_upgrade.txt[] -include::installation/edi_setup.txt[] +// include::installation/edi_setup.txt[] // include::staff_client_installation.txt[] // include::org_unit_structure_initialization.txt[] @@ -108,11 +108,11 @@ for configuring the system as well as customizing the OPAC and staff client. // include::global_system_configuration.txt[] // include::opac_customization.txt[] -include::admin/template_toolkit.txt[] +// include::admin/template_toolkit.txt[] -include::admin/auto_suggest_search.txt[] +// include::admin/auto_suggest_search.txt[] -include::admin/customize_staff_client.txt[] +// include::admin/customize_staff_client.txt[] // include::backing_up.txt[] @@ -129,15 +129,15 @@ This part of the documentation deals with general Staff Client usage including logging in, navigation and shortcuts. -include::admin/staff_client-tab_buttons.txt[] +// include::admin/staff_client-tab_buttons.txt[] -include::admin/staff_client-double_clicking.txt[] +// include::admin/staff_client-double_clicking.txt[] -include::admin/staff_client-sorting_columns.txt[] +// include::admin/staff_client-sorting_columns.txt[] -include::admin/staff_client-recent_searches.txt[] +// include::admin/staff_client-recent_searches.txt[] -include::admin/staff_client-return_to_results_from_marc.txt[] +// include::admin/staff_client-return_to_results_from_marc.txt[] System Administration From the Staff Client =========================================== @@ -150,21 +150,21 @@ staff client. // Follow structure from staff client system admin menu. -include::admin/acquisitions_admin.txt[] +// include::admin/acquisitions_admin.txt[] -include::admin/authorities.txt[] +// include::admin/authorities.txt[] -include::admin/cn_prefixes_and_suffixes.txt[] +// include::admin/cn_prefixes_and_suffixes.txt[] -include::admin/restrict_Z39.50_sources_by_perm_group.txt[] +// include::admin/restrict_Z39.50_sources_by_perm_group.txt[] -include::admin/booking-admin.txt[] +// include::admin/booking-admin.txt[] -include::admin/permissions.txt[] +// include::admin/permissions.txt[] -include::admin/SMS_messaging.txt[] +// include::admin/SMS_messaging.txt[] -include::admin/user_activity_type.txt[] +// include::admin/user_activity_type.txt[] Local Administration @@ -181,28 +181,28 @@ client. // Push titles down one level. :leveloffset: 1 -include::admin/hold_driven_recalls.txt[] +// include::admin/hold_driven_recalls.txt[] // Return to normal title levels. :leveloffset: 0 -include::admin/recent_staff_searches.txt[] +// include::admin/recent_staff_searches.txt[] -include::admin/lsa-library_settings_editor.txt[] +// include::admin/lsa-library_settings_editor.txt[] -include::admin/lsa-statcat.txt[] +// include::admin/lsa-statcat.txt[] Acquisitions =========== -include::acquisitions/introduction.txt[] + include::acquisitions/introduction.txt[] -include::acquisitions/selection_lists_po.txt[] +// include::acquisitions/selection_lists_po.txt[] -include::acquisitions/receive_items_from_invoice.txt[] +// include::acquisitions/receive_items_from_invoice.txt[] -include::acquisitions/vandelay_acquisitions_integration.txt[] +// include::acquisitions/vandelay_acquisitions_integration.txt[] Cataloging @@ -214,13 +214,13 @@ Introduction Cataloguers should use this part for understanding the cataloguing procedures used in Evergreen. -include::cataloging/batch_importing_MARC.txt[] +// include::cataloging/batch_importing_MARC.txt[] -include::cataloging/overlay_record_3950_import.txt[] +// include::cataloging/overlay_record_3950_import.txt[] -include::cataloging/monograph_parts.txt[] +// include::cataloging/monograph_parts.txt[] -include::cataloging/conjoined_items.txt[] +// include::cataloging/conjoined_items.txt[] Serials @@ -228,21 +228,21 @@ Serials include::serials/A-intro.txt[] -include::serials/B-copy_template.txt[] +// include::serials/B-copy_template.txt[] -include::serials/C-subscription-SCV.txt[] +// include::serials/C-subscription-SCV.txt[] -include::serials/D-subscription-ASCV.txt[] +// include::serials/D-subscription-ASCV.txt[] -include::serials/E-edit_subscriptions.txt[] +// include::serials/E-edit_subscriptions.txt[] -include::serials/F-Receiving.txt[] +// include::serials/F-Receiving.txt[] -include::serials/G-Special_issue.txt[] +// include::serials/G-Special_issue.txt[] -include::serials/H-holdings_statements.txt[] +// include::serials/H-holdings_statements.txt[] -include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[] +// include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[] Circulation =========== @@ -253,11 +253,11 @@ Introduction Use this section for understanding the circulation procedures in the Evergreen system. -include::circulation/circulating_items.txt[] +// include::circulation/circulating_items.txt[] -include::circulation/booking.txt[] +// include::circulation/booking.txt[] -include::circulation/circulation_patron_records.txt[] +// include::circulation/circulation_patron_records.txt[] Reports ======= @@ -267,25 +267,25 @@ Introduction Learn how to create and use reports in Evergreen. -include::reports/reporter_daemon.txt[] +// include::reports/reporter_daemon.txt[] -include::reports/reporter_folder.txt[] +// include::reports/reporter_folder.txt[] -include::reports/reporter_create_templates.txt[] +// include::reports/reporter_create_templates.txt[] -include::reports/reporter_generating_reports.txt[] +// include::reports/reporter_generating_reports.txt[] -include::reports/reporter_view_output.txt[] +// include::reports/reporter_view_output.txt[] -include::reports/reporter_cloning_shared_templates.txt[] +// include::reports/reporter_cloning_shared_templates.txt[] -include::reports/reporter_add_data_source.txt[] +// include::reports/reporter_add_data_source.txt[] -include::reports/running_recurring_reports.txt[] +// include::reports/running_recurring_reports.txt[] -include::reports/reporter_template_termionology.txt[] +// include::reports/reporter_template_termionology.txt[] -include::reports/reporter_export_usingpgAdmin.txt[] +// include::reports/reporter_export_usingpgAdmin.txt[] Using the Public Access Catalog =============================== @@ -295,7 +295,7 @@ Introduction Use this part for information about searching the Evergreen public access catalog. -include::opac/my_lists.txt[] +// include::opac/my_lists.txt[] Developer Resources =================== @@ -309,7 +309,7 @@ communication protocols and standards used in Evergreen. // Push titles down one level. :leveloffset: 1 -include::development/updating_translations_launchpad.txt[] +// include::development/updating_translations_launchpad.txt[] // Return to normal title levels. :leveloffset: 0 -- 2.43.2