LP#1775466 Doc updates
authorBill Erickson <berickxx@gmail.com>
Thu, 28 Jun 2018 14:18:36 +0000 (10:18 -0400)
committerBill Erickson <berickxx@gmail.com>
Thu, 28 Jun 2018 14:18:36 +0000 (10:18 -0400)
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Open-ILS/src/eg2/README.adoc

index e4d2183..9bd4668 100644 (file)
@@ -33,7 +33,7 @@ $ sudo npm install -g @angular/cli
 === Checkout Branch
 
 * Checkout and deploy the working branch as usual.
-* Currently 'user/berick/lp1626157-ang6-app' @ working but this may change.
+* Currently 'collab/berick/lp1775466-ang6-base-app' @ working but this may change.
 
 === Install Angular Dependencies
 
@@ -59,7 +59,9 @@ $ npm run build # or build-watch
 
 === Compile Angular App -- Dev Mode
 
-* Uses the JIT compiler which is faster to compile, but slower in the browser.
+* Compile in "dev" mode using the just-in-time (JIT) compiler.
+* Dev mode compilation is faster, but requires the browser fetch
+  and execute a lot more code.
 
 [source,sh]
 ---------------------------------------------------------------------
@@ -68,15 +70,16 @@ $ ng build [--watch]
 
 === Compile Angular App -- Prod Mode
 
-* Uses the --aot compiler with --prod optimizations, which takes longer to
-compiled, but creates a smaller download which runs faster in the browser.
+* Compile in production mode.  
+* Uses the ahead-of-time (AOT) compiler and other optimizations, which 
+  is slower to compile, but faster to fetch and execute in the browser.
 
 [source,sh]
 ---------------------------------------------------------------------
-$ ng build --aot --prod
+$ ng build --prod
 ---------------------------------------------------------------------
 
-=== Testing
+=== Running Unit Tests
 
 [source,sh]
 ---------------------------------------------------------------------
@@ -84,6 +87,13 @@ $ ng build --aot --prod
 npm run test
 ---------------------------------------------------------------------
 
+=== Test code formatting (OPTIONAL)
+
+[source,sh]
+---------------------------------------------------------------------
+ng lint
+---------------------------------------------------------------------
+
 === Deploy
 
 Build and install Evergreen code as usual.  Restart Evergreen and Apache.
@@ -94,7 +104,8 @@ Navigate to https://HOSTNAME/eg2/staff/login
 
 === OPTIONAL: Running on an existing EG server
 
-Clear browser cookies for the EG server domain before logging in.
-The cookie path changes so both /eg/staff and /eg2 can share cookies.
+Log out of the browesr client or clear browser cookies for the EG server
+domain before logging in.  The cookie path changes so both /eg/staff and
+/eg2 can share cookies.