Skip to content

Notification Templates - Documentation Improvements#30

Open
Rick-Jongbloed wants to merge 17 commits into
mainfrom
feature-add-notification-examples
Open

Notification Templates - Documentation Improvements#30
Rick-Jongbloed wants to merge 17 commits into
mainfrom
feature-add-notification-examples

Conversation

@Rick-Jongbloed
Copy link
Copy Markdown
Member

Uitgebreide verbetering van alle notification template documentatie: gestandaardiseerde structuur met volledige stap-voor-stap instructies voor importeren en configureren, correcte ontvanger variabelen (manager/medewerker/applicatiebeheer), directe links naar HelloID documentatie voor from adres/variabelen/filters, pre-offboard configuratie uitleg, en klikbare notificatie links in hoofd README. Alle templates hebben nu consistente "Gebruik" secties, AD-specifieke waarschuwingen, en duidelijke instructies voor het aanpassen van fallback e-mailadressen.

</mj-section>
<mj-section background-color="#4a8fca" padding-top="0" padding-bottom="0">
<mj-column width="25%">
<mj-image src="https://customer.helloid.training/appearance/companyicon" width="50px" height="50px">
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alle image urls bevatten nog .training i.p.v. .com

@rhouthuijzen rhouthuijzen self-assigned this Feb 27, 2026
@rhouthuijzen rhouthuijzen self-requested a review February 27, 2026 14:37
@rhouthuijzen rhouthuijzen added needs-review Indicates that the PR is ready and waiting for review current-sprint PRs to be addressed within the current sprint labels Feb 27, 2026
Copy link
Copy Markdown
Contributor

@rhouthuijzen rhouthuijzen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Na overleg met BC de volgende feedback, zou je dit nog kunnen verwerken?

  • Alles behalve templates zelf in het Engels (README.md)
  • Files voorbereiden op andere talen (mogelijk IA al laten maken?) Bijvoorbeeld: templateNL.mjml en templateEN.mjml.
  • In de README van de specifieke mailtjes staat nu niet een link naar de mail zelf. Je zou verwachten een link in de README naar de mjml file. Bijvoorbeeld Mail NL: Link, Mail EN: Link
  • .training vervangen door .com. Dan hoeft de gebruiker alleen customer aan te passen

@rhouthuijzen rhouthuijzen added pending-author-update PR is waiting for the author to make necessary modifications or updates and removed needs-review Indicates that the PR is ready and waiting for review labels Mar 9, 2026
@Rick-Jongbloed
Copy link
Copy Markdown
Member Author

wijzigingen doorgevoerd:

Changelog - Notifications Templates & Documentation

Overview

Compleet overhaul van alle notificatie templates en documentatie op basis van PR feedback.


1. Documentation Translation (README Files)

Vertaald naar Engels:

  • Notifications/README.md - Main overview
  • Notifications/create/01-manager-account-details/README.md
  • Notifications/create/02-manager-account-password/README.md
  • Notifications/create/03-applicatiebeheer-nieuwe-medewerker/README.md
  • Notifications/disable/01-uitdienst-applicatiebeheer/README.md
  • Notifications/enable/01-welkom-medewerker/README.md
  • Notifications/enable/02-welkom-medewerker-sspr/README.md
  • Notifications/pre-offboard/01-reminder-uitdienst-manager/README.md
  • Notifications/update/01-afdelingswijziging-applicatiebeheer/README.md

Change: Alle Nederlandse teksten verwijderd, volledig naar Engels vertaald.


2. Template File Links

Alle README files voorzien van directe links naar templates

  • Toegevoegd: [template_nl.mjml](template_nl.mjml) - Dutch version
  • Toegevoegd: [template_en.mjml](template_en.mjml) - English version

Impact: Beheerders kunnen nu direct naar de correcte template links klikken in de README.


3. URL Updates

Domain aanpassingen in alle MJML templates

  • Change: https://customer.helloid.training/...https://customer.helloid.com/...
  • Scope: Alle 16 template files (8 folders × 2 talen)
  • Voordeel: Gebruikers hoeven alleen customer aan te passen, niet de hele URL

