Documentation fixes

AthenZ · Jan 17, 2017 · 8a97a3c · 8a97a3c
1 parent a728b46
commit 8a97a3c
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 3 deletions.
diff --git a/docs/dev_environment.md b/docs/dev_environment.md
@@ -6,6 +6,7 @@
     * [Maven](#maven)
     * [Git Client](#git-client)
     * [Go](#go)
+    * [Node JS](#node-js)
 * [Build Steps](#build-steps)
 
 ## Development Tools
@@ -44,14 +45,39 @@ one from [Git website](https://git-scm.com/downloads)
 Install go by following the directions at
 [Getting Started - The Go Programming Language](https://golang.org/doc/install).
 
+### Node JS
+-----------
+
+Install node by following the directions at
+[Node.js JavaScript Runtime](https://nodejs.org/en/)
+
+Verify that you have the required minimum version of `node` and
+`nodemon` binaries installed on your system and are included
+in your runtime path:
+
+```shell
+$ node --version
+v6.9.4
+$ nodemon --version
+1.11.0
+```
+
 ## Build Steps
 --------------
 
 To build Athenz components, change to the top level directory where
 Athenz code has been checked out and execute:
 
+```shell
+$ git clone https://github.com/yahoo/athenz.git
+$ cd athenz
+$ mvn clean install
 ```
-git clone https://github.com/yahoo/athenz.git
-cd athenz
-mvn clean install
+
+To build the release packages after the build has completed
+successfully:
+
+```shell
+$ cd assembly
+$ mvn clean package
 ```
diff --git a/docs/setup_ui.md b/docs/setup_ui.md
@@ -113,6 +113,7 @@ successfully validate ZMS Server's certificate.
 $ cd athenz-ui-X.Y
 $ bin/<platform>/zms-cli -c keys/zms_cert.pem -z https://<zms-server>:4443/zms/v1 add-domain athenz
 $ bin/<platform>/zms-cli -c keys/zms_cert.pem -z https://<zms-server>:4443/zms/v1 -d athenz add-service ui 0 keys/athenz.ui_pub.pem
+```
 
 ## Start UI Server
 ------------------

diff --git a/docs/setup_ui_prod.md b/docs/setup_ui_prod.md
@@ -93,6 +93,7 @@ register a new service in `athenz` domain:
 $ cd athenz-ui-X.Y
 $ bin/<platform>/zms-cli -z https://<zms-server>:4443/zms/v1 add-domain athenz
 $ bin/<platform>/zms-cli -z https://<zms-server>:4443/zms/v1 -d athenz add-service ui 0 keys/athenz.ui_pub.pem
+```
 
 ## Start UI Server
 ------------------