From 907e27bd47bc07d8c8177db0f0c88a5f92a28df3 Mon Sep 17 00:00:00 2001 From: Jan Molak Date: Sat, 5 Apr 2014 17:16:49 +0100 Subject: [PATCH] Readme: FAQ section should answer some of the most common questions --- README.md | 37 +++++++++++++++++++++++++++---------- 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9811b2fbd..3820d69e7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -[![Stories in Backlog](https://badge.waffle.io/jan-molak/jenkins-build-monitor-plugin.png?label=backlog&title=Backlog)](https://waffle.io/jan-molak/jenkins-build-monitor-plugin) # Jenkins CI Build Monitor Plugin Build Monitor Plugin provides a highly visible view of the status of selected Jenkins jobs. @@ -7,12 +6,14 @@ It easily accommodates different computer screen sizes and is ideal as an Extrem (Inspired by the no longer maintained RadiatorView plugin). [![Build Status](https://smartcode.ci.cloudbees.com/buildStatus/icon?job=jenkins-build-monitor-plugin)](https://smartcode.ci.cloudbees.com/job/jenkins-build-monitor-plugin/) +[![Stories in Backlog](https://badge.waffle.io/jan-molak/jenkins-build-monitor-plugin.png?label=backlog&title=Backlog)](https://waffle.io/jan-molak/jenkins-build-monitor-plugin) + +Have a question? Perhaps it's already been answered - check the [FAQ](#faq) section below. ## Setting up To create a new Build Monitor View, click on the "New View" tab, select "Build Monitor View" and select jobs you wish -to display on the monitor. You can have as many Build Monitor Views as you want - the most popular approach is to have one per team -or one per project. +to display on the monitor. You can have as many Build Monitor Views as you want - the most popular approach is to have one per team or one per project. ## Features @@ -48,9 +49,6 @@ To avoid unnecessary complexity when implementing the view layer I decided to us The standard is currently supported by [most modern web browsers](http://caniuse.com/flexbox), so if your browser doesn't support this feature - [consider upgrading](http://browsehappy.com/) :) -## Project Backlog -[![Stories in Backlog](https://badge.waffle.io/jan-molak/jenkins-build-monitor-plugin.png?label=backlog&title=Backlog)](https://waffle.io/jan-molak/jenkins-build-monitor-plugin) - ## Roadmap 1. Display what triggered the build (SCM change, another job, manual) @@ -60,6 +58,29 @@ so if your browser doesn't support this feature - [consider upgrading](http://br 1. Display parameters of parametrized jobs 1. ~~Persist layout configuration changes in a long-lived cookie.~~ +## FAQ + +### How do I let my teammates know that I'm fixing a broken build? + +By claiming it. Build Monitor supports Jenkins [Claim Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Claim+plugin), so once you have it installed, enable "Broken build claiming" in the "Post-build actions" of your Jenkins job. From now on you'll be able to claim any further broken builds and Build Monitor will pick it up. + +You might also be interested in a [script](https://wiki.jenkins-ci.org/display/JENKINS/Allow+broken+build+claiming+on+every+jobs) that enables claiming on all your Jenkins jobs. + +### How do I know what broke the build? + +Wouldn't it be great to know _what_ made your build fail? Well of course it would. Build Monitor supports Jenkins [Buld Failure Analyzer Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Build+Failure+Analyzer) so get it, [teach it](https://wiki.jenkins-ci.org/display/JENKINS/Build+Failure+Analyzer#BuildFailureAnalyzer-Knowledgebase) and Build Monitor will tell you what the Failure Analyzer found out. + +### I have too many jobs on one screen, what should I do? + +You have several options here: + +1. **review the granularity of your jobs**: If you have too many low-level jobs displayed on one screen, consider consolidating them using [Promoted Builds Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Promoted+Builds+Plugin) or [MultiJob Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Multijob+Plugin) +1. **use job filters**: Build Monitor supports Jenkins [View Job Filters Plugin](https://wiki.jenkins-ci.org/display/JENKINS/View+Job+Filters), if you have it installed +1. get a bigger screen ... + +### Red and green colours are lovely, but I'm colour blind ... +There's a colour blind mode you can [enable in the Settings](https://github.com/jan-molak/jenkins-build-monitor-plugin/issues/30#issuecomment-35849019) + ## License: MIT ## Open Source Software Used @@ -73,7 +94,3 @@ so if your browser doesn't support this feature - [consider upgrading](http://br ## Inspired by No longer maintained [Radiator View Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Radiator+View+Plugin) - - -[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/jan-molak/jenkins-build-monitor-plugin/trend.png)](https://bitdeli.com/free "Bitdeli Badge") -