ivooskamp/backupchecks
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix per-job review mechanism in Backup Review documentation

Browse Source 
Corrected documentation to accurately reflect that review is done per-JOB
(not per individual run). When marking a job as reviewed, ALL runs within
that job are marked simultaneously and the job disappears from Run Checks.

Changes:
- Run Checks Modal: Removed non-existent "reviewed indicator", clarified
  per-job review in Page Layout callout, updated Mark as Reviewed section
  to explain all runs for job are marked together, changed bulk review from
  "select multiple run checkboxes" to "select multiple job checkboxes",
  updated Unmark Reviewed to reflect per-job unmarking, removed incorrect
  statement that successful runs are automatically reviewed
- Approving Backups: Updated bulk review section from "runs" to "jobs" for
  consistency with per-job review mechanism
- Changelog: Updated with all per-job review fixes

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Ivo Oskamp 2026-02-08 20:00:10 +01:00
parent ab6f94b024
commit c58855a1a6
3 changed files with 30 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
containers/backupchecks/src/templates/documentation/backup-review/approving-backups.html
View File

@ -230,13 +230,13 @@
<h3>Bulk Review</h3>
<p>For efficiency, you can mark multiple runs as reviewed simultaneously:</p>
<p>For efficiency, you can mark multiple jobs as reviewed simultaneously:</p>
<ol>
<li>Open the Run Checks page</li>
<li>Select multiple run checkboxes</li>
<li>Select multiple job checkboxes</li>
<li>Click <strong>Mark selected as reviewed</strong></li>
<li>All selected runs disappear from the list</li>
<li>All runs for all selected jobs are marked as reviewed and disappear from the list</li>
</ol>
<p>This is especially useful for successful backups where no investigation is needed - you can quickly clear them to keep the Run Checks page empty.</p>

50
containers/backupchecks/src/templates/documentation/backup-review/run-checks-modal.html
View File

@ -43,41 +43,39 @@
This is your primary daily workflow page. Open it first thing in the morning and work through all runs until the page is empty.
</div>
<h2>Modal Layout</h2>
<h2>Page Layout</h2>
<p>The Run Checks modal displays information in a multi-section layout:</p>
<p>The Run Checks page is organized by job, with each job showing its unreviewed runs:</p>
<h3>1. Job Header</h3>
<h3>1. Job List</h3>
<p>The top of the modal shows job identification:</p>
<p>The page displays jobs that have unreviewed runs:</p>
<ul>
<li><strong>Customer name</strong></li>
<li><strong>Backup software</strong> (e.g., Veeam, Synology)</li>
<li><strong>Backup type</strong> (e.g., Backup Job, Replication Job)</li>
<li><strong>Job name</strong></li>
<li><strong>Number of unreviewed runs</strong> for this job</li>
</ul>
<h3>2. Run List (Left Side)</h3>
<h3>2. Run Details per Job</h3>
<p>A scrollable list showing recent job runs:</p>
<p>When you click on a job, you see all its unreviewed runs:</p>
<ul>
<li><strong>Run timestamp:</strong> When the backup job ran</li>
<li><strong>Status badge:</strong> Success, Warning, Failed, or Missed</li>
<li><strong>Reviewed indicator:</strong> Checkmark if the run has been reviewed (Admin only)</li>
<li>Click a run in the list to view its details on the right side</li>
<li><strong>Backup objects:</strong> Individual items backed up with their statuses</li>
<li><strong>Email content:</strong> Original email body from backup software</li>
<li>Click through multiple runs for the same job to review each one</li>
</ul>
<div class="doc-callout doc-callout-info">
<strong>💡 Run List Filtering:</strong><br>
By default, the run list shows only <strong>unreviewed runs</strong> for Operators. Admins can toggle "Include reviewed" to see all runs, including those already reviewed.
<strong>💡 Review by Job:</strong><br>
Runs are grouped by job. When you mark a job as reviewed, <strong>all runs for that job</strong> are marked as reviewed simultaneously. The job then disappears from the Run Checks page. By default, only unreviewed jobs are shown. Admins can toggle "Include reviewed" to see all jobs including those already reviewed.
</div>
<h3>3. Run Details (Right Side)</h3>
<p>When you select a run from the list, the right side displays detailed information about that specific run.</p>
<h2>Run Details Sections</h2>
<h3>Status Information</h3>
@ -186,7 +184,7 @@
<li>Review the run details, backup objects, and any error messages</li>
<li>Take action if needed (create ticket, remark, or override)</li>
<li>Click the <strong>Mark as reviewed</strong> button</li>
<li>The run is immediately marked as reviewed and disappears from the Run Checks page</li>
<li>All runs for this job are immediately marked as reviewed and the job disappears from the Run Checks page</li>
</ol>
<h3>Mark as Reviewed (Bulk)</h3>
@ -194,9 +192,9 @@
<p>For efficiency, especially with successful backups:</p>
<ol>
<li>Select multiple run checkboxes in the Run Checks list</li>
<li>Select multiple job checkboxes in the Run Checks list</li>
<li>Click <strong>Mark selected as reviewed</strong> button</li>
<li>All selected runs disappear from the Run Checks page</li>
<li>All runs for all selected jobs are marked as reviewed and disappear from the Run Checks page</li>
</ol>
<p>This is particularly useful for quickly clearing successful backups that don't require investigation.</p>
@ -208,16 +206,16 @@
<h3>Unmark Reviewed (Admin Only)</h3>
<p>Admins can unmark a reviewed run if it needs to be re-investigated:</p>
<p>Admins can unmark a reviewed job if it needs to be re-investigated:</p>
<ol>
<li>Enable the "Include reviewed" toggle to show reviewed runs</li>
<li>Select a reviewed run from the list</li>
<li>Enable the "Include reviewed" toggle to show reviewed jobs</li>
<li>Select a reviewed job from the list</li>
<li>Click the <strong>Unmark reviewed</strong> button</li>
<li>The run returns to the unreviewed list</li>
<li>All runs for this job return to the unreviewed list</li>
</ol>
<p>This is useful if new information about an issue comes to light after the run was marked as reviewed.</p>
<p>This is useful if new information about an issue comes to light after the job was marked as reviewed.</p>
<div class="doc-callout doc-callout-warning">
<strong>⚠️ Admin-Only Feature:</strong><br>
@ -316,16 +314,16 @@
<ul>
<li>Verify you have <strong>Admin</strong> or <strong>Operator</strong> role</li>
<li>Successful runs don't have a "Mark as reviewed" button - they're automatically considered reviewed</li>
<li>If the button appears grayed out, refresh the page - the run may have already been reviewed</li>
<li>Check if you have permission to mark runs as reviewed (Viewers cannot perform this action)</li>
</ul>
<h3>Run List Is Empty</h3>
<ul>
<li>By default, only unreviewed runs are shown</li>
<li>Enable "Include reviewed" toggle (Admin only) to see all runs</li>
<li>If no runs appear even with "Include reviewed" enabled, the job has no recorded runs - check the Inbox to see if emails need to be approved</li>
<li>By default, only unreviewed jobs are shown</li>
<li>Enable "Include reviewed" toggle (Admin only) to see all jobs including those already reviewed</li>
<li>If no jobs appear even with "Include reviewed" enabled, there are no recorded runs for any jobs - check the Inbox to see if emails need to be approved</li>
</ul>
<h2>Next Steps</h2>

