treeherder/ui/userguide.html

243 строки
8.9 KiB
HTML

<!DOCTYPE html>
<html ng-app="userguide" ng-strict-di>
<head>
<meta charset="utf-8">
<title>Treeherder User Guide</title>
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link id="favicon" type="image/png" rel="shortcut icon" href="img/tree_open.png">
</head>
<body ng-controller="UserguideCtrl" id="userguide">
<!-- Content panel -->
<div class="card">
<!-- Header -->
<div class="card-header">
<h1>Treeherder User Guide</h1>
<h5>Want to contribute?
<a href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Tree+Management&amp;component=Treeherder">
File a bug</a> /
<a href="https://github.com/mozilla/treeherder">
Source</a> /
<a href="https://wiki.mozilla.org/EngineeringProductivity/Projects/Treeherder#Contributing">
Contributing</a>
</h5>
For anything else visit our
<a href="https://wiki.mozilla.org/EngineeringProductivity/Projects/Treeherder">
Project Wiki</a>
or ask us on IRC in
<a href="irc://irc.mozilla.org/treeherder">#treeherder</a>
</div>
<!-- Start of interior panels -->
<div class="card-body">
<div class="row">
<!-- Job Notation table -->
<div class="col-6">
<div class="card">
<div class="card-header">
<h3>Job notation</h3>
</div>
<div class="card-body">
<table id="legend-other">
<tr>
<th>
<button class="btn btn-green ug-btn ug-btn-comment">+n</button>
</th>
<td>Collapsed job count</td>
</tr>
<tr>
<th>
<button class="btn btn-dkgray ug-btn ug-btn-comment">Th( )</button>
</th>
<td>Wrapped job group</td>
</tr>
<tr>
<th>
<button class="btn btn-orange-classified autoclassified ug-btn ug-btn-comment">Th</button>
</th>
<td>Hollow asterisk, auto-classified</td>
</tr>
<tr>
<th>
<button class="btn btn-orange-classified ug-btn ug-btn-comment">Th</button>
</th>
<td>Asterisk, classified</td>
</tr>
<tr>
<th>
<button class="btn btn-ltgray ug-btn ug-btn-bg">Th</button>
</th>
<td>Light gray, pending</td>
</tr>
<tr>
<th>
<button class="btn btn-dkgray ug-btn ug-btn-bg">Th</button>
</th>
<td>Gray, running</td>
</tr>
<tr>
<th>
<button class="btn btn-green ug-btn ug-btn-bg">Th</button>
</th>
<td>Green, success</td>
</tr>
<tr>
<th>
<button class="btn btn-orange ug-btn ug-btn-orange">Th</button>
</th>
<td>Orange, tests failed</td>
</tr>
<tr>
<th>
<button class="btn btn-purple ug-btn ug-btn-purple">Th</button>
</th>
<td>Purple, infrastructure exception</td>
</tr>
<tr>
<th>
<button class="btn btn-red ug-btn ug-btn-red">Th</button>
</th>
<td>Red, build error</td>
</tr>
<tr>
<th>
<button class="btn btn-dkblue ug-btn ug-btn-bg">Th</button>
</th>
<td>Dark blue, build restarted</td>
</tr>
<tr>
<th>
<button class="btn btn-pink ug-btn ug-btn-bg">Th</button>
</th>
<td>Pink, build cancelled</td>
</tr>
<tr>
<th>
<button class="btn btn-yellow ug-btn ug-btn-yellow">Th</button>
</th>
<td>Yellow, unknown</td>
</tr>
<tr>
<th class="superseded">
<button class="btn btn-ltblue ug-btn ug-btn-bg">Th</button>
</th>
<td>Light blue, superseded</td>
</tr>
</table>
</div>
</div>
</div>
<!-- Shortcuts table -->
<div class="col-6">
<ng-include id="th-shortcut-table"
src="'partials/main/thShortcutTable.html'"></ng-include>
</div>
<!-- Copy values on hover table -->
<div class="col-6">
<div class="card">
<div class="card-header"><h3>Copy values on hover</h3></div>
<div class="card-body panel-spacing">
<table id="shortcuts">
<tr>
<td><kbd>ctrl/cmd</kbd><kbd>c</kbd></td>
<td>Copy job details
<img src="./img/logviewerIconHelp.svg" id="ug-logviewer-icon">
logviewer url on hover
</td>
</tr>
<tr>
<td><kbd>ctrl/cmd</kbd><kbd>c</kbd></td>
<td>Copy job details
<span id="ug-raw-log-icon" class="fa fa-file-text-o"></span>
raw log url on hover
</td>
</tr>
<tr>
<td><kbd>ctrl/cmd</kbd><kbd>c</kbd></td>
<td>Copy job details <span class="small"><label>Job:</label>
<span id="ug-job-name">name</span></span> as raw text on hover
</td>
</tr>
</table>
</div>
</div>
</div>
<!-- End of row -->
</div>
<!-- Query string params -->
<div class="row">
<div class="col-12">
<div class="card">
<div class="card-header">
<h3>URL Query String Parameters</h3>
</div>
<div class="card-body panel-spacing">
<table id="queryparams">
<tr>
<td><span class="queryparam">nojobs</span></td>
<td>Load pushes without loading any job results.</td>
<td><span class="queryparam">&nojobs</span></td>
</tr>
<tr>
<td><span class="queryparam">fromchange</span></td>
<td>Specify the earliest revision in the push range.</td>
<td><span class="queryparam">&fromchange=a12ca6c8b89b</span></td>
</tr>
<tr>
<td><span class="queryparam">tochange</span></td>
<td>Specify the latest revision in the push range.</td>
<td><span class="queryparam">&tochange=3215c7fc090b</span></td>
</tr>
<tr>
<td><span class="queryparam">startdate</span></td>
<td>
<span>Specify the earliest</span>
<span class="queryparam">YYYY-MM-DD</span>
<span>date in the push range.</span>
</td>
<td><span class="queryparam">&startdate={{ startDate }}</span></td>
</tr>
<tr>
<td><span class="queryparam">enddate</span></td>
<td>
<span>Specify the latest</span>
<span class="queryparam">YYYY-MM-DD</span>
<span>date in the push range.</span>
</td>
<td><span class="queryparam">&enddate={{ endDate }}</span></td>
</tr>
</table>
</div>
</div>
</div>
</div>
<!-- End of interior panels -->
</div>
<!-- Credits and Whats Deployed -->
<div class="card-footer ug-footer row">
<div class="col-6">
<div>Some icons by
<a href="http://www.freepik.com" title="Freepik">Freepik</a> from
<a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> licensed under
<a href="http://creativecommons.org/licenses/by/3.0/"
title="Creative Commons BY 3.0">CC BY 3.0</a>
</div>
</div>
<div class="col-6 float-right">
<a class="midgray float-right"
href="http://whatsdeployed.io/?owner=mozilla&amp;repo=treeherder&amp;name[]=Stage&amp;url[]=https://treeherder.allizom.org/revision.txt&amp;name[]=Prod&amp;url[]=https://treeherder.mozilla.org/revision.txt">What's Deployed?</a>
</div>
</div>
<!-- End of content panel -->
</div>
</body>
</html>