diff --git a/TODO-documentation.md b/TODO-documentation.md index 6aaa341..0ee07ea 100644 --- a/TODO-documentation.md +++ b/TODO-documentation.md @@ -3,7 +3,177 @@ **Branch:** `v20260207-02-wiki-documentation` **Date Started:** 2026-02-07 **Date Updated:** 2026-02-08 (Latest: Per-job review corrections) -**Status:** In Progress - 19 of 33 pages complete (58%) +**Status:** Review Required - full documentation verification against current UI/flows + +--- + +## โœ… Validation Update (2026-03-26) + +This TODO was re-checked against the current codebase and documentation templates. + +Findings: +- The progress metrics in this file are outdated (`19/33`) and no longer reflect the repository state. +- The documentation template tree currently contains **39 files** under `containers/backupchecks/src/templates/documentation`. +- Because the app layout and multiple workflows changed after the original documentation wave, **all documentation pages require content review** for functional correctness (not only layout styling). + +Decision: +- Keep this TODO active. +- Treat this as a full documentation audit task: verify each page against current UI/routes/behavior and update screenshots/text where needed. + +--- + +## ๐Ÿงพ Review Checklist (2026-03-26) + +Gebruik deze lijst voor de volledige inhoudsreview tegen de huidige applicatie. + +**Legenda** +- `P1` = hoge prioriteit (kritieke workflows / grootste kans op afwijkingen) +- `P2` = normale prioriteit +- `P3` = lage prioriteit + +### Global checks (voor elke pagina) +- [ ] Route, paginatitel en navigatiepad kloppen met huidige UI +- [ ] Terminologie klopt met huidige labels/knoppen in de app +- [ ] Screenshots zijn actueel (nieuwe layout) of vervangen/verwijderd +- [ ] Tekst verwijst niet naar verwijderde/gewijzigde functies +- [ ] Role-based behavior (admin/operator/viewer/reporter) klopt + +### Missing documentation topics (new pages required) +- [x] `[P1]` Cove Accounts + Cove run detail flow documenteren +- [x] `[P1]` Veeam Cloud Connect accounts/run flow documenteren +- [x] `[P1]` Run Checks Autotask "Link existing" gedrag updaten (incl. cross-company) +- [ ] `[P1]` Sidebar layout v2 consistent door alle docs verwerken + +### Page-by-page review +#### Getting Started +- [ ] `[P2]` getting-started/what-is-backupchecks +- [ ] `[P2]` getting-started/first-login +- [ ] `[P2]` getting-started/quick-start + +#### User Management +- [ ] `[P2]` users/users-and-roles +- [ ] `[P2]` users/login-authentication +- [ ] `[P2]` users/profile-settings + +#### Customers & Jobs +- [ ] `[P2]` customers-jobs/managing-customers +- [ ] `[P2]` customers-jobs/configuring-jobs +- [ ] `[P2]` customers-jobs/approved-jobs +- [ ] `[P2]` customers-jobs/job-schedules + +#### Mail & Import +- [ ] `[P1]` mail-import/setup +- [ ] `[P1]` mail-import/inbox-management +- [ ] `[P1]` mail-import/mail-parsing +- [ ] `[P1]` mail-import/auto-import + +#### Backup Review +- [ ] `[P1]` backup-review/approving-backups +- [ ] `[P1]` backup-review/daily-jobs +- [ ] `[P1]` backup-review/run-checks-modal +- [ ] `[P1]` backup-review/overrides +- [ ] `[P1]` backup-review/remarks-tickets + +#### Reports +- [ ] `[P1]` reports/creating-reports +- [ ] `[P1]` reports/relative-periods +- [ ] `[P1]` reports/scheduling +- [ ] `[P1]` reports/exporting-data + +#### Autotask Integration +- [x] `[P1]` autotask/setup-configuration +- [x] `[P1]` autotask/company-mapping +- [x] `[P1]` autotask/creating-tickets +- [x] `[P1]` autotask/ticket-management + +#### Settings +- [x] `[P1]` settings/general +- [x] `[P1]` settings/mail-configuration +- [x] `[P1]` settings/autotask-integration +- [x] `[P1]` settings/entra-sso +- [x] `[P1]` settings/reporting-settings +- [x] `[P1]` settings/user-management +- [x] `[P1]` settings/maintenance + +#### Troubleshooting +- [ ] `[P2]` troubleshooting/common-issues +- [ ] `[P2]` troubleshooting/faq +- [ ] `[P2]` troubleshooting/support-contact + +--- + +## ๐Ÿ”Ž Batch 1 Findings (P1) โ€” 2026-03-26 + +### A. Immediate correctness fixes (existing content) +- [x] `documentation/backup-review/daily-jobs.html` + - Remove/replace incorrect claim that successful jobs are automatically reviewed. + - Align workflow text with current behavior: review is handled via Run Checks job-level review. +- [x] `documentation/backup-review/approving-backups.html` + - Replace wording "select multiple runs" with "select multiple jobs" where bulk review is described. + - Re-verify Daily Jobs vs Run Checks role split text for current operational flow. +- [x] `documentation/backup-review/run-checks-modal.html` + - Fix broken cross-link: `url_for('documentation.page', section='autotask', page='overview')` does not exist. + - Replace with valid links to existing Autotask pages. +- [x] `documentation/backup-review/remarks-tickets.html` + - Fix same broken `autotask/overview` link. + - Re-check Autotask behavior section against current link-existing/create/resolve-note flow. + +### B. Placeholder pages that require full rewrite (currently "Coming Soon") +- [ ] `documentation/reports/creating-reports.html` +- [ ] `documentation/reports/relative-periods.html` +- [ ] `documentation/reports/scheduling.html` +- [ ] `documentation/reports/exporting-data.html` +- [x] `documentation/autotask/setup-configuration.html` +- [x] `documentation/autotask/company-mapping.html` +- [x] `documentation/autotask/creating-tickets.html` +- [x] `documentation/autotask/ticket-management.html` +- [x] `documentation/settings/general.html` +- [x] `documentation/settings/mail-configuration.html` +- [x] `documentation/settings/autotask-integration.html` +- [x] `documentation/settings/reporting-settings.html` +- [x] `documentation/settings/user-management.html` +- [x] `documentation/settings/maintenance.html` + +### C. Pages with content present but requiring targeted re-validation +- [x] `documentation/settings/entra-sso.html` + - Verify navigation path labels (Integrations wording/layout) against current settings UI. + - Keep untested warning unless production validation has been completed. +- [ ] `documentation/mail-import/setup.html` + - Re-check exact settings navigation wording and folder-browser flow against current UI labels. +- [ ] `documentation/mail-import/auto-import.html` + - Re-check references to Logging page path/wording and Imports section labels. + +--- + +## ๐Ÿ”Ž Batch 2 Findings (P1) โ€” 2026-03-26 (Completed) + +### A. Autotask docs rewritten from placeholders +- [x] `documentation/autotask/setup-configuration.html` +- [x] `documentation/autotask/company-mapping.html` +- [x] `documentation/autotask/creating-tickets.html` +- [x] `documentation/autotask/ticket-management.html` + +### B. Autotask behavior alignment fixes +- [x] Documented `Link existing` cross-company behavior for shared/umbrella tickets. +- [x] Removed references to non-existent `autotask/overview` page and replaced broken links. +- [x] Re-validated ticket lifecycle notes (create/link/resolve note) against current Run Checks behavior. + +--- + +## ๐Ÿ”Ž Batch 3 Findings (P1) โ€” 2026-03-26 (Completed) + +### A. Settings docs rewritten from placeholders +- [x] `documentation/settings/general.html` +- [x] `documentation/settings/mail-configuration.html` +- [x] `documentation/settings/autotask-integration.html` +- [x] `documentation/settings/reporting-settings.html` +- [x] `documentation/settings/user-management.html` +- [x] `documentation/settings/maintenance.html` + +### B. Settings content alignment notes +- [x] Re-validated `documentation/settings/entra-sso.html` against current Settings -> Integrations navigation and field names. +- [x] Reporting page updated to explicitly document current status: no dedicated Reporting settings card is available in Settings. +- [x] Removed all placeholder text from Settings documentation pages. --- @@ -67,17 +237,17 @@ ### Remaining Work ๐Ÿšง -**Phase 4: Advanced Features (0/14 pages - PLACEHOLDER)** +**Phase 4: Advanced Features (10/14 pages complete)** - Reports (0/4 pages) -- Autotask Integration (0/4 pages) -- Settings (0/6 pages) +- Autotask Integration (4/4 pages - COMPLETE) +- Settings (6/6 pages - COMPLETE) - Troubleshooting (0/3 pages) **Progress Summary:** -- โœ… 19 of 33 pages complete (58%) -- โœ… 10 screenshots added -- โœ… All completed pages reviewed and corrected based on actual UI -- โณ 14 pages remaining (placeholders created) +- โœ… Batch 1 documentation updates completed (Integrations + critical Run Checks wording/link fixes). +- โœ… Batch 2 documentation updates completed (Autotask section rewritten and aligned with current behavior). +- โœ… Batch 3 documentation updates completed (Settings section rewritten and revalidated). +- โณ Remaining focus: Mail Import re-validation pages, Troubleshooting pages, and final Sidebar Layout v2 consistency pass. --- diff --git a/TODO-notification-system.md b/TODO-notification-system.md index 52d6c6d..9f306ae 100644 --- a/TODO-notification-system.md +++ b/TODO-notification-system.md @@ -6,6 +6,18 @@ --- +## โœ… Validation Update (2026-03-26) + +Status re-checked against current codebase: this TODO is still open and not implemented yet. + +Confirmed as NOT present: +- `operator_notifications` table/model +- Notification inbox routes/UI (e.g. `/notifications`) +- Notification lifecycle audit events (`notification_created`, `notification_read`, `notification_handled`) +- Dedicated mailbox alias ingestion flow for `backups+notification@...` + +--- + ## ๐ŸŽฏ Goal Maak een notificatieflow waarbij collega's een email sturen naar `backups+notification@...`, waarna Backupchecks deze berichten ophaalt en de operator informeert in de applicatie (optioneel ook via email). diff --git a/TODO-reports-improvements.md b/TODO-reports-improvements.md index 08cdfd9..46602b9 100644 --- a/TODO-reports-improvements.md +++ b/TODO-reports-improvements.md @@ -6,6 +6,20 @@ --- +## โœ… Validation Update (2026-03-26) + +Status re-checked against current codebase: this TODO is still open and largely not implemented yet. + +Confirmed as NOT present (core planned scope): +- Reporting settings extension in Settings (`reporting_*` fields, branding/email configuration) +- Relative period engine (`period_type`, `relative_period`, timezone-aware calculator) +- Report model extensions for scheduling metadata and per-report email template fields +- Scheduling execution/retry flow for automatic report delivery + +Note: only small earlier UI items at the top of this TODO appear completed; the main roadmap sections remain open. + +--- + ## โœ… Wat is al gedaan - โœ… Scheduling placeholder verwijderd van reports overview pagina (reports.html) diff --git a/containers/backupchecks/src/backend/app/main/routes_documentation.py b/containers/backupchecks/src/backend/app/main/routes_documentation.py index 718f9b6..60afd29 100644 --- a/containers/backupchecks/src/backend/app/main/routes_documentation.py +++ b/containers/backupchecks/src/backend/app/main/routes_documentation.py @@ -51,6 +51,14 @@ DOCUMENTATION_STRUCTURE = { {'slug': 'auto-import', 'title': 'Auto-Import Configuration'}, ] }, + 'integrations': { + 'title': 'Integrations', + 'icon': '๐Ÿ”Œ', + 'pages': [ + {'slug': 'cove-data-protection', 'title': 'Cove Data Protection'}, + {'slug': 'veeam-cloud-connect', 'title': 'Veeam Cloud Connect'}, + ] + }, 'backup-review': { 'title': 'Backup Review', 'icon': 'โœ…', diff --git a/containers/backupchecks/src/templates/documentation/autotask/company-mapping.html b/containers/backupchecks/src/templates/documentation/autotask/company-mapping.html index 21cc65c..9865172 100644 --- a/containers/backupchecks/src/templates/documentation/autotask/company-mapping.html +++ b/containers/backupchecks/src/templates/documentation/autotask/company-mapping.html @@ -4,16 +4,65 @@

