Skip to content

Commit

Permalink
Add footer note to burndown
Browse files Browse the repository at this point in the history 
Indicates which style of burndown is being presented
  • Loading branch information
@Lilyheart
Lilyheart committed Dec 2, 2019
1 parent aff2f27 commit bc4c8ce
Show file tree
Hide file tree
Showing 5 changed files with 127 additions and 100 deletions.
1 change: 1 addition & 0 deletions .eslintrc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"setPhase": true,

# external files
"Highcharts": true,
"gitlabServers": true,
"projects": true,
"issues": true,
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Not current accepting pull requests.

## History

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

### [[0.2.5]](https://github.com/Lilyheart/agile-gitlabce/releases/tag/v0.2.5) - 2019-11-16
Expand Down
24 changes: 12 additions & 12 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
<!-- Fontawesome -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<!-- Feedback -->
<link rel="stylesheet" href="libraries/feedback.css">
<link rel="stylesheet" href="libraries/feedback.css?ver=2012">
<!-- Local -->
<link rel="stylesheet" href="libraries/selectize.bootstrap3.css">
<link rel="stylesheet" href="style/main.min.css" media="screen" title="no title" charset="utf-8">
<link rel="stylesheet" href="libraries/selectize.bootstrap3.css?ver=v0.12.6">
<link rel="stylesheet" href="style/main.min.css?ver=0.2.6" media="screen" title="no title" charset="utf-8">

<!-- Scripts -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.js" integrity="sha256-2Kok7MbOyxpgUVvAk/HJ2jigOSYS2auK4Pfzbm7uH60=" crossorigin="anonymous"></script>
Expand Down Expand Up @@ -273,17 +273,17 @@ <h3 class="pad-below">Gitlab Setup</h3>
<!-- Bootstrap -->
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
<!-- Feedback -->
<script type="text/javascript" src="libraries/feedback.js"></script>
<script type="text/javascript" src="libraries/feedback.js?ver=2012"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/html2canvas/0.4.1/html2canvas.js" integrity="sha256-my/qJggBjG+JoaR9MUSkYM+EpxVkxZRNn3KODs+el74=" crossorigin="anonymous"></script>
<!-- Local -->
<script type="text/javascript" src="libraries/selectize.min.js"></script>
<script type="text/javascript" src="libraries/defiant.min.js"></script>
<script type="text/javascript" src="scripts/projects.js"></script>
<script type="text/javascript" src="scripts/issues.js"></script>
<script type="text/javascript" src="scripts/burndown.js"></script>
<script type="text/javascript" src="scripts/hours.js"></script>
<script type="text/javascript" src="gitlab_servers.js"></script>
<script type="text/javascript" src="scripts/main.js"></script>
<script type="text/javascript" src="libraries/selectize.min.js?ver=v0.12.6"></script>
<script type="text/javascript" src="libraries/defiant.min.js?ver=v2.2.6"></script>
<script type="text/javascript" src="scripts/projects.js?ver=0.2.6"></script>
<script type="text/javascript" src="scripts/issues.js?ver=0.2.6"></script>
<script type="text/javascript" src="scripts/burndown.js?ver=0.2.6"></script>
<script type="text/javascript" src="scripts/hours.js?ver=0.2.6"></script>
<script type="text/javascript" src="gitlab_servers.js?ver=0.2.6"></script>
<script type="text/javascript" src="scripts/main.js?ver=0.2.6"></script>
</span>
</body>
</html>
170 changes: 85 additions & 85 deletions partials/faqtab.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,103 +232,103 @@ <h4>Consistent Features</h4>
<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">Start Dates</td>
</tr>
</tbody>
<tr>
<td scope="row">What is the first date?<br /><strong>(Project wide chart)</strong></td>
<td>The earliest date of:
<ul>
<li>Issue Creation</li>
<li>Milestone start date</li>
<li>Spent Time</li>
</ul>
</td>
</tr>
<tr>
<td scope="row">What is the first date?<br /><strong>(Milestone/Sprint chart)</strong></td>
<td>Milestone start date</td>
</tr>
<tr>
<td scope="row">Spent before the start of the sprint</td>
<td>Combined with the first date of the chart</td>
</tr>
<tr>
<td scope="row">Estimate changes entered before the start of the chart</td>
<td>Combined with the first date of the chart</td>
</tr>



