From 8e05f6e072ad52e90902e3242042e8ae7bcdbe06 Mon Sep 17 00:00:00 2001
From: Rob Scott
Date: Fri, 19 Apr 2019 15:38:13 -0400
Subject: [PATCH] some documentation updates
---
CONTRIBUTING.md | 4 ++--
README.md | 10 ++++++----
2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bf703a95a..a584b7f73 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,8 +19,8 @@ We label issues with the ["good first issue" tag](https://github.com/reactiveops
The following commands are all required to pass as part of Fairwinds testing:
```
-go list ./ | grep -v vendor | xargs golint -set_exit_status
-go list ./ | grep -v vendor | xargs go vet
+go list ./... | grep -v vendor | xargs golint -set_exit_status
+go list ./... | grep -v vendor | xargs go vet
go test ./pkg/... -v -coverprofile cover.out
```
diff --git a/README.md b/README.md
index 88eb297bb..f852eac2a 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,14 @@
-Fairwinds aims to keep your cluster sailing smoothly. It runs a variety of checks to ensure that Kubernetes deployments are configured using best practices that will avoid potential problems in the future. The project includes two primary parts:
+Fairwinds keeps your cluster sailing smoothly. It runs a variety of checks to ensure that Kubernetes deployments are configured using best practices that will avoid potential problems in the future. The project includes two primary parts:
- A dashboard to display the results of these validations on your existing deployments
- A beta version of a webhook that can prevent poorly configured deployments from reaching your cluster
## Dashboard
-The Fairwinds Dashboard provides an overview of your current deployments in a cluster along with their validation scores. An overall score is provided for a cluster on a 0 - 100 scale. Results for each validation are grouped by namespace and deployment.
+The Fairwinds Dashboard provides an overview of your current deployments in a cluster along with their validation scores. An overall score is provided for a cluster on a 0 - 100 scale. Results are then broken down by namespace and deployment.
@@ -33,11 +33,13 @@ helm upgrade --install fairwinds deploy/helm/fairwinds/ --namespace fairwinds
### Viewing the Dashboard
Once the dashboard is deployed, it can be viewed by using kubectl port-forward:
+
```
-kubectl port-forward --namespace fairwinds svc/fairwinds-fairwinds-dashboard 8080:80 &
-open http://localhost:8080
+kubectl port-forward --namespace fairwinds svc/fairwinds-fairwinds-dashboard 8080:80
```
+With the port forwarding in place, you can open http://localhost:8080 in your browser to view the dashboard.
+
### Using a Binary Release
If you'd prefer to run Fairwinds locally, binary releases are available on the [releases page](https://github.com/reactiveops/fairwinds/releases). When running as a binary, Fairwinds will use your local kubeconfig to connect to a cluster. There are a variety of options available, but the most common usage may be to view the dashboard: