Update docs

README.md

@@ -1,4 +1,4 @@
-# jenkins-operator
+# Jenkins Operator
 
 Kubernetes native Jenkins operator which manages Jenkins on Kubernetes.
 It was built with immutability and declarative configuration as code in mind.
@@ -10,7 +10,7 @@ It provides out of the box:
 - secure and hardened Jenkins instance
 - basic authentication with username and password
 
-The main reason why we decided to write the Jenkins operator is the fact that we faced a lot of problems with standard Jenkins deployment.
+The main reason why we decided to write the **jenkins-operator** is the fact that we faced a lot of problems with standard Jenkins deployment.
 Also, we heavily use Jenkins on large production Kubernetes clusters in a multi-tenant environment.
 
 Some of the problems we want to solve:
@@ -20,7 +20,7 @@ Some of the problems we want to solve:
 - lack of end to end tests
 - make Jenkins more suitable for dynamic environment and handle graceful shutdown properly
 - security and hardening out of the box
-- job stuck and jnlp connection is lost
+- orphaned jobs with no jnlp connection
 - make errors more visible for end users
 
 ## Documentation

doc/developer-guide.md

@@ -22,13 +22,13 @@ make go-dependecies
 
 ## Build and run
 
-Build and run `jenkins-operator` locally:
+Build and run **jenkins-operator**` locally:
 
 ```bash
 make build && make docker-build && make minikube-run EXTRA_ARGS='--minikube --local'
 ```
 
-Once `minikube` and `jenkins-operator` are up and running, apply Jenkins custom resource:
+Once minikube and **jenkins-operator** are up and running, apply Jenkins custom resource:
 
 ```bash
 kubectl apply -f jenkins-operator/deploy/crds/virtuslab_v1alpha1_jenkins_cr.yaml
@@ -44,7 +44,7 @@ Run unit tests:
 make test
 ```
 
-Run e2e tests with `minikube`:
+Run e2e tests with minikube:
 
 ```bash
 make minikube-run

doc/getting-started.md

@@ -1,6 +1,6 @@
 # Getting Started
 
-This document describes a getting started guide for Jenkins operator and an additional configuration.
+This document describes a getting started guide for **jenkins-operator** and an additional configuration.
 
 1. [First Steps](#first-steps)
 2. [Deploy Jenkins](#deploy-jenkins)
@@ -13,7 +13,7 @@ This document describes a getting started guide for Jenkins operator and an addi
 ## First Steps
 
 Prepare your Kubernetes cluster and set up access.
-Once you have running Kubernetes cluster you can focus on installing Jenkins operator according to the [Installation](installation.md) guide.
+Once you have running Kubernetes cluster you can focus on installing **jenkins-operator** according to the [Installation](installation.md) guide.
 
 ## Deploy Jenkins
 

doc/how-it-works.md

@@ -1,6 +1,6 @@
 # How it works
 
-This document describes a high level overview how jenkins-operator works. 
+This document describes a high level overview how **jenkins-operator** works. 
 
 1. [Architecture and design](#architecture-and-design)
 2. [Operator State](#operator-state)
@@ -8,7 +8,7 @@ This document describes a high level overview how jenkins-operator works.
 
 ## Architecture and design
 
-The Jenkins operator design incorporates the following concepts:
+The **jenkins-operator** design incorporates the following concepts:
 - watches any changes of manifests and maintain desired state according to deployed custom resource manifest
 - implements a main reconciliation loop which consists of two smaller reconciliation loops - base and user 
 

doc/installation.md

@@ -4,10 +4,9 @@ This document describes installation procedure for jenkins-operator.
 
 ## Requirements
  
-To run jenkins-operator, you will need:
+To run Jenkins Operator, you will need:
 - running Kubernetes cluster
 - kubectl
-- optionally Kubernetes namespace for jenkins-operator
 
 ## Configure Custom Resource Definition