<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">End Dates</td>
</tr>
<tr>
<td scope="row">What is the last date?<br /><strong>(Project wide chart)</strong></td>
<td>The latest date of:
<ul>
<li>Issue creation date</li>
<li>Milestone end date</li>
<li>Latest spent time</li>
</ul>
</td>
</tr>
<tr>
<td scope="row">What is the last date?<br /><strong>(Milestone/Sprint chart)</strong></td>
<td>The latest date of:
<ul>
<li>Milestone end date</li>
<li>Latest estimated time</li>
<li>Latest spent time</li>
</ul>
</td>
</tr>
<tr>
<td scope="row">Spent after the end of the sprint?</td>
<td>Shows on the date spent</td>
</tr>
<tr>
<td scope="row">What is the first date?<br /><strong>(Project wide chart)</strong></td>
<td>The earliest date of:
<ul>
<li>Issue Creation</li>
<li>Milestone start date</li>
<li>Spent Time</li>
</ul>
</td>
</tr>
<tr>
<td scope="row">What is the first date?<br /><strong>(Milestone/Sprint chart)</strong></td>
<td>Milestone start date</td>
</tr>
<tr>
<td scope="row">Spent before the start of the sprint</td>
<td>Combined with the first date of the chart</td>
</tr>
<tr>
<td scope="row">Estimate changes entered before the start of the chart</td>
<td>Combined with the first date of the chart</td>
</tr>



<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">Ideal Burndown Line</td>
</tr>
<tr>
<td>Changes</td>
<td>Decreases at a constant rate</td>
</tr>
<tr>
<td scope="row">Ends</td>
<td>Zero at the end date of the project (see above) or end date of the sprint if applicable</td>
</tr>
<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">End Dates</td>
</tr>
<tr>
<td scope="row">What is the last date?<br /><strong>(Project wide chart)</strong></td>
<td>The latest date of:
<ul>
<li>Issue creation date</li>
<li>Milestone end date</li>
<li>Latest spent time</li>
</ul>
</td>
</tr>
<tr>
<td scope="row">What is the last date?<br /><strong>(Milestone/Sprint chart)</strong></td>
<td>The latest date of:
<ul>
<li>Milestone end date</li>
<li>Latest estimated time</li>
<li>Latest spent time</li>
</ul>
</td>
</tr>
<tr>
<td scope="row">Spent after the end of the sprint?</td>
<td>Shows on the date spent</td>
</tr>



<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">Remaining Effort Line</td>
</tr>
<tr>
<td scope="row">Excess Spends</td>
<td>If more time is spent than estimated, the estimated time is not altered. This means a negative remaining effort is possible.</td>
</tr>
<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">Ideal Burndown Line</td>
</tr>
<tr>
<td>Changes</td>
<td>Decreases at a constant rate</td>
</tr>
<tr>
<td scope="row">Ends</td>
<td>Zero at the end date of the project (see above) or end date of the sprint if applicable</td>
</tr>



<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">Actual Effort Trend Line</td>
</tr>
<tr>
<td>Changes</td>
<td>Linear Regression of the Remaining Effort line</td>
</tr>
<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">Remaining Effort Line</td>
</tr>
<tr>
<td scope="row">Excess Spends</td>
<td>If more time is spent than estimated, the estimated time is not altered. This means a negative remaining effort is possible.</td>
</tr>



<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">Completed Hours Bars</td>
</tr>
<tr>
<td>What is included?</td>
<td>The sum of all hours spent on that day</td>
</tr>
<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">Actual Effort Trend Line</td>
</tr>
<tr>
<td>Changes</td>
<td>Linear Regression of the Remaining Effort line</td>
</tr>



<tr class="bg-primary">
<td scope="row" colspan=2 class="text-center">Completed Hours Bars</td>
</tr>
<tr>
<td>What is included?</td>
<td>The sum of all hours spent on that day</td>
</tr>
</tbody>
</table>
</div>
</div>
Expand Down
30 changes: 28 additions & 2 deletions scripts/burndown.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@ var burndown = (function () {
}

async function updateBurndownData() {
let title;
let title, footnote;

await checkForUpdates();

Expand Down Expand Up @@ -530,10 +530,36 @@ var burndown = (function () {
title = "Sprint";
}

if (estimateStyle === "Final") {
footnote = "Using final estimates only";
} else { //"Changes"
footnote = "Showing changes in estimates";
}

$(function () {
$("#burndown-chart").highcharts({
title: {text: title + " Burndown Chart"},
subtitle: {text: currProjectName + " - " + milestoneList[selectedMilestone].title},
chart: {
events: {
load: function () {
var label = this.renderer.label(footnote)
.css({
fontSize: "11px",
color: "#555555"
})
.add();

label.align(Highcharts.extend(label.getBBox(), {
align: "right",
verticalAlign: "bottom",
x: 3,
y: 0
}), null, "spacingBox");
}
},
marginBottom: 120
},
xAxis: {
type: "datetime",
title: {text: "Date"},
Expand Down Expand Up @@ -610,7 +636,7 @@ var burndown = (function () {
sourceHeight: 400
},
credits: {
text: "Highcarts.com and lilyheart.github.io/agile-gitlabce",
text: "Highcharts.com and lilyheart.github.io/agile-gitlabce",
href: "https://lilyheart.github.io/agile-gitlabce/"
},
responsive: {
Expand Down

0 comments on commit bc4c8ce

Please sign in to comment.