From ec6f20a979f57d70014a397eb8ed1d234a22651a Mon Sep 17 00:00:00 2001 From: antoniaklja Date: Thu, 10 Jan 2019 22:08:42 +0100 Subject: [PATCH] Update docs, add assets directory --- README.md | 10 +++++----- .../jenkins-credentials.png | Bin .../jenkins-operator-draft.png | Bin jenkins-seed.png => assets/jenkins-seed.png | Bin jenkins.png => assets/jenkins.png | Bin phases.png => assets/phases.png | Bin reconcile.png => assets/reconcile.png | Bin config.env | 2 +- {doc => docs}/developer-guide.md | 0 {doc => docs}/getting-started.md | 6 +++--- {doc => docs}/how-it-works.md | 4 ++-- {doc => docs}/installation.md | 0 {doc => docs}/security.md | 0 13 files changed, 11 insertions(+), 11 deletions(-) rename jenkins-credentials.png => assets/jenkins-credentials.png (100%) rename jenkins-operator-draft.png => assets/jenkins-operator-draft.png (100%) rename jenkins-seed.png => assets/jenkins-seed.png (100%) rename jenkins.png => assets/jenkins.png (100%) rename phases.png => assets/phases.png (100%) rename reconcile.png => assets/reconcile.png (100%) rename {doc => docs}/developer-guide.md (100%) rename {doc => docs}/getting-started.md (98%) rename {doc => docs}/how-it-works.md (97%) rename {doc => docs}/installation.md (100%) rename {doc => docs}/security.md (100%) diff --git a/README.md b/README.md index d760c51d..d96ad8d4 100644 --- a/README.md +++ b/README.md @@ -54,8 +54,8 @@ User configuration: * trigger backup job before pod deletion using preStop k8s hooks * verify Jenkins configuration events -[installation]:doc/installation.md -[getting_started]:doc/getting-started.md -[how_it_works]:doc/how-it-works.md -[security]:doc/security.md -[developer_guide]:doc/developer-guide.md +[installation]:docs/installation.md +[getting_started]:docs/getting-started.md +[how_it_works]:docs/how-it-works.md +[security]:docs/security.md +[developer_guide]:docs/developer-guide.md diff --git a/jenkins-credentials.png b/assets/jenkins-credentials.png similarity index 100% rename from jenkins-credentials.png rename to assets/jenkins-credentials.png diff --git a/jenkins-operator-draft.png b/assets/jenkins-operator-draft.png similarity index 100% rename from jenkins-operator-draft.png rename to assets/jenkins-operator-draft.png diff --git a/jenkins-seed.png b/assets/jenkins-seed.png similarity index 100% rename from jenkins-seed.png rename to assets/jenkins-seed.png diff --git a/jenkins.png b/assets/jenkins.png similarity index 100% rename from jenkins.png rename to assets/jenkins.png diff --git a/phases.png b/assets/phases.png similarity index 100% rename from phases.png rename to assets/phases.png diff --git a/reconcile.png b/assets/reconcile.png similarity index 100% rename from reconcile.png rename to assets/reconcile.png diff --git a/config.env b/config.env index 662afa17..fb12662d 100644 --- a/config.env +++ b/config.env @@ -1,7 +1,7 @@ # Setup variables for the Makefile NAME=jenkins-operator PKG=github.com/VirtusLab/jenkins-operator -DOCKER_REGISTRY= +DOCKER_REGISTRY=virtuslab/jenkins-operator REPO=jenkins-operator NAMESPACE=default API_VERSION=jenkins:v1alpha1 diff --git a/doc/developer-guide.md b/docs/developer-guide.md similarity index 100% rename from doc/developer-guide.md rename to docs/developer-guide.md diff --git a/doc/getting-started.md b/docs/getting-started.md similarity index 98% rename from doc/getting-started.md rename to docs/getting-started.md index b89aebc6..1a0a6216 100644 --- a/doc/getting-started.md +++ b/docs/getting-started.md @@ -62,7 +62,7 @@ kubectl jenkins-operator-example 8080:8080 ``` -![jenkins](../jenkins.png) +![jenkins](../assets/jenkins.png) ## Configure Seed Jobs and Pipelines @@ -204,11 +204,11 @@ data: You can verify if deploy keys were successfully configured in Jenkins **Credentials** tab. -![jenkins](../jenkins-credentials.png) +![jenkins](../assets/jenkins-credentials.png) You can verify if your pipelines were successfully configured in Jenkins Seed Job console output. -![jenkins](../jenkins-seed.png) +![jenkins](../assets/jenkins-seed.png) ## Jenkins Customisation diff --git a/doc/how-it-works.md b/docs/how-it-works.md similarity index 97% rename from doc/how-it-works.md rename to docs/how-it-works.md index 401e7590..71f44e53 100644 --- a/doc/how-it-works.md +++ b/docs/how-it-works.md @@ -13,7 +13,7 @@ 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 -![reconcile](../reconcile.png) +![reconcile](../assets/reconcile.png) **Base** reconciliation loop takes care of reconciling base Jenkins configuration, which consists of: - Ensure Manifests - monitors any changes in manifests @@ -27,7 +27,7 @@ The **jenkins-operator** design incorporates the following concepts: - Ensure User Configuration - executed user provided configuration, like groovy scripts, configuration as code or plugins - Ensure Backup Job - creates Backup job and ensures that backup has been successfully performed -![reconcile](../phases.png) +![reconcile](../assets/phases.png) ## Operator State diff --git a/doc/installation.md b/docs/installation.md similarity index 100% rename from doc/installation.md rename to docs/installation.md diff --git a/doc/security.md b/docs/security.md similarity index 100% rename from doc/security.md rename to docs/security.md