Fix API breakage caused by OS Plugin version scan
[releng/global-jjb.git] / docs / index.rst
index 19b6380..e275c85 100644 (file)
@@ -6,7 +6,19 @@ 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. 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.
+
+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
 ------
@@ -14,21 +26,28 @@ Guides
 .. toctree::
    :maxdepth: 2
 
-   best-practices
+   install
    configuration
 
+   best-practices
+   glossary
+   appendix
+
 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`
+.. 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
 ==================