blob: 5a0c7b956ec92b3518d534b53a1eb09d925e0cb0 [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
23 launchers
Joshua Hesketh1879cf72013-08-19 14:13:15 +100024 reporters
James E. Blaircdd00072012-06-08 19:17:28 -070025 zuul
26
27Indices and tables
28==================
29
30* :ref:`genindex`
31* :ref:`modindex`
32* :ref:`search`
33