Skip to content

Commit bc4c8ce

Browse files
LilyheartLilyheart
committed
Add footer note to burndown
Indicates which style of burndown is being presented
1 parent aff2f27 commit bc4c8ce

File tree

5 files changed

+127
-100
lines changed

5 files changed

+127
-100
lines changed

‎.eslintrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
"setPhase": true,
5050

5151
# external files
52+
"Highcharts": true,
5253
"gitlabServers": true,
5354
"projects": true,
5455
"issues": true,

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Not current accepting pull requests.
2626

2727
## History
2828

29-
### [[0.2.5]](https://github.com/Lilyheart/agile-gitlabce/releases/tag/v0.2.6) - 2019-12-02
29+
### [[0.2.6]](https://github.com/Lilyheart/agile-gitlabce/releases/tag/v0.2.6) - 2019-12-02
3030
New Burndown Chart type.
3131

3232
### [[0.2.5]](https://github.com/Lilyheart/agile-gitlabce/releases/tag/v0.2.5) - 2019-11-16

‎index.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@
1818
<!-- Fontawesome -->
1919
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
2020
<!-- Feedback -->
21-
<link rel="stylesheet" href="libraries/feedback.css">
21+
<link rel="stylesheet" href="libraries/feedback.css?ver=2012">
2222
<!-- Local -->
23-
<link rel="stylesheet" href="libraries/selectize.bootstrap3.css">
24-
<link rel="stylesheet" href="style/main.min.css" media="screen" title="no title" charset="utf-8">
23+
<link rel="stylesheet" href="libraries/selectize.bootstrap3.css?ver=v0.12.6">
24+
<link rel="stylesheet" href="style/main.min.css?ver=0.2.6" media="screen" title="no title" charset="utf-8">
2525

2626
<!-- Scripts -->
2727
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.js" integrity="sha256-2Kok7MbOyxpgUVvAk/HJ2jigOSYS2auK4Pfzbm7uH60=" crossorigin="anonymous"></script>
@@ -273,17 +273,17 @@ <h3 class="pad-below">Gitlab Setup</h3>
273273
<!-- Bootstrap -->
274274
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
275275
<!-- Feedback -->
276-
<script type="text/javascript" src="libraries/feedback.js"></script>
276+
<script type="text/javascript" src="libraries/feedback.js?ver=2012"></script>
277277
<script src="https://cdnjs.cloudflare.com/ajax/libs/html2canvas/0.4.1/html2canvas.js" integrity="sha256-my/qJggBjG+JoaR9MUSkYM+EpxVkxZRNn3KODs+el74=" crossorigin="anonymous"></script>
278278
<!-- Local -->
279-
<script type="text/javascript" src="libraries/selectize.min.js"></script>
280-
<script type="text/javascript" src="libraries/defiant.min.js"></script>
281-
<script type="text/javascript" src="scripts/projects.js"></script>
282-
<script type="text/javascript" src="scripts/issues.js"></script>
283-
<script type="text/javascript" src="scripts/burndown.js"></script>
284-
<script type="text/javascript" src="scripts/hours.js"></script>
285-
<script type="text/javascript" src="gitlab_servers.js"></script>
286-
<script type="text/javascript" src="scripts/main.js"></script>
279+
<script type="text/javascript" src="libraries/selectize.min.js?ver=v0.12.6"></script>
280+
<script type="text/javascript" src="libraries/defiant.min.js?ver=v2.2.6"></script>
281+
<script type="text/javascript" src="scripts/projects.js?ver=0.2.6"></script>
282+
<script type="text/javascript" src="scripts/issues.js?ver=0.2.6"></script>
283+
<script type="text/javascript" src="scripts/burndown.js?ver=0.2.6"></script>
284+
<script type="text/javascript" src="scripts/hours.js?ver=0.2.6"></script>
285+
<script type="text/javascript" src="gitlab_servers.js?ver=0.2.6"></script>
286+
<script type="text/javascript" src="scripts/main.js?ver=0.2.6"></script>
287287
</span>
288288
</body>
289289
</html>

‎partials/faqtab.html‎

Lines changed: 85 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -232,103 +232,103 @@ <h4>Consistent Features</h4>
232232
<tr class="bg-primary">
233233
<td scope="row" colspan=2 class="text-center">Start Dates</td>
234234
</tr>
235-
</tbody>
236-
<tr>
237-
<td scope="row">What is the first date?<br /><strong>(Project wide chart)</strong></td>
238-
<td>The earliest date of:
239-
<ul>
240-
<li>Issue Creation</li>
241-
<li>Milestone start date</li>
242-
<li>Spent Time</li>
243-
</ul>
244-
</td>
245-
</tr>
246-
<tr>
247-
<td scope="row">What is the first date?<br /><strong>(Milestone/Sprint chart)</strong></td>
248-
<td>Milestone start date</td>
249-
</tr>
250-
<tr>
251-
<td scope="row">Spent before the start of the sprint</td>
252-
<td>Combined with the first date of the chart</td>
253-
</tr>
254-
<tr>
255-
<td scope="row">Estimate changes entered before the start of the chart</td>
256-
<td>Combined with the first date of the chart</td>
257-
</tr>
258-
259-
260-
261-
<tr class="bg-primary">
262-
<td scope="row" colspan=2 class="text-center">End Dates</td>
263-
</tr>
264-
<tr>
265-
<td scope="row">What is the last date?<br /><strong>(Project wide chart)</strong></td>
266-
<td>The latest date of:
267-
<ul>
268-
<li>Issue creation date</li>
269-
<li>Milestone end date</li>
270-
<li>Latest spent time</li>
271-
</ul>
272-
</td>
273-
</tr>
274-
<tr>
275-
<td scope="row">What is the last date?<br /><strong>(Milestone/Sprint chart)</strong></td>
276-
<td>The latest date of:
277-
<ul>
278-
<li>Milestone end date</li>
279-
<li>Latest estimated time</li>
280-
<li>Latest spent time</li>
281-
</ul>
282-
</td>
283-
</tr>
284-
<tr>
285-
<td scope="row">Spent after the end of the sprint?</td>
286-
<td>Shows on the date spent</td>
287-
</tr>
235+
<tr>
236+
<td scope="row">What is the first date?<br /><strong>(Project wide chart)</strong></td>
237+
<td>The earliest date of:
238+
<ul>
239+
<li>Issue Creation</li>
240+
<li>Milestone start date</li>
241+
<li>Spent Time</li>
242+
</ul>
243+
</td>
244+
</tr>
245+
<tr>
246+
<td scope="row">What is the first date?<br /><strong>(Milestone/Sprint chart)</strong></td>
247+
<td>Milestone start date</td>
248+
</tr>
249+
<tr>
250+
<td scope="row">Spent before the start of the sprint</td>
251+
<td>Combined with the first date of the chart</td>
252+
</tr>
253+
<tr>
254+
<td scope="row">Estimate changes entered before the start of the chart</td>
255+
<td>Combined with the first date of the chart</td>
256+
</tr>
288257

289258

290259

291-
<tr class="bg-primary">
292-
<td scope="row" colspan=2 class="text-center">Ideal Burndown Line</td>
293-
</tr>
294-
<tr>
295-
<td>Changes</td>
296-
<td>Decreases at a constant rate</td>
297-
</tr>
298-
<tr>
299-
<td scope="row">Ends</td>
300-
<td>Zero at the end date of the project (see above) or end date of the sprint if applicable</td>
301-
</tr>
260+
<tr class="bg-primary">
261+
<td scope="row" colspan=2 class="text-center">End Dates</td>
262+
</tr>
263+
<tr>
264+
<td scope="row">What is the last date?<br /><strong>(Project wide chart)</strong></td>
265+
<td>The latest date of:
266+
<ul>
267+
<li>Issue creation date</li>
268+
<li>Milestone end date</li>
269+
<li>Latest spent time</li>
270+
</ul>
271+
</td>
272+
</tr>
273+
<tr>
274+
<td scope="row">What is the last date?<br /><strong>(Milestone/Sprint chart)</strong></td>
275+
<td>The latest date of:
276+
<ul>
277+
<li>Milestone end date</li>
278+
<li>Latest estimated time</li>
279+
<li>Latest spent time</li>
280+
</ul>
281+
</td>
282+
</tr>
283+
<tr>
284+
<td scope="row">Spent after the end of the sprint?</td>
285+
<td>Shows on the date spent</td>
286+
</tr>
302287

303288

304289

305-
<tr class="bg-primary">
306-
<td scope="row" colspan=2 class="text-center">Remaining Effort Line</td>
307-
</tr>
308-
<tr>
309-
<td scope="row">Excess Spends</td>
310-
<td>If more time is spent than estimated, the estimated time is not altered. This means a negative remaining effort is possible.</td>
311-
</tr>
290+
<tr class="bg-primary">
291+
<td scope="row" colspan=2 class="text-center">Ideal Burndown Line</td>
292+
</tr>
293+
<tr>
294+
<td>Changes</td>
295+
<td>Decreases at a constant rate</td>
296+
</tr>
297+
<tr>
298+
<td scope="row">Ends</td>
299+
<td>Zero at the end date of the project (see above) or end date of the sprint if applicable</td>
300+
</tr>
312301

313302

314303

315-
<tr class="bg-primary">
316-
<td scope="row" colspan=2 class="text-center">Actual Effort Trend Line</td>
317-
</tr>
318-
<tr>
319-
<td>Changes</td>
320-
<td>Linear Regression of the Remaining Effort line</td>
321-
</tr>
304+
<tr class="bg-primary">
305+
<td scope="row" colspan=2 class="text-center">Remaining Effort Line</td>
306+
</tr>
307+
<tr>
308+
<td scope="row">Excess Spends</td>
309+
<td>If more time is spent than estimated, the estimated time is not altered. This means a negative remaining effort is possible.</td>
310+
</tr>
322311

323312

324313

325-
<tr class="bg-primary">
326-
<td scope="row" colspan=2 class="text-center">Completed Hours Bars</td>
327-
</tr>
328-
<tr>
329-
<td>What is included?</td>
330-
<td>The sum of all hours spent on that day</td>
331-
</tr>
314+
<tr class="bg-primary">
315+
<td scope="row" colspan=2 class="text-center">Actual Effort Trend Line</td>
316+
</tr>
317+
<tr>
318+
<td>Changes</td>
319+
<td>Linear Regression of the Remaining Effort line</td>
320+
</tr>
321+
322+
323+
324+
<tr class="bg-primary">
325+
<td scope="row" colspan=2 class="text-center">Completed Hours Bars</td>
326+
</tr>
327+
<tr>
328+
<td>What is included?</td>
329+
<td>The sum of all hours spent on that day</td>
330+
</tr>
331+
</tbody>
332332
</table>
333333
</div>
334334
</div>

‎scripts/burndown.js‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ var burndown = (function () {
502502
}
503503

504504
async function updateBurndownData() {
505-
let title;
505+
let title, footnote;
506506

507507
await checkForUpdates();
508508

@@ -530,10 +530,36 @@ var burndown = (function () {
530530
title = "Sprint";
531531
}
532532

533+
if (estimateStyle === "Final") {
534+
footnote = "Using final estimates only";
535+
} else { //"Changes"
536+
footnote = "Showing changes in estimates";
537+
}
538+
533539
$(function () {
534540
$("#burndown-chart").highcharts({
535541
title: {text: title + " Burndown Chart"},
536542
subtitle: {text: currProjectName + " - " + milestoneList[selectedMilestone].title},
543+
chart: {
544+
events: {
545+
load: function () {
546+
var label = this.renderer.label(footnote)
547+
.css({
548+
fontSize: "11px",
549+
color: "#555555"
550+
})
551+
.add();
552+
553+
label.align(Highcharts.extend(label.getBBox(), {
554+
align: "right",
555+
verticalAlign: "bottom",
556+
x: 3,
557+
y: 0
558+
}), null, "spacingBox");
559+
}
560+
},
561+
marginBottom: 120
562+
},
537563
xAxis: {
538564
type: "datetime",
539565
title: {text: "Date"},
@@ -610,7 +636,7 @@ var burndown = (function () {
610636
sourceHeight: 400
611637
},
612638
credits: {
613-
text: "Highcarts.com and lilyheart.github.io/agile-gitlabce",
639+
text: "Highcharts.com and lilyheart.github.io/agile-gitlabce",
614640
href: "https://lilyheart.github.io/agile-gitlabce/"
615641
},
616642
responsive: {

0 commit comments

Comments
 (0)