incubator-spot git commit: Improves UI Install documentation

[ev...@apache.org]

Repository: incubator-spot
Updated Branches:
  refs/heads/master be3849dbe -> f05dde6af


Improves UI Install documentation


Project: http://git-wip-us.apache.org/repos/asf/incubator-spot/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-spot/commit/f05dde6a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-spot/tree/f05dde6a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-spot/diff/f05dde6a

Branch: refs/heads/master
Commit: f05dde6aff9b313e0aca9187bc57fe77d018a2d1
Parents: be3849d
Author: Diego Ortiz Huerta <di...@intel.com>
Authored: Wed Mar 8 14:30:49 2017 -0800
Committer: Everardo Lopez Sandoval (Intel) <el...@elopezsa-mac02.local>
Committed: Tue Mar 14 10:56:37 2017 -0600

----------------------------------------------------------------------
 spot-oa/README.md     | 13 ++++++-------
 spot-oa/ui/INSTALL.md | 22 ++++++++++++----------
 2 files changed, 18 insertions(+), 17 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-spot/blob/f05dde6a/spot-oa/README.md
----------------------------------------------------------------------
diff --git a/spot-oa/README.md b/spot-oa/README.md
index 27976e6..ee9b85b 100644
--- a/spot-oa/README.md
+++ b/spot-oa/README.md
@@ -1,5 +1,5 @@
 # **Apache Spot (incubating)**
-Apache Spots (incubating) Operational Analytics (OA) is a collection of modules, which includes both the data processing and transformation as well as the GUI module for data visualization. 
+Apache Spot (incubating) Operational Analytics (OA) is a collection of modules, which includes both the data processing and transformation as well as the GUI module for data visualization.
 
 The visualization repository (UI folder) contains all the front-end code and files related to the Open Network Insight visual elements, such as styles, pages, data files, etc.
 Some of the technologies used are:
@@ -16,7 +16,7 @@ Some of the technologies used are:
 ## **Installation**
 
 1. Install python dependencies `pip install -r requirements.txt`
-2. Install and build NPM requirements with `npm install`
+2. Install UI requirements and build UI following the steps from [here](ui/INSTALL.md)
 
 ## **Folder Structure**
 
@@ -35,19 +35,19 @@ spot-oa is the root folder, below are more details about child folders:
 
 ## **IPython Notebooks**
 * Flow
- * [EdgeNotebook](/spot-oa/oa/flow/ipynb_templates/EdgeNotebook.md) 
+ * [EdgeNotebook](/spot-oa/oa/flow/ipynb_templates/EdgeNotebook.md)
  * [ThreatInvestigation](/spot-oa/oa/flow/ipynb_templates/ThreatInvestigation.md)
 * DNS
- * [EdgeNotebook](/spot-oa/oa/dns/ipynb_templates/EdgeNotebook.md) 
+ * [EdgeNotebook](/spot-oa/oa/dns/ipynb_templates/EdgeNotebook.md)
  * [ThreatInvestigation](/spot-oa/oa/dns/ipynb_templates/ThreatInvestigation.md)
 * PROXY
- * [EdgeNotebook](/spot-oa/oa/proxy/ipynb_templates/EdgeNotebook.md) 
+ * [EdgeNotebook](/spot-oa/oa/proxy/ipynb_templates/EdgeNotebook.md)
  * [ThreatInvestigation](/spot-oa/oa/proxy/ipynb_templates/ThreatInvestigation.md)
 
 ##**Views**
 
 ###Analyst View (suspicious.html)
-The Analyst view provides a dashboard showing the top 250 suspicious connects. 
+The Analyst view provides a dashboard showing the top 250 suspicious connects.
 
 ###**Threat Investigation (threat-investigation.html)**
 HTML page container for the Threat Investigation Notebook
@@ -57,4 +57,3 @@ Executive Briefing dashboard
 
 ###**Ingest Summary (ingest-summary.html)**
 Interactive histogram dashboard that shows the amount of data captured in a certain period of time.
-

http://git-wip-us.apache.org/repos/asf/incubator-spot/blob/f05dde6a/spot-oa/ui/INSTALL.md
----------------------------------------------------------------------
diff --git a/spot-oa/ui/INSTALL.md b/spot-oa/ui/INSTALL.md
index 1d70e2b..8f27a6e 100755
--- a/spot-oa/ui/INSTALL.md
+++ b/spot-oa/ui/INSTALL.md
@@ -13,26 +13,28 @@ Here you will find instructions to get Spot UI up and running. For more informat
 
 ## Install Spot UI
 
-1. Go to Spot UI folder
+1. Install Python dependencies following the steps from [here](../README.md)
 
-	`$ cd PATH_TO_SPOT/ui/`
+2. Go to Spot UI dir
 
-2. With root privileges, install browserify and uglify as global commands on your system.
+    `$ cd PATH_TO_SPOT/spot-oa/ui/`
 
-	`# npm install -g browserify uglifyjs`
+3. With root privileges, install browserify and uglify as global commands on your system.
 
-3. Install dependencies and build Spot UI
+    `# npm install -g browserify uglifyjs`
 
-	`$ npm install`
+4. As a regular user install dependencies and build Spot UI
+
+    `$ npm install`
 
 ## How to run Spot UI
 
-1. Go to Spot UI folder
+1. Go to Spot OA dir
 
-	`$ cd PATH_TO_SPOT/`
+    `$ cd PATH_TO_SPOT/spot-oa/`
 
 2. Start the web server
 
-	`$ ./runIpython.sh`
+    `$ ./runIpython.sh`
 
-3. Verify your installation by going to one of the URLs found [here](https://github.com/Open-Network-Insight/open-network-insight/wiki/Suspicious%20Connects).
+3. Verify your installation, go to http://SPOT_OA_SERVER:8889/files/ui/flow/suspicious.html.