Chore: Upgrade Jenkins-job-builder to 6.3.0

[releng/global-jjb.git] / README.md

diff --git a/README.md b/README.md
index ce7d420..003d7ce 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,66 +1,47 @@
 # Global JJB
 
-The purpose of this repository is store generically define reusable JJB
-templates that can be deployed across LF projects.
+Global-JJB is a library project containing reusable Jenkins Job Builder
+templates. Developed for LFCI to deploy management Jenkins jobs to an LF
+managed Jenkins instance, there are other jobs defined which may be helpful
+to projects that use the same build technology. The intention is to help
+projects save time from having to define their own job templates.
 
-The following variables are necessary to be defined in the Jenkins server as
-global environment variables as scripts in this repo expect these variables to
-be available.
+## Guides
 
-For example:
+### [Install](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/)
 
-```
-GIT_URL=ssh://jenkins-$SILO@git.opendaylight.org:29418
-JENKINS_HOSTNAME=jenkins092
-LOGS_SERVER=https://logs.opendaylight.org
-NEXUS_URL=https://nexus.opendaylight.org
-SILO=releng
-```
+-   [Jenkins configuration](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#jenkins-configuration)
 
-## Jenkins Plugin Requirements
+-   [ci-management](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#ci-management)
 
-**Required**
+-   [Deploy ci-jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#deploy-ci-jobs)
 
-- Config File Provider
-- Description Setter
-- Gerrit Trigger
-- Post Build Script
-- SSH Agent
-- Workspace Cleanup
+-   [Deploy packer-jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#deploy-packer-jobs)
 
-**Optional**
+### [Configuration](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html)
 
-- Mask Passwords
-- MsgInject
-- OpenStack Cloud
-- Timestamps
+-   [defaults.yaml](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#defaults-yaml)
 
-## Deploying ci-jobs
+-   [Jenkins Files](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#jenkins-files)
 
-The CI job group contains multiple jobs that should be deployed in all LF
-Jenkins infra. The minimal configuration needed to deploy the ci-management
-jobs is as follows which deploys the **{project-name}-ci-jobs** job group as
-defined in **lf-ci-jobs.yaml**.
+-   [Jenkins CI Jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#jenkins-ci-jobs)
 
-```
-- project:
-    name: ci-jobs
+-   [Log Archiving](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#log-archiving)
 
-    jobs:
-      - '{project-name}-ci-jobs'
+### [Best Practices](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html)
 
-    project: ci-management
-    project-name: ci-management
-    build-node: centos7-basebuild-2c-1g
-```
+-   [JJB YAML Layout](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#jjb-yaml-layout)
 
-Required parameters:
+-   [Passing parameters to shell scripts](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#passing-parameters-to-shell-scripts)
 
-**project**: is the project repo as defined in Gerrit.
-**project-name**: is a custom name to call the job in Jenkins.
-**build-node**: is the name of the builder to use when building (Jenkins label).
+-   [Shell scripts](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#shell-scripts)
 
-Optional parameters:
+-   [Usage of config-file-provider](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#usage-of-config-file-provider)
 
-**branch**: is the git branch to build from.
-**jjb-version**: is the version of JJB to install in the build minion.
+-   [Preserving Objects in Variable References](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#preserving-objects-in-variable-references)
+
+-   [Using single quotes around variables](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#using-single-quotes-around-variables)
+
+-   [Variable expansion and Defaults](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#variable-expansion-and-defaults)
+
+## For Detail Documentation [Global-JJB](http://docs.releng.linuxfoundation.org/projects/global-jjb)