blob: c5beda007af5389fbd32d5f10d36421bc72cf776 [file] [log] [blame]
James E. Blaircdd00072012-06-08 19:17:28 -07001.. 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
6Zuul - A Project Gating System
7==============================
8
9Zuul is a program that is used to gate the source code repository of a
10project so that changes are only merged if they pass tests.
11
12The main component of Zuul is the scheduler. It receives events
James E. Blair1f4c2bb2013-04-26 08:40:46 -070013related to proposed changes, triggers tests based on those events, and
14reports back.
James E. Blaircdd00072012-06-08 19:17:28 -070015
16Contents:
17
18.. toctree::
19 :maxdepth: 2
20
21 gating
22 triggers
James E. Blair4076e2b2014-01-28 12:42:20 -080023 merger
James E. Blaircdd00072012-06-08 19:17:28 -070024 launchers
Joshua Hesketh1879cf72013-08-19 14:13:15 +100025 reporters
James E. Blaircdd00072012-06-08 19:17:28 -070026 zuul
James E. Blair4ce47da2013-12-05 14:06:08 -080027 client
Antoine Mussoa8eea7d2013-10-05 16:08:00 +020028 statsd
James E. Blaircdd00072012-06-08 19:17:28 -070029
30Indices and tables
31==================
32
33* :ref:`genindex`
34* :ref:`modindex`
35* :ref:`search`
36