Skip to content

Commit

Permalink
Update changes_to_existing_notify_templates.md (#1314)
Browse files Browse the repository at this point in the history
  • Loading branch information
acsauk authored Jun 27, 2024
1 parent bfc9b6c commit b09a681
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/runbooks/changes_to_existing_notify_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@

Email and SMS notifications are sent via [GOV.UK Notify](https://www.notifications.service.gov.uk). If a change to an existing template involves removing or adding a personalisation variable we should take a staged approach to making the change to avoid missing personalisation error responses from Notify in production or ephemeral environments.

- Ensure you are viewing the `Office of the Public Guardian` (visible in top left). If not, click `Switch service` in top right and select `Office of the Public Guardian`
- Click `Templates` and find the existing template in `Modernising LPA -> Live`
- Copy the existing template in Notify:
- `Templates -> New Template -> Copy an existing template`
- Make required changes, move the template to a suitable folder and copy the new template ID
- `New Template -> Copy an existing template`
- Make required changes, move the template to `Modernising LPA -> Staging` and copy the new template ID
- Update the [template ID](../../internal/notify/client.go) in code as part of the PR
- Merge the PR
- Remove the old template from Notify
- Move the template from `Modernising LPA -> Staging` to `Modernising LPA -> Live`

This process should be followed in both `OPG Test` and `Office of the Public Guardian` Notify services.

If there is an existing template in the `OPG Test` Notify service that needs to be duplicated you can make a copy of it directly by switching to the `Office of the Public Guardian` Notify service and then following the steps above but selecting the template from `OPG Test` when choosing `Copy an existing template`.

If there is an existing template in the OPG Test Notify account that needs to be duplicated you can make a copy of it directly in to the Office of the Public Guardian account by switching to the Office of the Public Guardian account and then following the steps above but selecting the template from OPG Test when choosing `Copy an existing template`.

This process should be followed in both OPG Test and Office of the Public Guardian Notify accounts.

0 comments on commit b09a681

Please sign in to comment.