Company Mapping

- Map customers to Autotask companies. + Map each Backupchecks customer to the correct Autotask company.

-
- ๐Ÿ“ Coming Soon: - This page is under construction. Full content will be added in a future update. +
+ Required for Autotask actions:
+ Creating or linking Autotask tickets from Run Checks requires a valid customer mapping status.
-

Content

+

Where to Manage Mappings

-

Detailed content will be added here in a future update.

+
    +
  1. Open Customers.
  2. +
  3. Use Edit on a customer.
  4. +
  5. In the Autotask mapping section: +
      +
    • Search Autotask companies
    • +
    • Select result
    • +
    • Set mapping / Refresh status / Clear mapping
    • +
    +
  6. +
+

Mapping Status Values

+ + + +

Refresh Operations

+ + + +

Import/Export Behavior

+ + + +

Troubleshooting

+ + + +

Next Steps

+ + {% endblock %} diff --git a/containers/backupchecks/src/templates/documentation/autotask/creating-tickets.html b/containers/backupchecks/src/templates/documentation/autotask/creating-tickets.html index 5aee350..3d042e5 100644 --- a/containers/backupchecks/src/templates/documentation/autotask/creating-tickets.html +++ b/containers/backupchecks/src/templates/documentation/autotask/creating-tickets.html @@ -4,16 +4,63 @@

