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

Design an email template #1208

Closed
ericronne opened this Issue Jan 5, 2017 · 23 comments

Comments

Projects
None yet
4 participants
@ericronne
Contributor

ericronne commented Jan 5, 2017

No description provided.

@ericronne ericronne self-assigned this Jan 5, 2017

@ericronne

This comment has been minimized.

Contributor

ericronne commented Jan 5, 2017

@ericronne

This comment has been minimized.

Contributor

ericronne commented Jan 20, 2017

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 3, 2017

Here's a draft, let's discuss! If we roll it out before we update the home-page design and site colors, we should adjust the colors to match the current palette.

Desktop

email-desktop-insitu

Mobile

email-mobile-insitu-resized

@hbillings

This comment has been minimized.

Member

hbillings commented Feb 6, 2017

I like this design overall for the email that a CO would get upon an admin taking action on one of their price lists. A couple of thoughts:

  • There probably should be two separate email designs, one for admins and one for COs. Admins should get "digest" style emails -- Kelly has mentioned not wanting to be overwhelmed with notifications every time someone submits a single price list for review.
  • The COs will never need to review price lists; only admins will. (This is really only relevant from a text content perspective; I think the design you have works great for this use case.)
@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 6, 2017

@hbillings is there a content sample approximating what admins would get?

@jseppi

This comment has been minimized.

Contributor

jseppi commented Feb 6, 2017

@ericronne see https://github.com/18F/calc/tree/develop/data_capture/templates/data_capture/email

approval_reminder.html, bulk_upload_failed.html, and bulk_upload_succeeded.html are emails that go to admins.

You can generate sample emails:

  1. make sure you have docker-compose up running in a terminal window
  2. open http://localhost:1080 in your web browser to view your local MailCatcher
  3. in another terminal window run docker-compose run app python manage.py send_example_emails. Your MailCatcher should get populated with versions of all the emails that CALC sends.
@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 7, 2017

Looks like we actually aren't using "digest" emails — with links to individual price lists to be reviewed. @hbillings had the thought to let the user know how many PLs they have awaiting approval. Sound useful? If so, pretty straightforward to implement @jseppi?

@jseppi

This comment has been minimized.

Contributor

jseppi commented Feb 7, 2017

We are. The "digest" is the approval_reminder.html.

The individual email notifications go to the originating CO. The approval_reminder email goes to Data Administrators on a weekly basis to remind them to review submitted price lists.

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 7, 2017

So the full list will appear in the email, in place of https://example.com/unreviewed_price_lists?

@jseppi

This comment has been minimized.

Contributor

jseppi commented Feb 7, 2017

no, there is no list, just the link to the page with the unreviewed lists.

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 7, 2017

Then what do you think about this notion?

E.g. "We notice you haven't approved five (5) submitted price lists in CALC...."

@jseppi

This comment has been minimized.

Contributor

jseppi commented Feb 7, 2017

let the user know how many PLs they have awaiting approval

We used to have that, but when we had the Writing Lab review, they struck it (ref https://github.com/18F/calc/pull/1274/files).

We can of course add it back, it's not a big code change.

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 7, 2017

Hm would be curious to hear their rationale.

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 8, 2017

@jseppi i'm dumping the various emails into the template, to ensure that i've covered all of the formatting bases.

As i go, i'm playing with some alternate verbiage, because i'm a rabble rouser. If any of it seems useful, cool. If not, shrug.

Question re the bulk-upload-error email: Do we plan to include the entire traceback in the body of the email? Any way that could live on a web page? thx!

@jseppi

This comment has been minimized.

Contributor

jseppi commented Feb 8, 2017

Sounds good!

Yes, the traceback will just be going in the email.

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 8, 2017

Are the tracebacks often long and scary looking?

@jseppi

This comment has been minimized.

Contributor

jseppi commented Feb 8, 2017

Probably

@jseppi

This comment has been minimized.

Contributor

jseppi commented Feb 8, 2017

Maybe a better solution is to email the traceback to calc@gsa.gov and leave it out of the email to the Data Administrator altogether.

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 8, 2017

nom.

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 9, 2017

Did some content mods over in #1349

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 9, 2017

Here's a version which uses the styles (i.e. logo, colors) that are currently on the live site. If we implement these templates before the overall site refresh, this is the guide …

email-old-colors--temp

And here's the sketch file.

@toolness

This comment has been minimized.

Contributor

toolness commented Feb 27, 2017

This is basically done now, right? Especially since it's been implemented by #1407?

@ericronne

This comment has been minimized.

Contributor

ericronne commented Feb 27, 2017

Yep. Will do a new issue for color and style mods to implement once the new colors and such are blown out sitewide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment