Fix Daily Jobs schedule indicators with accurate badge descriptions

Corrected schedule display documentation based on actual UI:

Status Indicators (dots):
- Green dot: Job ran successfully
- Red dot: Job ran but failed
- White dot: Expected but not yet run (time not arrived)
- Gray dot: Expected but overdue (time passed, no run)

Run Count Badges:
- "1 run" (gray badge): Single run received
- "3 runs" (blue/cyan badge): Multiple runs received (stands out)
- Badge appears next to green dot when runs are successful
- Multiple runs (3+) highlighted with blue/cyan for attention

Removed incorrect description about:
- Run counters in parentheses (actually separate badges)
- Times shown only once (times can repeat for different runs)

Added Screenshot:
- schedule-indicators.png: Shows actual time slots with dots and badges

Enhanced workflow tip with specific actions for each indicator type.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Ivo Oskamp 2026-02-08 14:02:16 +01:00
parent 79095f088e
commit eeb8f3cdad
2 changed files with 57 additions and 26 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

View File

@ -199,65 +199,96 @@
<h2>Using Schedules in Daily Jobs</h2>
<p>The Daily Jobs page uses learned schedules to show which jobs are expected to run today:</p>
<p>The Daily Jobs page uses learned schedules to show which jobs are expected to run today. Each scheduled time is displayed with a status indicator:</p>
<figure>
<img src="{{ url_for('static', filename='images/documentation/schedule-indicators.png') }}"
alt="Daily Jobs Schedule Indicators" />
<figcaption>Figure 1: Daily Jobs schedule showing time slots with run status indicators and run count badges</figcaption>
</figure>
<h3>Status Indicators</h3>
<table>
<thead>
<tr>
<th>Job Status</th>
<th>Color</th>
<th>Indicator</th>
<th>Meaning</th>
<th>Action Needed</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Ran successfully</strong></td>
<td>Green</td>
<td>Job ran today and completed successfully</td>
<td><strong>Green dot</strong></td>
<td>Job ran successfully at this time</td>
<td>No action needed</td>
</tr>
<tr>
<td><strong>Ran with failure</strong></td>
<td>Red</td>
<td>Job ran today but failed</td>
<td><strong>Red dot</strong></td>
<td>Job ran but failed at this time</td>
<td>Investigate failure, create ticket if needed</td>
</tr>
<tr>
<td><strong>Expected but not run yet</strong></td>
<td>White</td>
<td>Job is expected to run later today (time hasn't arrived yet)</td>
<td><strong>White dot</strong></td>
<td>Job expected but not yet run (time hasn't arrived yet)</td>
<td>Wait - job is not yet overdue</td>
</tr>
<tr>
<td><strong>Expected but overdue</strong></td>
<td>Gray</td>
<td>Job was expected to run but hasn't (time has passed)</td>
<td><strong>Gray dot</strong></td>
<td>Job expected but overdue (time has passed, no run received)</td>
<td>Investigate - job may have failed to start</td>
</tr>
</tbody>
</table>
<h3>Run Count Badges</h3>
<p>When a job has run, a badge appears next to the status indicator showing how many runs occurred:</p>
<table>
<thead>
<tr>
<th>Badge</th>
<th>Color</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>1 run</strong></td>
<td>Gray</td>
<td>Single backup run received for this time slot</td>
</tr>
<tr>
<td><strong>3 runs</strong></td>
<td>Blue/Cyan</td>
<td>Multiple backup runs received for this time slot (stands out for attention)</td>
</tr>
</tbody>
</table>
<div class="doc-callout doc-callout-tip">
<strong>💡 Workflow Tip:</strong><br>
Use the Daily Jobs page as your primary monitoring dashboard. Check it daily to ensure all expected backups have run successfully. Jobs showing in <strong>white</strong> are not yet due, while jobs showing in <strong>gray</strong> are overdue and should be investigated.
Use the Daily Jobs page as your primary monitoring dashboard. Check it daily to ensure all expected backups have run successfully:
<ul>
<li><strong>White dots:</strong> Not yet due - wait</li>
<li><strong>Gray dots:</strong> Overdue - investigate immediately</li>
<li><strong>Green dots with badges:</strong> Completed successfully</li>
<li><strong>Blue badges (3+ runs):</strong> Multiple runs detected - verify this is expected</li>
</ul>
</div>
<h3>Multiple Runs Per Day</h3>
<h3>Multiple Runs Per Time Slot</h3>
<p>Some jobs run multiple times per day (e.g., hourly backups, multiple backup sets):</p>
<p>Some jobs run multiple times at the same scheduled time (e.g., multiple backup sets, parallel jobs):</p>
<ul>
<li>The schedule displays the expected time(s) only once</li>
<li>A <strong>run counter</strong> appears next to the time indicator showing how many runs have occurred</li>
<li>Example: A job running 3 times per day at 10:00 might show "10:00 (3)" indicating 3 runs</li>
<li>Each time slot shows a green dot when runs are successful</li>
<li>The run count badge shows how many runs were received (e.g., "1 run", "3 runs")</li>
<li>Multiple runs (3+) are highlighted with a <strong>blue/cyan badge</strong> to stand out</li>
<li>This helps you quickly identify jobs with unusual activity</li>
</ul>
<div class="doc-callout doc-callout-info">
<strong>💡 Run Counters:</strong><br>
The number in parentheses after the time indicates how many backup runs have been received for that job today. This helps you track jobs that run multiple times per day.
</div>
<h2>Schedule Learning Best Practices</h2>
<p>To help BackupChecks learn accurate schedules:</p>