Creating Tickets

- Manually create tickets for failed backups. + Use Run Checks to create new Autotask tickets or link existing ones to active runs.

- ๐Ÿ“ Coming Soon: - This page is under construction. Full content will be added in a future update. + Where:
+ Ticket actions are available in the Run Checks modal for admin/operator roles.
-

Content

+

Before You Start

-

Detailed content will be added here in a future update.

+ +

Create New Ticket

+ +
    +
  1. Open Run Checks and select a run.
  2. +
  3. Click Create (or Create new when previous linked ticket is resolved/deleted).
  4. +
  5. Backupchecks creates ticket using configured queue/source/status/priority defaults.
  6. +
  7. Ticket info is stored on the run and visible in the modal.
  8. +
+ +

Link Existing Ticket

+ +
    +
  1. Click Link existing.
  2. +
  3. Search tickets by title/number.
  4. +
  5. Select and confirm Link.
  6. +
+ +

Behavior:

+ + +

Internal Ticket Relationship

+ +

When Autotask tickets are created/linked, Backupchecks also keeps internal ticket linkage for consistent indicators and history behavior.

+ +

Troubleshooting

+ + + +

Next Steps

+ + {% endblock %} diff --git a/containers/backupchecks/src/templates/documentation/autotask/setup-configuration.html b/containers/backupchecks/src/templates/documentation/autotask/setup-configuration.html index 68c4fc9..c50675d 100644 --- a/containers/backupchecks/src/templates/documentation/autotask/setup-configuration.html +++ b/containers/backupchecks/src/templates/documentation/autotask/setup-configuration.html @@ -4,16 +4,66 @@