6
docs/changelog-claude.md
View File

@ -6,11 +6,11 @@ This file documents all changes made to this project via Claude Code.
### Changed
- Fixed critical inaccuracies in Backup Review documentation based on user feedback:
- **Approving Backups page**: Corrected Stage 6 to emphasize ALL runs must be marked as reviewed regardless of action taken (override/ticket/remark created), added warning callout that failing to mark as reviewed leaves runs visible with wrong status next day, corrected Stage 7 to clarify successful runs MUST also be reviewed (goal is empty Run Checks page), added bulk review functionality for efficiency, completely rewrote Complete Workflow Example to focus on Run Checks page (primary daily tool) instead of Daily Jobs, updated best practices and role-based workflows to prioritize Run Checks over Daily Jobs, added performance tips for bulk review
- **Approving Backups page**: Corrected Stage 6 to emphasize ALL runs must be marked as reviewed regardless of action taken (override/ticket/remark created), added warning callout that failing to mark as reviewed leaves runs visible with wrong status next day, corrected Stage 7 to clarify successful runs MUST also be reviewed (goal is empty Run Checks page), added bulk review functionality for efficiency, completely rewrote Complete Workflow Example to focus on Run Checks page (primary daily tool) instead of Daily Jobs, updated best practices and role-based workflows to prioritize Run Checks over Daily Jobs, added performance tips for bulk review, corrected bulk review section from "select multiple run checkboxes" to "select multiple job checkboxes" to reflect per-job review mechanism
- **Daily Jobs page**: Added blue "Success (Override)" status indicator to table showing runs treated as success due to active override, added callout clarifying Daily Jobs is for viewing schedules only and Run Checks is the primary operational tool (Daily Jobs may be deprecated in future), corrected page purpose from "primary operational dashboard" to schedule viewing tool
- **Run Checks Modal page**: Corrected overview to emphasize this is THE primary daily operational tool (not just detail modal), added callout that goal is completely empty page, corrected "Success Runs Don't Need Review" to "All Runs Must Be Reviewed" with explanation, added bulk review section (select multiple + mark all), updated status information to include blue badge for override-applied runs, changed access description from "modal" to "page"
- **Run Checks Modal page**: Corrected overview to emphasize this is THE primary daily operational tool (not just detail modal), added callout that goal is completely empty page, corrected "Success Runs Don't Need Review" to "All Runs Must Be Reviewed" with explanation, added bulk review section (select multiple + mark all), updated status information to include blue badge for override-applied runs, changed access description from "modal" to "page", removed non-existent "reviewed indicator" from page layout, corrected review mechanism from per-run to per-JOB (when marking a job as reviewed, ALL runs within that job are marked simultaneously), updated Mark as Reviewed section to clarify all runs for the job disappear together, corrected bulk review from "select multiple run checkboxes" to "select multiple job checkboxes", updated Unmark Reviewed section to reflect per-job unmarking, removed incorrect statement that successful runs are automatically reviewed, fixed troubleshooting section to remove false claim about successful runs not needing review
- **Overrides & Exceptions page**: Updated "Treat as Success" action description to show blue badge instead of green, added visual differentiation explanation (green=genuine success, blue=override applied, yellow/red=unexpected problems)
- All changes ensure documentation accurately reflects actual workflow: Run Checks is primary tool, all runs need review (including successes), blue badges indicate overrides
- All changes ensure documentation accurately reflects actual workflow: Run Checks is primary tool, all runs need review (including successes), blue badges indicate overrides, review is per-JOB not per-run
### Added
- Completed Mail & Import documentation section (4 pages):