Skip to content

Commit

Permalink
Add documentation for email drafts
Browse files Browse the repository at this point in the history
  • Loading branch information
@dongilbert
dongilbert committed Nov 18, 2024
1 parent 64d113d commit 92c010a
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
# Created by https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
# Edit at https://www.toptal.com/developers/gitignore?templates=python,jupyternotebooks

### PHPStorm ###
.idea

### Mac OS ###
.DS_Store

### JupyterNotebooks ###
# gitignore template for Jupyter Notebooks
# website: http://jupyter.org/
Expand Down
31 changes: 31 additions & 0 deletions docs/channels/emails.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,37 @@ This isn't required, but if you want to be able to select the Contacts with boun

.. vale off
Email Drafts
************

.. vale on
Creating a Draft Email

Check warning on line 373 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Headings] 'Creating a Draft Email' should use sentence-style capitalization.

Raw Output:
{"message": "[Google.Headings] 'Creating a Draft Email' should use sentence-style capitalization.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 373, "column": 1}}}, "severity": "WARNING"}
======================

Email drafts can be created using the "Save as Draft" button in the email editor. This button is available when email drafts are enabled via the configuration parameter `email_draft_enabled`.

Check warning on line 376 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be created').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be created').", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 376, "column": 18}}}, "severity": "INFO"}

Check warning on line 376 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 376, "column": 69}}}, "severity": "INFO"}

Check warning on line 376 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 376, "column": 113}}}, "severity": "INFO"}

Check warning on line 376 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are enabled').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are enabled').", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 376, "column": 126}}}, "severity": "INFO"}

Check failure on line 376 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'email_draft_enabled'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'email_draft_enabled'?", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 376, "column": 171}}}, "severity": "ERROR"}

.. image:: images/emails/save-draft.png
:width: 400
:alt: Screenshot showing the "Save as Draft" button on the email edit page.

Only one draft at a time can exist for any given email. When a draft is created, the "Save as Draft" button is replaced by two buttons, "Apply Draft" and "Discard Draft".

.. image:: images/emails/apply-draft.png
:width: 400
:alt: Screenshot showing the "Apply Draft" and "Discard Draft" buttons on the email edit page.

Check warning on line 386 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 386, "column": 81}}}, "severity": "INFO"}

Check warning on line 386 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 386, "column": 92}}}, "severity": "INFO"}

An email draft allows changes to the content of the email only. Changes to the Subject, Internal Name, selected Segment, etc will apply to the original email even when editing a draft version of it. The draft content is all that is saved separately from the original email.

Check warning on line 388 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 388, "column": 4}}}, "severity": "INFO"}

Check warning on line 388 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 388, "column": 126}}}, "severity": "WARNING"}

Check warning on line 388 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Contractions] Feel free to use 'that's' instead of 'that is'.

Raw Output:
{"message": "[Google.Contractions] Feel free to use 'that's' instead of 'that is'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 388, "column": 225}}}, "severity": "INFO"}

Previewing a Draft Email
========================

An email draft may be previewed by appending `/draft` to the end of the email preview URL. If an email has a draft version, a Draft Preview URL will be present on the email details page below the regular Preview Url.

Check failure on line 393 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'URL' instead of 'Url'.

Raw Output:
{"message": "[Vale.Terms] Use 'URL' instead of 'Url'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 393, "column": 213}}}, "severity": "ERROR"}

.. image:: images/emails/preview-draft.png
:width: 400
:alt: Screenshot showing the Preview Draft URL link on the email edit page.

Troubleshooting Emails
**********************

Expand Down
Binary file added docs/channels/images/emails/apply-draft.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/channels/images/emails/preview-draft.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/channels/images/emails/save-draft.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 92c010a

Please sign in to comment.