blob: f901fd08f278c910d489556d83f6a337cf56d8ee [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
13related to proposed changes (currently from Gerrit), triggers tests
14based on those events (currently on Jenkins), and reports back.
15
16Contents:
17
18.. toctree::
19 :maxdepth: 2
20
21 gating
22 triggers
23 launchers
24 zuul
25
26Indices and tables
27==================
28
29* :ref:`genindex`
30* :ref:`modindex`
31* :ref:`search`
32