Fix: Update verify-images script to avoid dirs

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

diff --git a/README.md b/README.md
index 7531926..4549927 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,6 @@
+<!--- SPDX-License-Identifier: CC-BY-4.0 -->
+<!--- SPDX-FileCopyrightText: 2017 The Linux Foundation -->
+
 # Global JJB
 
 Global-JJB is a library project containing reusable Jenkins Job Builder
@@ -6,4 +9,42 @@ 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.
 
-- Documentation <http://docs.releng.linuxfoundation.org/projects/global-jjb>
+## Guides
+
+### [Install](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/)
+
+-   [Jenkins configuration](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#jenkins-configuration)
+
+-   [ci-management](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#ci-management)
+
+-   [Deploy ci-jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#deploy-ci-jobs)
+
+-   [Deploy packer-jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/install.html#deploy-packer-jobs)
+
+### [Configuration](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html)
+
+-   [defaults.yaml](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#defaults-yaml)
+
+-   [Jenkins Files](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#jenkins-files)
+
+-   [Jenkins CI Jobs](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#jenkins-ci-jobs)
+
+-   [Log Archiving](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/configuration.html#log-archiving)
+
+### [Best Practices](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html)
+
+-   [JJB YAML Layout](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#jjb-yaml-layout)
+
+-   [Passing parameters to shell scripts](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#passing-parameters-to-shell-scripts)
+
+-   [Shell scripts](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#shell-scripts)
+
+-   [Usage of config-file-provider](https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/best-practices.html#usage-of-config-file-provider)
+
+-   [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)