Commit Graph

10 Commits

Author SHA1 Message Date
James E. Blair 7941c3bdad Add mirror_info documentation
This is designed to be a flexible system which can replace
the current ad-hoc mirrors used by the configure-mirror
and other roles in this repo.

Change-Id: I20adef837c5f961624fe0f7adbc93d2cf8f7761a
2019-07-19 12:49:18 -07:00
James E. Blair 146349b88e Move in-repo test jobs into zuul-tests.d
These jobs are for testing this repo and should normally only be
included by the OpenDev Zuul for gating.

Change-Id: I7bf940edce1135d855d7f66605db2e856bd7177d
2019-07-02 10:04:11 -07:00
James E. Blair 2f2d6ce3f7 Add a registry test job
This exercises the intermediate and buildset registry roles.

Change-Id: Ic0da2d6b48a7b9f9b616033c70db471ba98181b4
2019-06-03 09:03:35 -07:00
James E. Blair 4b3adfeea6 Organize documentation by subject area
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
2019-03-25 14:21:04 -07:00
James E. Blair e620f0b74e Document how to build a buildset registry
Change-Id: I57e6ace5f6731045b8043995b18835a499d2250c
2019-03-15 08:37:37 -07:00
Ian Wienand c9b4b01187 Add guidelines on variable naming
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
2018-08-31 09:28:34 +10:00
James E. Blair af0d8eb25b Add installation/deprecation documentation
Change-Id: I4db13e723c90628ef2e3a48ba5758a04d75b8d5c
2018-04-11 08:03:57 -07:00
James E. Blair 639d10d5c4 Add Sphinx module for Zuul jobs
This adds a Sphinx module that includes the 'description' field of
a zuul job into the documentation.

Change-Id: Iaaf5d9c1013d6c1e788046db9dbf1278d786c01e
2017-06-09 09:03:15 -07:00
James E. Blair 46684654cb Add revoke-sudo role
Also add a .gitignore and establish a documentation pattern.

Change-Id: Ib447ac13d03de4ab61171d50b19117ff654ad329
Co-Authored-By: Paul Belanger <pabelanger@redhat.com>
2017-06-08 15:19:43 -07:00
James E. Blair e5ebc400cb Add initial license, docs, and other config
Change-Id: Ie016aa9a3494bea1e37b7eee4a970d5772317d47
2017-06-08 14:01:21 -07:00