zuul/etc/status
Monty Taylor 9010dc50f4
Remove .json suffix from web routes
For the existing simple cases, like builds, jobs and status, having the json
suffix is a perfectly reasonable thing. However, in the next patch it starts
to get weird. When we add support for specific changes or specific jobs, we
we grow URLs like:

  /openstack/status.json
  /openstack/status/change/537010,2.json

Those read weird, because change/537010,2 is much more like an argument or
specialiation of status. The thing that reads weird is the status call having
 .json but the change-specific call just being status/, not
the trailing .json on the change url.

Removing the json suffix gets us:

  /openstack/status
  /openstack/status/change/537010,2

which feels better as the status portion of the url remains consistent.

This is done first in the stack so that as we add tests for new
endpoints we can get them right the first time rather than having a big
rename patch at the end (which is what this started as)

Change-Id: I4baf33fdacaf46943fbd192743551bb27bd618de
2018-02-19 09:27:31 -06:00
..
public_html Remove .json suffix from web routes 2018-02-19 09:27:31 -06:00
.gitignore Status: Move external dependencies into public_html/lib 2015-04-02 01:04:18 +01:00
.jshintignore Status: Fix JSHint violations and commit settings 2015-06-29 14:04:02 +01:00
.jshintrc Status: Fix JSHint violations and commit settings 2015-06-29 14:04:02 +01:00
README.rst Fix up fetching jquery.visibility 2014-06-02 07:17:47 +00:00
fetch-dependencies.sh Status: Move external dependencies into public_html/lib 2015-04-02 01:04:18 +01:00

README.rst

Zuul Status ====

Zuul Status is a web portal for a Zuul server.

Set up

The markup generated by the javascript is fairly generic so it should be easy to drop into an existing portal. All it needs is <div id="id="zuul-container"></div>.

Having said that, the markup is optimised for Twitter Bootstrap, though it in no way depends on Boostrap and any element using a bootstrap class has a zuul- prefixed class alongside it.

The script depends on jQuery (tested with version 1.8 and 1.9).

The script optimises updates by stopping when the page is not visible. This is done by listerning to show and hide events emitted by the Page Visibility plugin for jQuery. If you don't want to load this plugin you can undo undo this optimisation by removing the code at the bottom of index.html

To automatically fetch the latest versions of jQuery, the Page Visibility plugin and Twitter Boostrap, run the fetch-dependencies.sh script. The default index.html references these.