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