Permalink
Browse files

Fixed numerous mistakes in the readme and added some example for addi…

…ng your own content
  • Loading branch information...
1 parent 951aa54 commit 88febcaab8df452e09f0c837e250ff04887ea79d Adam Hope committed Jul 30, 2012
Showing with 69 additions and 21 deletions.
  1. +69 −21 README.md
View
@@ -1,42 +1,90 @@
-Jenkins Monitor
-=============
+# Jenkins Monitor
This project aims to help you show status of build in blue(building), red(failure), green(success) box on jenkins.
By using jQuery JSONP and jenkins built-in API, setup is a piece of cake.
-Why
--------
+## Why
-For a CI server to be effective it is important that the team is constantly aware of the build status (it could be in big TV). A Red box means that build is failed, someonebody in the team may need to take a look at it;Green means "yep, success";Blue means that build currently is building; Grey means that build is aborted or disabled.
+For a CI server to be effective it is important that the team is constantly aware of the build status, typically this is done using a build light. Jenkins-dashboard has a few advantages overy a typical build light. Assuming you have a spare monitor or TV you can display jenkins-dashboard on it is cheaper, can display the status of any number of builds and can also display additional information such as who claimed a broken build, or who's turn it is to buy cake!
-![Prototype](http://farm7.static.flickr.com/6037/6328931162_042f2c1d09_z.jpg "Optional title")
+![Prototype](http://farm7.static.flickr.com/6037/6328931162_042f2c1d09_z.jpg "Jenkins monitor on the big screen")
-How to Use
------------
+## How to Use
+
+ Clone this repo to the computer you want to run the dashboard on
git clone git://github.com/tuo/jenkins-monitor.git
+ Create a new config file
+
+ vi conf/config.js
+
+ And add the following code replacing the values with your own
+
+ var CONFIG = {
+ project_title: "Project Dashboard",
+ jenkinsUrl: 'http://ci.jruby.org/view/Ruboto',
+ jobs_to_be_filtered: [],
+ jobs_to_be_excluded: [],
+ cycleTime: 4
+ };
+
+ Open the dashboard in your browser
+
+ open index.html -a safari
+
+
+## Adding new tabs
+
+### Static content
+
+You can easily add a tab with static content, these could be used to display information that doesn't change very often.
+
+Open index.html and find
+
+ <ul class="nav nav-tabs"></ul>
+
+then add the following code
+
+ <li><a href="#your-stuff">Your Stuff</a></li>
+
+Then find the
+
+ <div class="pill-content"></div>
+
+and add
+
+ <section id="your-stuff">
+ <header><h2>Your Stuff</h2></header>
+ <div class="content">
+ <p>Lorem ipsum dolor sit amet...</p>
+ </div>
+ </section>
- Then copy or rename conf/config.js.sample to conf/config.js:
+Make sure that the id of the section matches the href of your li
- copy conf/config.js.sample conf/config.js
+### Dynamic content
- or
+We've implimented a basic plugin system for adding tabs with dynamic content. For this example we'll make a simple "Hello World!" plugin.
- mv conf/config.js.sample conf/config.js
+1. Make a new file in js/plugins/hello_world.js with the following content:
- And open conf/config.js to change your jenkins ci address and jobs name you want to show on dashboard like following:
+ (function () {
+ var el = dashboard.createTab('Hello World');
+ function displayMessage() {
+ el.html('Hello World')
+ }
+ }());
- var ci_url = "http://ci.jruby.org/view/Ruboto";
- var jobs_to_be_filtered = ["apitest", "ergonomics"];
+2. Include the new file at the bottom of index.html in the section marked "plugins"
+ <script src="js/plugins/hello_world.js"></script>
- Then run from command line:
+It's a very basic example but the important points are:
- open dashboard.html -a safari
+1. Your plugin file must self execute
+2. dashboard.createTab('Hello World'); creates a named tab and returns a jQuery object for the body of the new tab which you can update using JavaScript for example you could use jQuery to make JSONP requests to a server on a regular interval and insert the content when it receives a response.
+## Contribute
-Contribute
-------------
-This project is still a work in progress.
-Suggestions? Email to: clarkhtse@gmail.com or adam@adamhope.com
+This project is still a work in progress. Send us your pull requests or e-mail suggestions to: clarkhtse@gmail.com or adam@adamhope.com.

0 comments on commit 88febca

Please sign in to comment.