Migrate Global JJB docs to RST 96/6896/6
authorThanh Ha <thanh.ha@linuxfoundation.org>
Sun, 15 Oct 2017 20:44:08 +0000 (16:44 -0400)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Thu, 19 Oct 2017 04:10:03 +0000 (00:10 -0400)
commit391e8138f528a720604ed9da7bda949b5e56fbec
tree0f7a00a07d09376fe1a209aa78d09449e13397d5
parent8d441550db2c781a25894896d46edf06e5bbfd67
Migrate Global JJB docs to RST

This moves Global JJB documentation into RST docs and adds a
new checker which parses YAML files for items that are missing
documentation to ensure that every new template addition comes with
supporting documentation.

Tried to update documentation where it made sense too but we should
probably go back later and review all the items to make sure they are
all sufficiently documented. Especially macros which in many places are
lacking in required parameter documentation.

Change-Id: I6551e14f934a904378771262d1491cb5b3df5854
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
15 files changed:
docs/index.rst
docs/jjb/lf-ci-jobs.rst [new file with mode: 0644]
docs/jjb/lf-macros.rst [new file with mode: 0644]
docs/jjb/lf-maven-jobs.rst [new file with mode: 0644]
docs/jjb/lf-node-jobs.rst [new file with mode: 0644]
docs/jjb/lf-python-jobs.rst [new file with mode: 0644]
docs/jjb/lf-rtd-jobs.rst [new file with mode: 0644]
ensure-documented.sh [new file with mode: 0755]
jjb/lf-ci-jobs.yaml
jjb/lf-macros.yaml
jjb/lf-maven-jobs.yaml
jjb/lf-node-jobs.yaml
jjb/lf-python-jobs.yaml
jjb/lf-rtd-jobs.yaml
tox.ini