Add and Update Docs (Azure-Samples#77)

* Initial readme and FAQ

* Update leaderboard readme

* Add tiller timeout FAQ

FAQ.md

@@ -0,0 +1,24 @@
+# Frequently Asked Questions
+
+Find information for common problems or questions.
+
+## Troubleshooting
+
+## Common Questions / Problems
+
+1. The deploy ingress dns script errors out with this message:
+
+    ```bash
+    5-Deploy ingress  (bash ./deploy_ingress_dns.sh -s ./test_fetch_build -l westus2 -n teamdcaro04)
+    Upgrading tiller (helm server) to match client version.
+    $HELM_HOME has been configured at /home/azureuser/.helm.
+    Error: tiller was not found. polling deadline exceeded
+    ```
+
+    There are a number of steps in this script to try and ensure tiller is available, but sometime it still times out.  Please refer to Common Resolution #1 for the solution.
+
+## Common Resolution
+
+1. Delete & Recreate environment
+
+    Instead of manually hacking the setup script and trying to re-run the steps, sometimes it is easier to simply delete the resource groups where the failure occurred and recreate the resources via the setup script using the same team number since it is fully automated.

README.md

@@ -1,57 +1,34 @@
-# Project Name
+# DevOps Openhack Proctor Repository
 
-(short, 1-3 sentenced, description of the project)
+This repo contains the code for a proctor to automatically provision the team and proctor environments necessary to execute a DevOps openhack event.  The relevant code individual teams use (i.e. the APIs) to complete their challenges can be found in the [DevOps Openhack Team repository](https://github.com/Azure-Samples/openhack-devops-team/).
 
-## Features
+## Components
 
-This project framework provides the following features:
+The components are organized by folders which contain the following:
 
-* Feature 1
-* Feature 2
-* ...
+* **leaderboard** - visualizes the uptime for the teams' APIs and contains an Azure Functions API which connects to CosmosDB, Sentinel (pods to query the APIs and report status), and a web front end.
+* **provision-proctor** - automates the provisioning of a complete proctor environment (1 needed per event).
+* **provision-team** - automates the provisioning of a complete team environment.
+* **provision-vm** - automates the provisioning of an Ubuntu 16.04 VM used as the foundation for provisioning the team and proctor environments.
+* **simulator** - simulates traffic to the SQL database the APIs use for every team's environment.
+
+Go to the root of these folders to see a readme with deeper information on each component.
 
 ## Getting Started
 
 ### Prerequisites
 
-(ideally very short, if any)
-
-- OS
-- Library version
-- ...
-
-### Installation
-
-(ideally very short)
-
-- npm install [package name]
-- mvn install
-- ...
-
-### Quickstart
-(Add steps to get up and running quickly)
+The first step is to create a virtual machine which has the necessary software installed required to provision the teams and proctor environments.  In order to create the VM, only the following needs to be installed
 
-1. git clone [repository clone url]
-2. cd [respository name]
-3. ...
+* Azure PowerShell
+* An Azure Subscription
 
+### High-Level Installation Flow
 
-## Demo
-
-A demo app is included to show how to use the project.
-
-To run the demo, follow these steps:
-
-(Add steps to start up the demo)
-
-1.
-2.
-3.
+1. [Create A Proctor VM](./provision-vm)
+2. [Create Team Environments](./provision-team) from the proctor VM
+3. [Create A Proctor Environment](./provision-proctor) from the proctor VM
 
 ## Resources
 
-(Any additional resources or related projects)
-
-- Link to supporting information
-- Link to similar sample
-- ...
+For troubleshooting or answers to common questions, please [read the FAQ](FAQ.md).

leaderboard/README.md

@@ -1,26 +1,22 @@
-# Open Hack tools - DevOps 
+# Leaderboard 
 
-This repository deploy whole Proctor environments for Open Hack - DevOps
-It includes code for Leaderboard
+The leaderboard's high-level purpose is to calculate and display the downtime for every team's APIs.
 
 ## Project structure
 
-Under the leaderboard subdirectory, you can find these directories.
+Under the leaderboard subdirectory, you can find these directories which correspond to the components required to achieve the leaderboard goal.  Go to the root of these folders to see a readme with deeper information on each component.
 
 ### api
 
-* **Leaderboard**: BackendService of Leaderboard. This is the Azure Functions (v2) Project with Release Binary.
-* **infastructure**: PowerShell/ARM template scripts for deploying Proctor enviornment
+An Azure Functions (v2) API which connects to CosmosDB with the following routes:
 
-### sentinel
-
-* **sentinel**: Sentinel is the tool for watching team endpoints written by go
-* **helm chart**: helm chart which deploys the sentinel
+* `/api/GetTeamsStatus` (GET) - Reports the list of teams and downtime which is used by the web component dashboard.
+* `/api/ReportStatus` (POST) - Where the sentinel posts the downtime report.
 
-### web 
+### sentinel
 
-* **leaderboard**: SPA application for the leaderboard written by Angular 4 with Nebular
+Sentinel is the tool for watching the team health endpoints written in golang.  It contains a helm chart in the `helm` sub-directory.
 
-## Detail
+### web
 
-You can refer the Readme.md on the each directories. 
+SPA application for the leaderboard based written in Angular 6 with Nebular. It has a Dockerfile and helm chart in the `helm` sub-directory.