Updated file names

vmware-tanzu · Nov 28, 2017 · ab3762b · ab3762b
1 parent 4178f06
commit ab3762b
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,17 @@
-# Kubeapps
+# <img src="./img/logo.png" width="40" align="left"> Kubeapps
 
 [![Build Status](https://travis-ci.org/kubeapps/kubeapps.svg?branch=master)](https://travis-ci.org/kubeapps/kubeapps)
 
-<img src="./img/logo.png" width="100">
-
 Kubeapps is a set of tools written by [Bitnami](https://bitnami.com) to super-charge your Kubernetes cluster with:
  * Your own application [dashboard](https://kubeapps.com/), allowing you to deploy Kubernetes-ready applications into your cluster with a single click.
  * [Kubeless](http://kubeless.io/), a Kubernetes-native Serverless Framework, compatible with [serverless.com](https://serverless.com).
- * [SealedSecrets](https://github.com/bitnami/sealed-secrets), a way to encrypt a Secret into a SealedSecret, which is safe to store...even for a public repository. 
-
-These tools are easily deployed into your cluster with just one command: ```kubeapps up``` 
+ * [SealedSecrets](https://github.com/bitnami/sealed-secrets), a way to encrypt a Secret into a SealedSecret, which is safe to store...even for a public repository.
 
 ## Quickstart
 
-Kubeapps assumes a working Kubernetes (v1.7+) with RBAC enabled and [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) installed and configured to talk to your Kubernetes cluster. Kubeapps binaries are available for both Linux and Darwin, and Kubeapps has been tested with both `minikube` and Google Kubernetes Engine (GKE).
+Kubeapps assumes a working Kubernetes (v1.7+) with RBAC enabled and [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/) installed and configured to talk to your Kubernetes cluster. Kubeapps binaries are available for both Linux and OS X, and Kubeapps has been tested with both `minikube` and Google Kubernetes Engine (GKE).
+
+> On GKE, you must either be an "Owner" or have the "Container Engine Admin" role in order to install Kubeapps.
 
 The simplest way to try Kubeapps is to deploy it with the Kubeapps Installer on [minikube](https://github.com/kubernetes/minikube). For example, to install the latest binary on Linux, use these commands:
 
@@ -30,13 +28,17 @@ These commands will install Kubeapps for your cluster and launch a browser with
 
 [image]
 
-You can use the Kubeapps Dashboard to easily manage the deployments created by Helm in your cluster and to manage your Kubeless functions. Learn more about [using the Kubeapps Dashboard]().
+## Next Steps
+
+Use the Kubeapps Dashboard to easily manage the deployments created by Helm in your cluster and to manage your Kubeless functions. Learn more about [using the Kubeapps Dashboard](docs/dashboard.md).
+
+In case of difficulties installing Kubeapps, find [more detailed installation instructions](docs/install.md) or [learn how to build Kubeapps from source](docs/install.md).
 
-For a more detailed introduction to Kubeapps, read our [introductory walkthrough](docs/get-started.md). You can also read [more detailed installation instructions](docs/install.md) or [learn how to build Kubeapps from source](docs/install.md).
+For a more detailed and step-by-step introduction to Kubeapps, read our [introductory walkthrough](docs/get-started.md).
 
-## Resources
+## Useful Resources
 
-- [Walkthrough for new users](docs/get-started.md)
-- [Source and binary installation](docs/install.md)
-- [Kubeapps components](docs/components.md)
-- [Kubeapps Dashboard](docs/dashboard.md)
+* [Walkthrough for new users](docs/get-started.md)
+* [Detailed installation instructions](docs/install.md)
+* [Kubeapps Dashboard documentation](docs/dashboard.md)
+* [Kubeapps components](docs/components.md)
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/getting-started.md → docs/get-started.md b/docs/getting-started.md → docs/get-started.md
diff --git a/docs/install.md b/docs/install.md
@@ -2,16 +2,16 @@
 
 Kubeapps assumes a working Kubernetes (v1.7+) with RBAC enabled and [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) installed and configured to talk to your Kubernetes cluster.
 
-Kubeapps has been tested with both `minikube` and Google Kubernetes Engine (GKE). 
+Kubeapps has been tested with both `minikube` and Google Kubernetes Engine (GKE).
 
 > On GKE, you must either be an "Owner" or have the "Container Engine Admin" role in order to install Kubeapps.
 
 ## Install pre-built binary
 
-* Download a binary version of the latest Kubeapps Installer for your platform from the [release page](https://github.com/kubeapps/kubeapps/releases). Currently, the Kubeapps Installer is distributed in binary form for two platforms: Linux amd64 and OS X amd64.
+* Download a binary version of the latest Kubeapps Installer for your platform from the [release page](https://github.com/kubeapps/kubeapps/releases). Currently, the Kubeapps Installer is distributed in binary form for Linux (64-bit) and OS X (64-bit).
 * Make the binary executable.
 
-For example, to install 0.0.2 release on Linux, use this command:
+For example, to install the 0.0.2 binary release on Linux, use this command:
 
 ```
 sudo curl -L https://github.com/kubeapps/installer/releases/download/v0.0.2/kubeapps-linux-amd64 -o /usr/local/bin/kubeapps && sudo chmod +x /usr/local/bin/kubeapps
@@ -20,39 +20,61 @@ sudo curl -L https://github.com/kubeapps/installer/releases/download/v0.0.2/kube
 ## Build binary from source
 
 The Kubeapps Installer is a CLI tool written in Go that will deploy the Kubeapps components into your cluster.
-You can build the latest Kubeapps Installer from source by following the steps below: 
+You can build the latest Kubeapps Installer from source by following the steps below:
 
-* Visit [the Go website](https://golang.org), download the most recent [binary distribution of Go](https://golang.org/dl/) and install it following the [official instructions](https://golang.org/doc/install). 
+* Visit [the Go website](https://golang.org), download the most recent [binary distribution of Go](https://golang.org/dl/) and install it following the [official instructions](https://golang.org/doc/install).
 
-  The remainder of this section assumes that Go is installed in `/usr/local/go`. Update the paths in subsequent commands if you used a different location.
+  > The remainder of this section assumes that Go is installed in `/usr/local/go`. Update the paths in subsequent commands if you used a different location.
 
 * Set the Go environment variables:
 
-```
-export GOROOT=/usr/local/go
-export GOPATH=/usr/local/go
-export PATH=$GOPATH/bin:$PATH
-```
+  ```
+  export GOROOT=/usr/local/go
+  export GOPATH=/usr/local/go
+  export PATH=$GOPATH/bin:$PATH
+  ```
 
 * Create a working directory for the project:
 
-```
-working_dir=$GOPATH/src/github.com/kubeapps/
-mkdir -p $working_dir
-```
+  ```
+  working_dir=$GOPATH/src/github.com/kubeapps/
+  mkdir -p $working_dir
+  ```
 
 * Clone the Kubeapps source repository:
 
+  ```
+  cd $working_dir
+  git clone https://github.com/kubeapps/kubeapps
+  ```
+
+* Build the Kubeapps binary and move it to a location in your path:
+
+  ```
+  cd kubeapps
+  make binary
+  cp kubeapps /usr/local
+  ```
+
+# Next Steps
+
+Confirm that [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/) is installed and verify the Kubernetes version:
+
 ```
-cd $working_dir
-git clone https://github.com/kubeapps/kubeapps
+kubectl version
+Client Version: version.Info{Major:"1", Minor:"7", GitVersion:"v1.7.0", GitCommit:"d3ada0119e776222f11ec7945e6d860061339aad", GitTreeState:"clean", BuildDate:"2017-06-29T23:15:59Z", GoVersion:"go1.8.3", Compiler:"gc", Platform:"darwin/amd64"}
+Server Version: version.Info{Major:"1", Minor:"8", GitVersion:"v1.8.0", GitCommit:"0b9efaeb34a2fc51ff8e4d34ad9bc6375459c4a4", GitTreeState:"dirty", BuildDate:"2017-10-17T15:09:55Z", GoVersion:"go1.8.3", Compiler:"gc", Platform:"linux/amd64"}
 ```
 
-* Build the Kubeapps binary and move it to a location in your path:
+Use the Kubeapps Installer to deploy Kubeapps and launch a browser with the Kubeapps dashboard.
 
 ```
-cd kubeapps
-make binary
-cp kubeapps /usr/local
+kubeapps up
+kubeapps dashboard
 ```
 
+# Useful Resources
+
+* [Walkthrough for new users](get-started.md)
+* [Kubeapps Dashboard documentation](dashboard.md)
+* [Kubeapps components](components.md)