This splits all of the current job and role documentation into
files by subject area so that jobs and roles are easier for users to
find.
This will require that any future new jobs or roles add a line to the
appropriate area of the documentation, since that can no longer be
done automatically. A linter check is added to ensure that every
job and role continue to be documented.
After this refactor, we can begin to enhance the documentation pages
so that they include narrative documentation and subsections.
Change-Id: Ia6f0e89b57e3cb0d7d1745206384c946506d7ea0
In order to see more consistency and good practices in zuul-jobs,
suggest some guidelines regarding OS and containers support, and
dealing with roles dependencies.
Change-Id: Iad001766a56833094ac8703fca11559265b6f914
Add a general note on testing, and specifically on how to use test
roles for testing trusted roles in the gate.
Change-Id: Idf84bc56effbb21f7b7a82703f398fb203c3694b
This captures some discussion over the scoping of variable names
during some recent role development. It tries to provide some
guidelines to prefixing of global variable names in roles and
"module-like" roles.
Since "deprecation.rst" is now holding a few different things, it
makes more sense as "policy.rst".
Reorganise to be nested in one more level, and add a contents section
to help find sections easier.
Change-Id: I0d551eefd33744ffa23418d0780769a7e52fe9cf
Add a testenv:py27 environment that overrides basepython to 2.7
Unfortunately implicit namespace packages are a Python3 thing [1] so
we have to scatter a few __init__.py's around for the test loader
under python2 to be able to find the unit test directories.
Update documenation to mention this
Needed-By: https://review.openstack.org/592768
[1] https://www.python.org/dev/peps/pep-0420/
Change-Id: I9a653666e8a083fb7f3fbb92589fe0467a41e6e6
This adds a Sphinx module that includes the 'description' field of
a zuul job into the documentation.
Change-Id: Iaaf5d9c1013d6c1e788046db9dbf1278d786c01e
Also add a .gitignore and establish a documentation pattern.
Change-Id: Ib447ac13d03de4ab61171d50b19117ff654ad329
Co-Authored-By: Paul Belanger <pabelanger@redhat.com>