Setup & Configuration

- Configure Autotask PSA integration. + Configure Autotask PSA integration so operators can create and link PSA tickets from Run Checks.

- ๐Ÿ“ Coming Soon: - This page is under construction. Full content will be added in a future update. + Scope:
+ This page covers technical setup in Backupchecks Settings. Customer-to-company mapping is documented separately.
-

Content

+

Prerequisites

-

Detailed content will be added here in a future update.

+ +

Step 1: Enable Integration

+ +
    +
  1. Open Settings.
  2. +
  3. In the Autotask section, enable integration.
  4. +
  5. Select environment (production or sandbox).
  6. +
  7. Fill in username, password, and tracking identifier.
  8. +
  9. Optional: set Autotask Base URL for links in notes/details.
  10. +
+ +

Step 2: Configure Ticket Defaults

+ +

Backupchecks ticket creation needs default values from Autotask reference data.

+ + + +

Use the reference-data refresh action if dropdowns are empty.

+ +

Step 3: Validate Connection

+ +
    +
  1. Use the Test connection action in settings.
  2. +
  3. Confirm the API call succeeds.
  4. +
  5. If test fails, re-check credentials, environment, and integration code.
  6. +
+ +

Operational Notes

+ + + +

Next Steps

+ + {% endblock %} diff --git a/containers/backupchecks/src/templates/documentation/autotask/ticket-management.html b/containers/backupchecks/src/templates/documentation/autotask/ticket-management.html index ee3bbff..4a7afec 100644 --- a/containers/backupchecks/src/templates/documentation/autotask/ticket-management.html +++ b/containers/backupchecks/src/templates/documentation/autotask/ticket-management.html @@ -4,16 +4,61 @@

Ticket Management

- Manage and track Autotask tickets. + Understand ticket lifecycle, synchronization behavior, and operator actions after linking.

-
- ๐Ÿ“ Coming Soon: - This page is under construction. Full content will be added in a future update. -
+

Lifecycle in Run Checks

-

Content

+ -

Detailed content will be added here in a future update.

+

Resolve Note Action

+
    +
  1. In Run Checks modal, click Resolve on Autotask ticket section.
  2. +
  3. Backupchecks posts a user-visible update note to the PSA ticket.
  4. +
  5. If ticket has no time entries, Autotask can close it; otherwise it may stay open.
  6. +
+ +

Propagation and Scope

+ + + +

Deleted vs Resolved

+ + + +

Operational Best Practices

+ + + +

Troubleshooting

+ + + +

See Also

+ + {% endblock %} diff --git a/containers/backupchecks/src/templates/documentation/backup-review/approving-backups.html b/containers/backupchecks/src/templates/documentation/backup-review/approving-backups.html index c79d3df..f0bf6d8 100644 --- a/containers/backupchecks/src/templates/documentation/backup-review/approving-backups.html +++ b/containers/backupchecks/src/templates/documentation/backup-review/approving-backups.html @@ -207,7 +207,7 @@
โš ๏ธ Always Mark as Reviewed:
- Regardless of which action you take (override, remark, or ticket), you must always mark the run as reviewed afterwards. If you don't, the run will remain in the Run Checks list and can show the wrong status the next day (only the first unreviewed status is displayed). + Regardless of which action you take (override, remark, or ticket), you must always mark the job as reviewed afterwards. If you don't, the run will remain in the Run Checks list and can show the wrong status the next day (only the first unreviewed status is displayed).

Stage 7: Mark as Reviewed

@@ -217,7 +217,7 @@

What Happens