James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 1 | .. Zuul documentation master file, created by |
| 2 | sphinx-quickstart on Fri Jun 8 14:44:26 2012. |
| 3 | You can adapt this file completely to your liking, but it should at least |
| 4 | contain the root `toctree` directive. |
| 5 | |
| 6 | Zuul - A Project Gating System |
| 7 | ============================== |
| 8 | |
| 9 | Zuul is a program that is used to gate the source code repository of a |
| 10 | project so that changes are only merged if they pass tests. |
| 11 | |
| 12 | The main component of Zuul is the scheduler. It receives events |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 13 | related to proposed changes, triggers tests based on those events, and |
| 14 | reports back. |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 15 | |
| 16 | Contents: |
| 17 | |
| 18 | .. toctree:: |
| 19 | :maxdepth: 2 |
| 20 | |
| 21 | gating |
| 22 | triggers |
James E. Blair | 4076e2b | 2014-01-28 12:42:20 -0800 | [diff] [blame] | 23 | merger |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 24 | launchers |
Joshua Hesketh | 1879cf7 | 2013-08-19 14:13:15 +1000 | [diff] [blame] | 25 | reporters |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 26 | zuul |
James E. Blair | 4ce47da | 2013-12-05 14:06:08 -0800 | [diff] [blame] | 27 | client |
Antoine Musso | a8eea7d | 2013-10-05 16:08:00 +0200 | [diff] [blame] | 28 | statsd |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 29 | |
| 30 | Indices and tables |
| 31 | ================== |
| 32 | |
| 33 | * :ref:`genindex` |
| 34 | * :ref:`modindex` |
| 35 | * :ref:`search` |
| 36 | |