From: Bill Erickson <berickxx@gmail.com>
Date: Tue, 17 Sep 2019 18:56:16 +0000 (-0400)
Subject: Tech notes continued
X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=d10003c52a8b61281433e03488a4857b0845f6be;p=working%2FEvergreen.git

Tech notes continued

Signed-off-by: Bill Erickson <berickxx@gmail.com>
---

diff --git a/docs/TechRef/elasticsearch.adoc b/docs/TechRef/elasticsearch.adoc
index bc5850afbd..5b3408fc2e 100644
--- a/docs/TechRef/elasticsearch.adoc
+++ b/docs/TechRef/elasticsearch.adoc
@@ -1,11 +1,22 @@
 = Elasticsearch and Evergreen =
 
+== Goals ==
+
+Fast bib record searching without requiring significant changes to
+the Evergreen code and without requiring a brand new indexing configuration.
+
+Initially support integration with the Angular staff catalog, covering 
+most search features commonly used by staff.
+
+Allow for expanding use to other interfaces (e.g. TPAC) and extending
+functionatlity.
+
 == Installation ==
 
 1. Check out this Evergreen branch.
 2. Apply SQL Open-ILS/src/sql/Pg/upgrade/XXXX.schema.elastic-search.sql
 3. cd Open-ILS/src/eg2/ && npm install # new dependency
-4. Install branch
+4. Build and Install branch
 
 == Configuration ==
 
@@ -35,7 +46,7 @@ definitions or modifications are required to get started.
 === General Stucture ===
 
 The bib-search index contains 3 general categories of data for each 
-non-deleted bib record: 
+bib record: 
 
 1. Bib record search/filter data pulled from metabib fields and record 
    attribute definitions