Merge pull request #156 from ContainerSolutions/user-guide

User guide

Author: csviri

README.md

@@ -24,6 +24,11 @@ Feature we would like to implement and invite the community to help us implement
 * Configurable Retry Handling
 * Smart Event Processing Scheduling
 
+## User Guide
+
+You can find detailed documentation [here](docs/DOCS.md). 
+Note that these docs are currently in progress. 
+
 ## Usage
 
 We have several sample Operators under the samples directory:

docs/DOCS.md

@@ -0,0 +1,43 @@
+# Java Operator SDK - Documentation
+
+## Introduction & Resources on Operators
+
+Operators are easy and simple way to manage resource on Kubernetes clusters but
+also outside of the cluster. The goal of this SDK is to allow writing operators in Java by
+providing a nice API and handling common issues regarding the operators on framework level.
+   
+For an introduction, what is an operator see this [blog post](https://blog.container-solutions.com/kubernetes-operators-explained).
+
+You can read about the common problems what is this operator framework is solving for you [here](https://blog.container-solutions.com/a-deep-dive-into-the-java-operator-sdk).
+
+## Getting Started
+
+The easiest way to get started with SDK is start [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) and 
+execute one of our [examples](https://github.com/ContainerSolutions/java-operator-sdk/tree/master/samples/webserver)
+
+Note that you don't have to deploy the operator to a Kubernetes clusters as a pod (however you have to apply the CRD).
+If you run this example from you favorite IDE, it will pick up the kubeconfig (prepared by minikube) and will start
+processing events of custom resources immediately. 
+
+
+## Controllers
+Controllers are where you implement you logic for you operator.
+
+### Generation Awareness
+
+## Automatic Retries
+
+## Running The Operator
+
+## Development Tips & Tricks
+
+TODO: explain running operator locally against a cluster
+
+## Event Processing Details
+### Handling Finalizers
+### Managing Consistency
+### Event Scheduling
+### Event Dispatching 
+### Generation Awareness
+
+## Spring Boot Support