Merge "Quit build if submodule not found"

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

diff --git a/docs/index.rst b/docs/index.rst
index 88ac5e7..4c19d43 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,4 +1,4 @@
-.. _lfreleng-docs:
+.. _lfreleng-global-jjb:
 
 Linux Foundation Releng Global JJB
 ==================================
@@ -6,11 +6,33 @@ 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:
+Guides
+------
 
-- Best Practices
+.. 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.
+
+- :doc:`jjb/lf-ci-jobs`
+- :doc:`jjb/lf-macros`
+- :doc:`jjb/lf-maven-jobs`
+- :doc:`jjb/lf-node-jobs`
+- :doc:`jjb/lf-python-jobs`
+- :doc:`jjb/lf-rtd-jobs`
 
 Indices and tables
 ==================