First take on documentation

Author: arapulido

README.md

@@ -1,22 +1,29 @@
+# Kubeapps
+
 [![Build Status](https://travis-ci.org/kubeapps/kubeapps.svg?branch=master)](https://travis-ci.org/kubeapps/kubeapps)
 
-# Kubeapps Installer
+<img src="https://github.com/kubeapps/kubeapps/raw/master/img/logo.png" width="100">
 
-Kubeapps Installer is a [Bitnami](https://bitnami.com) tool to super-charge your Kubernetes cluster with:
- * Your own app [dashboard](https://kubeapps.com/), allowing you to deploy Kubernetes-ready apps into your cluster with a single click.
+Kubeapps is a set of tools written by [Bitnami](https://bitnami.com) to super-charge your Kubernetes cluster with:
+ * Your own applications [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 SealedSecret can be decrypted only by the controller running in the cluster and nobody else (not even the original author).
 
-## Installation
+These tools are easily deployed into your cluster with just one command: ```kubeapps up``` 
+
+----
+
+## Getting started
 
-Installation is made of two steps:
+To get started, read our [Getting Started guide](https://github.com/kubeapps/kubeapps/blob/docs/getting-started.md).
 
-- Download latest Kubeapps Installer binary from the [release page](https://github.com/kubeapps/kubeapps/releases). Currently Kubeapps Installer is distributed in two platforms: linux/amd64 and OSX/amd64
-- Make the binary executable
+You can also browse the [full documentation](https://github.com/kubeapps/kubeapps/blob/docs).
 
-## Build from source
+----
+## Build the Kubeapps installer from source
 
-You can build latest Kubeapps Installer from source. 
+The Kubeapps Installer is a CLI tool written in Go that will deploy all the Kubeapps components into your cluster.
+You can build the latest Kubeapps Installer from source. 
 
 ### Installing Go
 - Visit https://golang.org/dl/
@@ -25,27 +32,30 @@ You can build latest Kubeapps Installer from source.
 - Set the Go environment variables
 
 ```
-$ export GOROOT=/GoDir/go
-$ export GOPATH=/GoDir/go
-$ export PATH=$GOPATH/bin:$PATH
+export GOROOT=/GoDir/go
+export GOPATH=/GoDir/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 kubeapps/kubeapps repository
+
 ```
-$ cd $working_dir
-$ git clone https://github.com/kubeapps/kubeapps
+cd $working_dir
+git clone https://github.com/kubeapps/kubeapps
 ```
 
 ### Building local binary
+
 ```
-$ cd kubeapps
-$ make binary
+cd kubeapps
+make binary
 ```
 
 ## Testing Kubeapps Installer with minikube
@@ -55,25 +65,25 @@ The simplest way to try Kubeapps is deploying it with Kubeapps Installer on [min
 Kubeapps Installer is now working with RBAC-enabled Kubernetes (v1.7+). You can choose to start minikube vm with your preferred VM driver (virtualbox xhyve vmwarefusion) and a proper Kubernetes version. For example, the [latest minikube](https://github.com/kubernetes/minikube/releases/tag/v0.23.0) will start a Kubernetes v1.8.0.
 
 ```
-$ minikube start
+minikube start
 ```
 
 It's also required to have [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) installed on your machine. Verify Kubernetes version:
 
 ```
-$ kubectl version
+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"}
 ```
 
 Deploy Kubeapps with Kubeapps Installer
 
 ```
-$ kubeapps up
+kubeapps up
 ```
 
 Remove Kubeapps
 
 ```
-$ kubeapps down
+kubeapps down
 ```

docs/components.md

@@ -0,0 +1,18 @@
+# Components
+
+## Helm / Tiller
+
+Kubeapps installs Tiller ([Helm](https://helm.sh/) in-cluster component) which will allow you to easily installed Kubernetes ready applications packaged as charts.
+
+## Kubeless
+
+[Kubeless](http://kubeless.io/) is a Kubernetes-native serverless framework. It runs on top of your Kubernetes cluster and allows you to deploy small unit of code without having to build container images. With Kubeless you can build advanced applications that tie together services using functions.
+
+## Kubeapps Dashboard
+
+Kubeapps comes with an in-cluster web dashboard that allows you to easily deploy applications and functions packaged as charts and to create, edit and run Kubeless functions.
+Check the [main documentation for the Kubeapps Dashboard](dashboard.md).
+
+## Sealed Secrets
+
+[Sealed Secrets](https://github.com/bitnami/sealed-secrets) are a "one-way" encrypted Secret that can be created by anyone, but can only be decrypted by the controller running in the target cluster. The Sealed Secret is safe to share publicly, upload to git repositories, post to twitter, etc. Once the SealedSecret is safely uploaded to the target Kubernetes cluster, the sealed secrets controller will decrypt it and recover the original Secret.

docs/dashboard.md

@@ -0,0 +1,47 @@
+# Kubeapps Dashboard
+
+Kubeapps comes with an in-cluster dashboard that offers a web UI to easily manage the deployments created by Helm in your cluster and to manage your Kubeless functions.
+
+## Start the Dashboard
+
+You can easily safely access the dashboard from your system by running:
+
+```
+kubeapps dashboard
+```
+
+This will run a HTTP proxy to access the dashboard safely and will open your default browser to it.
+
+## Deploying new applications using the Dashboard
+
+Once you have the Dashboard up and running, you can start deploying applications into your cluster.
+
+<img src="https://github.com/kubeapps/kubeapps/raw/master/img/dashboard.png" width="100">
+
+Select one application for the list of charts in the official Kubernetes chart repository. In this example we will be deploying MariaDB.
+
+<img src="https://github.com/kubeapps/kubeapps/raw/master/img/mariadb.png" width="100">
+
+Once you click on "Install mariadb" you will be able to select which namespace of your cluster you want this to be deployed:
+
+<img src="https://github.com/kubeapps/kubeapps/raw/master/img/namespace.png" width="100">
+
+Now click on "Deploy" and you will be able to track your new Kubernetes Deployment directly from your browser.
+
+<img src="https://github.com/kubeapps/kubeapps/raw/master/img/mariadb-deploy.png" width="100">
+
+## Listing all the deployments managed by Helm
+
+On the "Deployments" menu you can get a list of the deployments in your cluster that are managed by Helm.
+
+<img src="https://github.com/kubeapps/kubeapps/raw/master/img/deployments.png" width="100">
+
+## Removing existing deployments
+
+You can remove any of the deployments that are managed by Helm, by clicking on the Remove button:
+
+<img src="https://github.com/kubeapps/kubeapps/raw/master/img/delete-mariadb.png" width="100">
+
+## Functions Dashboard
+
+TBD

docs/getting-started.md

@@ -0,0 +1,48 @@
+# Getting Started
+
+Kubeapps is a set of tools written by [Bitnami](https://bitnami.com) to super-charge your Kubernetes cluster with:
+ * Your own applications [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 SealedSecret can be decrypted only by the controller running in the cluster and nobody else (not even the original author).
+
+These tools are easily deployed into your cluster with just one command: ```kubeapps up``` 
+
+## Installation of the Kubeapps Installer
+
+Kubeapps assumes a working Kubernetes (v1.7+) with RBAC enabled and [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) installed in your machine and configured to talk to your Kubernetes cluster. Kubeapps has been tested in `minikube` and Google Kubernetes Engine.
+
+- Download latest Kubeapps Installer binary from the [release page](https://github.com/kubeapps/kubeapps/releases). Currently Kubeapps Installer is distributed in two platforms: linux/amd64 and OSX/amd64
+- Make the binary executable
+
+## Deploy the Kubeapps components into your cluster
+
+```
+kubeapps up
+```
+
+This command will deploy the Kubeapps components into your cluster. The deployments may take few minutes until they are ready.
+
+## What is it that I am actually deploying?
+
+You can check the [latest version of the Kubernetes manifest](https://github.com/kubeapps/kubeapps/blob/master/static/kubeapps-objs.yaml) that Kubeapps will deploy for you.
+
+Check the [components documentation page](/components.md) for a brief description of the list of components Kubeapps is deploying into your cluster.
+
+## Kubeapps Dashboard
+
+Kubeapps provides an in-cluster toolset for simplified deployment of over 100 Kubernetes ready applications as Helm charts and Kubeless functions.
+
+To open the Kubeapps Dashboard:
+
+```
+kubeapps dashboard
+```
+Check the [documentation specific to the Dashboard](/dashboard.md)
+
+## Clean the Kubeapps components
+
+You can easily clean all the Kubeapps deployment with a single command:
+
+```
+kubeapps down
+```