Merge "Add generic push changes to gerrit builder"

[releng/global-jjb.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 40a4590..0eec76f 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,14 +6,44 @@ Linux Foundation Releng Global JJB
 Linux Foundation Release Engineering Global Jenkins Job Builder (JJB)
 Documentation.
 
-A collection of documentation for Linux Foundation JJB Templates.
+Global-JJB is a library project containing reusable Jenkins Job Builder
+templates. Mainly used by LFCI to deploy management Jenkins jobs to an LF
+managed Jenkins instance, there are other jobs defined for which may be helpful
+to projects whom use the same build technology. The intention is to save time
+for projects from having to define their own job templates.
 
-Guides:
+Release Notes
+-------------
+
+Global JJB provides regular releases. The release notes for all releases are
+available in the relnotes directory in Git.
+
+https://github.com/lfit/releng-global-jjb/tree/master/relnotes
+
+Guides
+------
 
 .. toctree::
    :maxdepth: 2
 
    best-practices
+   configuration
+
+Global JJB Templates
+--------------------
+
+Job template code is in the `jjb/` directory but documentation is in the
+`docs/jjb/` directory of this project.
+
+.. toctree::
+   :maxdepth: 1
+
+   jjb/lf-ci-jobs
+   jjb/lf-macros
+   jjb/lf-maven-jobs
+   jjb/lf-node-jobs
+   jjb/lf-python-jobs
+   jjb/lf-rtd-jobs
 
 Indices and tables
 ==================