4. Template Content Fixes

enable/01-welkom-medewerker

  • Was: Bevatte SSPR-instructies (wachtwoord via self-service reset)
  • Nu: Versimpeld tot basis welcome met info dat wachtwoord van manager wordt ontvangen
  • Files: template_nl.mjml en template_en.mjml
  • Reden: Duidelijk onderscheid met variant 02 (SSPR)

enable/02-welkom-medewerker-sspr

  • Verwijderd: Misleidende regel "This email provides you with some practical tips..."
  • Reden: Geen concrete tips in het originele template
  • Files: template_nl.mjml en template_en.mjml

5. Layout Standardization

Dubbele Closing Tags Fix

  • enable/01-welkom-medewerker: Verwijderd dubbele </mj-body> en </mjml> tags
  • Files: template_nl.mjml en template_en.mjml

Footer Sections Consistent Width

  • Toegevoegd: width="100%" aan alle <mj-column> in footer secties
  • Gestandaardiseerde files:
    • enable/01-welkom-medewerker (both)
    • enable/02-welkom-medewerker-sspr (both)
    • update/01-afdelingswijziging-applicatiebeheer (both)
    • pre-offboard/01-reminder-uitdienst-manager (both)
    • disable/01-uitdienst-applicatiebeheer (both)
  • Voordeel: Alle templates hebben nu dezelfde visuele layout

6. Onboarding Tips Section

Toegevoegd aan welcome emails

  • enable/01-welkom-medewerker:

    • NL: In deze e-mail vind je enkele praktische tips om goed van start te gaan:\n[AANPASSEN: Voeg hier uw onboardinginformatie in]
    • EN: This email contains some practical tips to help you get started:\n[CUSTOMIZE: Add your onboarding information here]
  • enable/02-welkom-medewerker-sspr:

    • NL: Hier zijn nog enkele praktische tips om goed van start te gaan:\n[AANPASSEN: Voeg hier uw onboardinginformatie in]
    • EN: Here are some practical tips to help you get started:\n[CUSTOMIZE: Add your onboarding information here]

Impact: Beheerders hebben nu duidelijke instructie waar ze onboarding info moeten toevoegen.


Summary of Changes by File

Files Modified: 24 total

README Files (9 files):

  • All translated to English, Dutch text removed, template links added

MJML Templates (16 files):

  • create/01-manager-account-details: URL fix + footer standardization
  • create/02-manager-account-password: URL fix + footer standardization
  • create/03-applicatiebeheer-nieuwe-medewerker: URL fix + footer standardization
  • disable/01-uitdienst-applicatiebeheer: URL fix + footer standardization
  • enable/01-welkom-medewerker: Complete rewrite (simplified), duplicate tags removed, onboarding section added
  • enable/02-welkom-medewerker-sspr: Removed misleading text, onboarding section added
  • pre-offboard/01-reminder-uitdienst-manager: URL fix + footer standardization
  • update/01-afdelingswijziging-applicatiebeheer: URL fix + footer standardization

Files Kept Unchanged

  • All template MJML structure intact
  • Variable placeholders maintained
  • Email content (except noted changes) preserved

Testing Recommendations

  1. Email Rendering: Test all 16 templates in email client
  2. Variable Substitution: Verify all {{variables}} render correctly
  3. Link Functionality: Test [CUSTOMIZE] section replacement examples
  4. Documentation: Verify README links work correctly in GitHub/GitLab

Migration Notes

  • ✅ All Dutch documentation migrated to English
  • ✅ Multilingual template support (template_nl.mjml + template_en.mjml) in all 8 folders
  • ✅ Customer domain customization simplified (.training → .com)
  • ✅ Layout consistency across all notifications
  • ✅ Clear customization guidance for administrators

graag volledige nieuwe review doen :-)

Co-authored-by: Copilot <copilot@github.com>
@rhouthuijzen rhouthuijzen added needs-review Indicates that the PR is ready and waiting for review and removed pending-author-update PR is waiting for the author to make necessary modifications or updates labels May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

current-sprint PRs to be addressed within the current sprint needs-review Indicates that the PR is ready and waiting for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants