LP#1680566 Document open-ils.permacrud removal

Add release notes documenting removal of the open-ils.permacrud
service and recommended steps (based partially on the
open-ils.ingest service removal release notes).

Signed-off-by: Jeff Godin <jgodin@tadl.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

diff --git a/docs/RELEASE_NOTES_NEXT/removal_of_permacrud_service.adoc b/docs/RELEASE_NOTES_NEXT/removal_of_permacrud_service.adoc
new file mode 100644 (file)
index 0000000..0d99c61
--- /dev/null
+++ b/docs/RELEASE_NOTES_NEXT/removal_of_permacrud_service.adoc
@@ -0,0 +1,30 @@
+Removal of open-ils.permacrud service
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The open-ils.permacrud service has been deprecated for some time
+now. The open-ils.pcrud service should be used in its place.
+
+This release does not include the open-ils.permacrud service, and
+you should consider removing it from your existing install at
+upgrade time.
+
+If you are upgrading an existing install where the
+open-ils.permacrud service was present, you should update your
+opensrf_core.xml and opensrf.xml files to remove references to
+open-ils.permacrud, and you may also wish to remove the
+OpenILS/Application/PermaCrud.pm file from your Perl @INC path.
+
+In opensrf_core.xml, remove open-ils.permacrud from the list of
+services on the public router.
+
+In opensrf.xml, remove the entire <open-ils.permacrud> element from
+the <apps> element, and remove <appname>open-ils.permacrud</appname>
+from any <activeapps> elements where it is present.
+
+If you have the perldoc command installed, you can use the following
+command to locate the path on disk of the PermaCrud.pm file, which
+is no longer required and can be removed:
+
+[source, bash]
+-----------------------------------------------------------------
+perldoc -l OpenILS::Application::PermaCrud
+-----------------------------------------------------------------