blob: 762b49ce428b924844d8b2bff4bd89395fac7d3d [file] [log] [blame]
Timo Tijhof51516cd2013-04-09 01:32:29 +02001Zuul Status
2====
3
4Zuul Status is a web portal for a Zuul server.
5
6Set up
7------------
8
9The markup generated by the javascript is fairly generic so it should be easy
10to drop into an existing portal. All it needs is
11``<div id="id="zuul-container"></div>``.
12
13Having said that, the markup is optimised for Twitter Bootstrap, though it in
14no way depends on Boostrap and any element using a bootstrap class has a
15``zuul-`` prefixed class alongside it.
16
17The script depends on jQuery (tested with version 1.8 and 1.9).
18
19The script optimises updates by stopping when the page is not visible.
20This is done by listerning to ``show`` and ``hide`` events emitted by the
21Page Visibility plugin for jQuery. If you don't want to load this plugin you
Joshua Heskethd50eb582014-04-30 19:51:22 +100022can undo undo this optimisation by removing the code at the bottom of
23``index.html``
Timo Tijhof51516cd2013-04-09 01:32:29 +020024
25To automatically fetch the latest versions of jQuery, the Page Visibility
26plugin and Twitter Boostrap, run the ``fetch-dependencies.sh`` script.
27The default ``index.html`` references these.