X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=e275c85e1915771971ed07c0d1e2c267bceb9d23;hb=f269be13382489a33818bdbb262796b5923a4197;hp=c1d16db8dce02b713ec6dea501045deb9fc6db08;hpb=2069fa3b9c656c59fc93c77bf0ba80a18c0ddc00;p=releng%2Fglobal-jjb.git diff --git a/docs/index.rst b/docs/index.rst index c1d16db8..e275c85e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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,20 +26,28 @@ Guides .. toctree:: :maxdepth: 2 + install + configuration + best-practices + glossary + appendix Global JJB Templates -------------------- -Job templates are designed in the `jjb/` directory but documentation is located -in the `docs/jjb/` directory of this project. +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 ==================