12 Commits

Author SHA1 Message Date
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
Ian Wienand
eee316ce7b Enable Python 2.7 unit tests
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
2018-08-17 10:23:20 +10:00
James E. Blair
a87a1db041 Add logo to docs
Change-Id: Ic39e19e4adca85ecf8d67b35de51d604ec2510be
2018-05-04 14:50:13 -07:00
James E. Blair
af0d8eb25b Add installation/deprecation documentation
Change-Id: I4db13e723c90628ef2e3a48ba5758a04d75b8d5c
2018-04-11 08:03:57 -07:00
Tristan Cacqueray
77886345df Fix pep8/yamllint errors
Change-Id: I1fdfc0e6a96a70623058139335a22325418a0fa4
2018-01-02 06:43:26 +00:00
James E. Blair
141921cc33 Update the zuul-sphinx extension config
Change-Id: I630e5dbd182d35f3ff58288a025615e9a8a0312c
2017-08-04 16:49:39 -07:00
James E. Blair
4e6c7ef6a5 Switch to using zuul-sphinx
Remove the internal zuul domain in favor of installing from
zuul-sphinx.

Change-Id: Ia3bc2e6ad38625afedb3abd925801e1bcb40eb9e
2017-08-01 09:44:18 -07:00
James E. Blair
59735b34fc Enhance sphinx plugin
Enhances support for auto documenting jobs, as well as adding
support for roles.

Change-Id: Id018d8d546884299a226e59d2afaf682becb2736
2017-06-12 10:42:15 -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
7e0d13d1cb Add extra-test-setup role
Change-Id: Icad9896e524c69e92e9ceabd86c6ca28360887fa
Co-Authored-By: Paul Belanger <pabelanger@redhat.com>
2017-06-08 16:14:32 -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