[#57] Organize and update documentation

docs/Getting_Started/How_To_Build.md

@@ -1,5 +1,5 @@
 **How To Build:**
 
-0. Check the [Supported Hadoop Versions](getting_started/Supported_Hadoop_Versions.md) page for what versions you can build for.
+0. Check the [Supported Hadoop Versions](Supported_Hadoop_Versions/) page for what versions you can build for.
 1. To build the RPM: `./gradlew clean buildRpm -PhadoopVersion=X.X.X`
 2. Find the RPM in: `cd build/distributions/`

docs/Getting_Started/How_To_Run.md

@@ -1,10 +1,10 @@
 **How To Run:**
 
 0. (Optional) Check out `/usr/local/nn-analytics/bin/nn_loader` and observe that the JVM set-up is adequate for your needs. Modify the shell scripts as necessary for your environment. It is possible to change the classpath here and point to your own HDFS installations.
-1. As root, run: `service nn-analytics start`
+1. Run: `sudo service nn-analytics start`
 2. (Optional) On your browser hit: `http(s)://HOSTNAME:8080/namespace.html` and fetch the latest image and then `service nn-analytics restart` if this is your first run.
 3. If any issues occur check `/var/log/nn-analytics` for logs.
 
-** As root you can run: `service nn-analytics stop` to shutdown or just `kill -9` the process.
+** Run: `sudo service nn-analytics stop` to shutdown or just `kill -9` the process.
 
 ** It is advised that, in production, you hit `http(s)://HOSTNAME:8080/namespace.html` and "Save Namespace" prior shutting down your NNA instance.

docs/Getting_Started/Supported_Hadoop_Versions.md

@@ -8,4 +8,5 @@
 6. 3.0.x (run with -PhadoopVersion=3.0.0)
 
 ** If you are building for 2.5.x you can re-use the 2.4.x build.
-** Check [How To Build](getting_started/How_To_Build.md) for how to set these versions in your build.
+
+** Check [How To Build](How_To_Build/) for how to set these versions in your build.

docs/Getting_Started/Supported_Operating_Systems.md

@@ -0,0 +1,10 @@
+**Supported Operating Systems:**
+
+For running / production we recommend the following flavors of Linux:
+
+1. CentOS
+2. RedHat
+3. Ubuntu
+4. Debian
+
+** For development / testing we also support Mac OSX.

docs/index.md

@@ -1,22 +1,29 @@
-# <img src="images/NNA-logo.png" width="174" height="120" />
+NameNodeAnalytics
+=================
 
 "A Standby read-only HDFS NameNode, with no RPC server, that services clients over a REST API, utilizes Java 8 Stream API, all for the purpose of performing large and complicated scans of the entire file system metadata for end users."
 
+<img src="images/NNA-logo.png" width="174" height="120" />
+
 Contents
 =================
 
-  * [Supported Hadoop Versions](Getting_Started/Supported_Hadoop_Versions.md)
-  * [How To Test](Getting_Started/How_To_Test.md)
   * [How To Build](Getting_Started/How_To_Build.md)
-  * [How To Install](Getting_Started/How_To_Install.md)
   * [How To Configure](Getting_Started/How_To_Configure.md)
-  * [How To Run](Getting_Started/How_To_Run.md)
+  * [How To Install](Getting_Started/How_To_Install.md)
   * [How To Query](Getting_Started/How_To_Query.md)
-    * [Sets](Query_Parameters/1_Sets.md)
-    * [Filters](Query_Parameters/2_Filters.md)
-    * [FilterOps](Query_Parameters/3_FilterOps.md)
-    * [Sums](Query_Parameters/4_Sums.md)
-    * [Histograms](Query_Parameters/5_Histograms.md)
+  * [How To Run](Getting_Started/How_To_Run.md)
+  * [How To Test](Getting_Started/How_To_Test.md)
+  * [Supported Hadoop Versions](Getting_Started/Supported_Hadoop_Versions.md)
+  * [Supported Operating Systems](Getting_Started/Supported_Operating_Systems.md)
+
+**Query Parameters:**
+
+  1. [Sets](Query_Parameters/1_Sets.md)
+  2. [Filters](Query_Parameters/2_Filters.md)
+  3. [FilterOps](Query_Parameters/3_FilterOps.md)
+  4. [Sums](Query_Parameters/4_Sums.md)
+  5. [Histograms](Query_Parameters/5_Histograms.md)
 
 External
 =================