[Draft] Email improvements #12811
Draft
[Draft] Email improvements #12811
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drummer83
added
pr-staged-au
User the sites main logo instead of footer logo to allow for better contrast on gray background (dark text on gray instead of white text on gray) Limit the max width and max height of the logo and resize the logo accordingly instead of forcing it to squeeze into a fixed size Update specs
Use wrap style full width background like header Move 'Powered by...' message to footer and rephrase to suit all recipients (not shoppers only) Always show link to openfoodnetwork.org instead of email (if present) because email will be available via icon in the row below now Add social media buttons of instance to email footer Make footer text and icons dark gray (as instance name in email header)
drummer83
force-pushed
the
email_PR2
branch
from
83dabaa
to
932596f
Compare
Reduces the effort to maintain emails.
White labelling added for Order: cancellation email, Order: invoice email, Shipment: shipped email, Subscriptions: authorize payment email, Subscriptions: placement email, Subscriptions: empty order email, Subscriptions: failed payment email White labelling existed already for Order: confirmation email, Subscriptions: order confirmation email
… in ALL emails Adjust maximum size of logo and improve responsive behaviour on small screens (display logo centered and above text)
Remaining translation keys for emails will be re-organized in a separate commit
Remaining translation keys for emails will be re-organized in a separate commit
Remaining translation keys for emails will be re-organized in a separate commit
Remaining translation keys for emails will be re-organized in a separate commit
…n keys Remaining translation keys for emails will be re-organized in a separate commit
Remaining translation keys for emails will be re-organized in a separate commit
Remaining translation keys for emails will be re-organized in a separate commit
Remaining translation keys for emails will be re-organized in a separate commit
…ion keys Remaining translation keys for emails will be re-organized in a separate commit
Shared keys are used for greetings, signoffs, order confirmation string (incl. order number), contact distributor note and order edit note Remaining translation keys for emails will be re-organized in a separate commit
To do so the shipment mailer and payment mailers need to know the @order Remove the 'callout' class from distributor signoff for uniformity and to keep the callout available for call to actions only Remaining translation keys for emails will be re-organized in a separate commit
…ation email as an enterprise manager The 'invite manager' functionality was introduced in openfoodfoundation#2189. I searched for a decision to not use the 'set a password' text, but couldn't find one. So I assume it was forgotten. In my opinion it actually makes sense to have this information added.
…ucture follow the file structure and enable more lazy lookup throughout the files. After re-arranging the locale file, the keys in the code needed to be adapted accordingly.
…e to follow the conventions
Some subjects had a prefix (e.g. [Instance]), some subjects were misleading (e.g. failed payment email had 'Order Confirmation', some can be clearer by adding information like order number, distributor or coordinator
The mail was sent in the customer's language, but it should be sent in the shop owner's language
The method is used only once and therefore not required
Signup confirmation email: Remove text 'Use send feedback button' (because it doesn't exist) Reset password instructions email: Use link label instead of raw link (more common these days) and remove corresponding text 'Copy & paste the link'
Move order summary table to a shared folder to use it in other mailers as well, e.g. shipment mailer. Don't see reason to use fixed width of 25 % for price column in order summary table. Introduce class 'subsection' to allow for easier styling of shipping/pick-up information and special customer instructions (notes during checkout). Introduce class 'detail' to allow styling of the payments list in emails without affecting the payments list in invoices. Display section 'Payment method description' only if there is a description available. Order confirmation email for shop: Add customer info headline and rearrange customer info Order cancellation email for shop: Add distributor to intro. Add order summary table (I think this can be useful in case of cancellations.) Invoice email: Add order number to intro Order cancellation email: Rephrase wording
Replace simple table with proper order summary table. This requires the checkout_helper. Add order number to email content
Authorization required mail (to shop): Add order summary table to email. Authorize payment email (to customer): Add order summary table to email. The order summary tables require the checkout_helper in the payment_mailer.rb. Add 'Order summary' string to shared strings, because this will be needed in the order placement mailer for subscriptions as well (instead of 'Order confirmation'). The rest are styling and wording improvements.
All customer facing mails: Rephrase wording regarding contact email. Order placement email: Replace 'Order confirmation' with 'Order summary' because the order is confirmed when the order cycle closes. The rest are styling and wording improvements.
Make messages with required user action callouts (light blue boxes), i.e. 'How to find the admin area' and 'Contact Enterprise XYZ if you don't know why you are invited to be a manager'. Extend the 'How to find the admin area' text to small screens but recommend using large screens at the same time.
Slightly rephrase wording regarding download link and expiry. Make text and link for download a callout (light blue box).
Adjust styling (added h4) to order summary table in order confirmation email etc. Add 'Total:' to last row of table and make the last row bold.
…nd less bold formatting
drummer83
force-pushed
the
email_PR2
branch
from
932596f
to
4246662
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What? Why?
What should we test?
Release notes
Changelog Category (reviewers may add a label for the release notes):
The title of the pull request will be included in the release notes.
Dependencies
Documentation updates