Commit d08d7252 by sandroroux

Edited according to the comments in my review.

parent ee27f788
...@@ -369,27 +369,27 @@ Course Update ...@@ -369,27 +369,27 @@ Course Update
Litmus Litmus
------ ------
When designing email templates, it is important to test the rendered When designing email templates, it is important to test the rendered emails in a
emails in a variety of email clients to ensure there are no bugs in any variety of email clients to ensure that they render correctly. EdX uses a tool
of them. EdX uses a tool called `Litmus <http://litmus.com/>`__ that called `Litmus <http://litmus.com/>`__ for this process.
automates this process.
To begin using Litmus, follow these steps: To begin using Litmus, follow these steps:
1. Make sure that ACE is configured to use Sailthru (see instructions above). 1. Make sure that ACE is configured to use Sailthru (see instructions above).
2. Go to the `Litmus checklist page <https://litmus.com/checklist>`__ and start 2. Go to the `Litmus checklist page <https://litmus.com/checklist>`__ and start
a new checklist. a new checklist.
3. The checklist will provide you with an email address to send the test email 3. The checklist will provide you with an email address to which you will send
to. Take note of it. a test email.
4. Send an email, using management command with the `--override-recipient-email` 4. Send an email. Use one of the management commands with the
option so that it is sent to the Litmus email you got in step 3. `--override-recipient-email` flag. Use the Litmus email you got in step 3
as the flag value.
:: ::
./manage.py lms --settings devstack_docker send_recurring_nudge example.com --override-recipient-email PUT-LITMUS-ADDRESS-HERE ./manage.py lms --settings devstack_docker send_recurring_nudge example.com --override-recipient-email PUT-LITMUS-ADDRESS-HERE
Using the Browser Extenstion Using the Litmus Browser Extenstion to test emails saved as local files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Configure your devstack to use the "file_email" channel for ACE (see 1. Configure your devstack to use the "file_email" channel for ACE (see
instructions above). instructions above).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment