Documentation Cleanups

README.md

@@ -1,14 +1,12 @@
 # Panoptes
-> A Global-Scale, Network Telemetry Ecosystem
+> A Global-Scale Network Telemetry Ecosystem
 
 ## Table of Contents
 
-- [Introduction](#introduction)
-- [Install](#install)
-- [Configuration](#configuration)
-- [Usage](#usage)
-- [Contribute](#contribute)
-- [License](#license)
+- [Introduction](#Introduction)
+- [Install](#Install)
+- [Contribute](#Contribute)
+- [License](#License)
 
 ## Introduction
 
@@ -21,11 +19,11 @@ Panoptes is a Python based network telemetry ecosystem that implements discovery
 
 ## Install
 
-Please follow the instructions [here](docs/Installation.md) to download and install Panoptes
+Please follow the instructions [here](https://github.com/yahoo/panoptes/blob/master/docs/Installation.md) to download and install Panoptes
 
 ## Contribute
 
-We welcome issues, questions, and pull requests.
+We welcome issues, questions, and pull requests. Please read the [contributing guidelines](https://github.com/yahoo/panoptes/blob/master/docs/Contributing.md)
 
 ## Maintainers
 * Varun Varma: vvarun@oath.com
@@ -34,4 +32,4 @@ We welcome issues, questions, and pull requests.
 * James Diss: rexfury@oath.com
 
 ## License
-This project is licensed under the terms of the [Apache 2.0](LICENSE-Apache-2.0) open source license. Please refer to [LICENSE](LICENSE) for the full terms.
+This project is licensed under the terms of the Apache 2.0 open source license. Please refer to [LICENSE](https://github.com/yahoo/panoptes/blob/master/LICENSE) for the full terms.

Contributing.md → docs/Contributing.md

@@ -21,6 +21,6 @@ Pull requests are welcome for bug fixes. If you want to implement something new,
 #### Creating a Pull Request
 Before you submit any code, we need you to agree to our [Contributor License Agreement](https://yahoocla.herokuapp.com/); this ensures we can continue to protect your contributions under an open source license well into the future.
 
-Please follow [best practices](https://github.com/trein/dev-best-practices/wiki/Git-Commit-Best-Practices) for creating git commits.
+Please follow [best practices](https://github.com/trein/dev-best-practices/wiki/Git-Commit-Best-Practices) for creating git commits. We use the [Github flow](https://guides.github.com/introduction/flow/) workflow for our PRs.
 
 When your code is ready to be submitted, you can [submit a pull request](https://help.github.com/articles/creating-a-pull-request/) to begin the code review process.

docs/Installation.md

@@ -1,3 +1,10 @@
+## Table of Contents
+
+- [Pre-requisites](#Pre-requisites)
+- [Installation](#Installation)
+- [Configuration](#Configuration)
+- [Usage](#Usage)
+
 ### Pre-requisites
 
 #### System Requirements
@@ -38,7 +45,7 @@ Panoptes has been tested with Kafka version 0.10.2.0 - get it [here](https://kaf
 
 Please follow [these instructions](https://portal.influxdata.com/downloads) to download and install InfluxDB
 
-##### Grafana
+###### Grafana
 
 You can get Grafana from [here](https://grafana.com/get) 
 
@@ -57,14 +64,14 @@ source ~/package/bin/activate
 pip install yahoo_panoptes
 ```
 
-## Configuration
+### Configuration
 Panoptes is configured with ini style configuration files
 
 `/home/panoptes/conf/panoptes.ini` is the main configuration file; and you can find an examples of config files under `examples`
 
 For a quick start, you can copy all config files under `examples` to `/home/panoptes`
 
-## Usage
+### Usage
 
 After adjusting the config files to your environment, start the following services. Note that these services run in the foreground and should be run under a job control system like supervisord or daemontools for production usage.
 
@@ -115,7 +122,7 @@ mkdir -p /home/panoptes/log/polling/agent
 celery worker -A yahoo_panoptes.polling.polling_plugin_agent -l info -f /home/panoptes/log/polling/agent/polling_plugin_agent_celery_worker_001.log -Q polling_plugin_agent -n polling_plugin_agent_001.%h -Ofair --max-tasks-per-child 10
 ```
 
-### InfluxDB
+### InfluxDB Consumer
 ```bash
 mkdir -p /home/panoptes/log/polling/agent
 ./package/bin/panoptes_influxdb_consumer