Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update suspension and unlock email text #2381

Merged
merged 6 commits into from
Sep 29, 2023
Merged

Update suspension and unlock email text #2381

merged 6 commits into from
Sep 29, 2023

Conversation

chrislo
Copy link
Contributor

@chrislo chrislo commented Sep 27, 2023

Trello: https://trello.com/c/0oTag1bi

This PR updates the content of the suspension reminder, suspension notification and unlock instruction emails following some user research we did on their content.

We've done some user-testing of our email subject lines and users
generally preferred to see the environment name in all cases, even in
the production environment.

I've had to make a small change to the NoisyBatchInvitationTest as it
was also partially testing the subject as well as the email from
address. Changing the email from address is out of scope for this bit
of work.
Our user testing indicated that users find it less
confusing (particularly when they have production and integration
signon accounts) to have the environment name in this text.
Trello: https://trello.com/c/0oTag1bi

We've done some testing of this email and come up with this updated
content.

Notify, which we use to send emails, has limited markdown
support[1]. I've used the heading markup for "How to stop suspension",
and the `^` to call out the "please do not reply to this email".

[1] https://www.notifications.service.gov.uk/using-notify/formatting
Trello: https://trello.com/c/0oTag1bi

We've done some testing of this email and come up with this updated
content.

Notify, which we use to send emails, has limited markdown support[1],
notably it only supports two levels of heading. I've used the
second-level heading markup for "How to reactive your account" and "If
you're a managing editor or user manager". I've also used the the `^`
to call out the "please do not reply to this email".

[1] https://www.notifications.service.gov.uk/using-notify/formatting
Trello: https://trello.com/c/0oTag1bi

We've done some testing of this email and come up with this updated
content.

Notify, which we use to send emails, has limited markdown support[1],
notably it only supports two levels of heading. I've used the
second-level heading markup for "What happens now" and "If
you're not a managing editor or user manager".

[1] https://www.notifications.service.gov.uk/using-notify/formatting
@chrislo chrislo marked this pull request as ready for review September 28, 2023 15:37
@floehopper floehopper self-assigned this Sep 28, 2023
Copy link
Contributor

@floehopper floehopper left a comment

Choose a reason for hiding this comment

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

I've added a couple of minor comments, but otherwise this looks good to me! 👍

I think it would be good to make the User.unlock_in change before merging unless I've misunderstood that bit of code, but I'm happy to leave that to your discretion.

As an aside, I note that we have Devise's unlock_strategry set to :both and my reading of the docs is that the idea of sending them the email is to give them the opportunity to unlock their own account (presumably legitimized by the fact they must have access to their email account to see the email). However, we don't seem to include a link to allow the user to unlock their own account. I think it would be interesting to understand whether not including the link was intentional and/or whether it's even sensible. Perhaps adding such a link in the email would be a simple way to reduce load on the Content 2nd Line Support team...?

app/mailers/user_mailer.rb Outdated Show resolved Hide resolved
test/models/user_mailer_test.rb Outdated Show resolved Hide resolved
This matches the new content design. We've decided to replace the
magic number `1.hour` in the test with the relevant variable
`User.unlock_in` defined in `config/initializers/devise.rb` since this
is what determines the unlock time and we don't want the two to get
out of sync.
@chrislo
Copy link
Contributor Author

chrislo commented Sep 29, 2023

I've captured the suggestion to allow users to unlock themselves in this trello card.

@chrislo chrislo merged commit 4fb3d71 into main Sep 29, 2023
6 checks passed
@chrislo chrislo deleted the update-email-text branch September 29, 2023 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants