zuul/zuul
Code Issues Proposed changes

Docs: reformat timer driver docs

Browse Source 
Change-Id: I96b17e9b4994a101cd5b5552b668db9578b64c50
This commit is contained in:
James E. Blair
2017-08-04 08:45:53 -07:00
parent 83786d4418
commit e9a0f9d7e7
1 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/source/admin/drivers/timer.rst
View File

@@ -11,14 +11,20 @@ Trgger Configuration
--------------------
Timers don't require a special connection or driver. Instead they can
simply be used by listing **timer** as the trigger.
simply be used by listing ``timer`` as the trigger.
This trigger will run based on a cron-style time specification.
It will enqueue an event into its pipeline for every project
defined in the configuration. Any job associated with the
pipeline will run in response to that event.
This trigger will run based on a cron-style time specification. It
will enqueue an event into its pipeline for every project defined in
the configuration. Any job associated with the pipeline will run in
response to that event.
**time**
The time specification in cron syntax. Only the 5 part syntax is
supported, not the symbolic names. Example: ``0 0 * * *`` runs at
midnight. The first weekday is Monday.
.. attr:: pipeline.trigger.timer
The timer trigger supports the following attributes:
.. attr:: time
:required:
The time specification in cron syntax. Only the 5 part syntax
is supported, not the symbolic names. Example: ``0 0 * * *``
runs at midnight. The first weekday is Monday.