Skip to content

Conversation

@samueljlieber
Copy link
Contributor

@samueljlieber samueljlieber commented Apr 11, 2023

This PR adds new documentation for Email Marketing specifically Email Marketing Essentials, Mailing Lists, and Manage Unsubscriptions (Blacklist).

This PR targets 14.0 and can be forward ported to 15.0 and 16.0, although some minor content changes will need to be made after merge for 15.0 and 16.0 (i.e. buttons have different names, no more edit mode, etc.).

Project Task link:https://www.odoo.com/web#id=3329130&cids=3&menu_id=4720&action=333&active_id=3835&model=project.task&view_type=form

@robodoo
Copy link
Collaborator

robodoo commented Apr 11, 2023

@C3POdoo C3POdoo requested review from a team April 11, 2023 20:27
@samueljlieber
Copy link
Contributor Author

Hi @ksc-odoo, here is the PR for your Email Marketing docs. Great job on the markup of these docs! I did not perform a full technical review yet, I only fixed some line breaks, spaces between bullet points, and a couple spelling errors. Please tag me once this PR is ready for a technical review, or if you need more edits made 🙂

Copy link
Contributor

@ksc-odoo ksc-odoo left a comment

Choose a reason for hiding this comment

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

Looks good, @samueljlieber ! I think this one is ready for a technical review. Let me know if there's anything else you need from me. Thanks again for all your help with this!

Copy link
Contributor

@jcs-odoo jcs-odoo left a comment

Choose a reason for hiding this comment

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

Hello,

I haven't read the content, but here is my review from a structural point of view:

The current structure has too many clicks to reach the main content. You could move the content from email_marketing/overview/email_marketing_essentials into the app-level page email_marketing, and remove the "overview" category.

The new structure would be like this:

  • email_marketing.rst (including the "essentials")
    • email_marketing/mailing_lists.rst
    • email_marketing/unsubscriptions.rst (remove manage_ from the filename (and from the title too))

Cheers :)

@@ -0,0 +1,10 @@
:nosearch:
Copy link
Contributor

Choose a reason for hiding this comment

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

When a page has children pages, it isn't visible by default. If you add the "essentials" in this page, you'd need these options:

Suggested change
:nosearch:
:show-content:
:show-toc:

Copy link
Contributor Author

@samueljlieber samueljlieber left a comment

Choose a reason for hiding this comment

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

Hi @ksc-odoo 👋 I've made @jcs-odoo's suggested restructure as well as a full technical review of email_marketing.rst, mailing_lists.rst, and unsubscriptions.rst.

Please review my changes below and let me know if you agree with them and I will tag this PR for final review. I will be implement these changes in a commit after this review.

Most of my changes applied many of the concepts we discussed in our last workshop 🙂

audience - large or small. The success of an email is easily measurable, especially when a creative
call-to-action is involved.

:guilabel:`Odoo Email Marketing` provides professional-grade email design tools, templates, and
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
:guilabel:`Odoo Email Marketing` provides professional-grade email design tools, templates, and
Odoo *Email Marketing* provides professional-grade email design tools, templates, and

Email marketing dashboard
=========================

To get started, click on the :guilabel:`Email Marketing` app icon, located on the main Odoo
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
To get started, click on the :guilabel:`Email Marketing` app icon, located on the main Odoo
To get started, click on the :menuselection:`Email Marketing` app icon, located on the main Odoo


To get started, click on the :guilabel:`Email Marketing` app icon, located on the main Odoo
dashboard, which leads to the main :guilabel:`Email Marketing` dashboard (in the default
:guilabel:`Kanban` view).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
:guilabel:`Kanban` view).
kanban view).

In the search bar, by default, the filter: :guilabel:`My Mailings` is present. That means the
only information being seen (at that time) on the :guilabel:`Email Marketing` dashboard are
emails that the current user has created, sent, or is responsible for. This filter can be removed
by clicking the "X" next to :guilabel:`My Mailings` in the search bar. Doing so, reveals all the
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
by clicking the "X" next to :guilabel:`My Mailings` in the search bar. Doing so, reveals all the
by clicking the :guilabel:`X` next to :guilabel:`My Mailings` in the search bar. Doing so, reveals all the

Comment on lines 37 to 38
The four :guilabel:`Kanban` columns each represent the various stages (statuses) of emails that have
been built (and sent) within the :guilabel:`Email Marketing` application.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
The four :guilabel:`Kanban` columns each represent the various stages (statuses) of emails that have
been built (and sent) within the :guilabel:`Email Marketing` application.
The four kanban columns each represent the various stages (statuses) of emails that have
been built (and sent) within the *Email Marketing* application.

Comment on lines 25 to 27
With a test mailing, clicking the *Unsubscribe* button reveals an error page (*error 403 - Access
Denied*). To make sure the link is working properly, create the mailing, and only send it to a
personal email.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
With a test mailing, clicking the *Unsubscribe* button reveals an error page (*error 403 - Access
Denied*). To make sure the link is working properly, create the mailing, and only send it to a
personal email.
With a test mailing, clicking the :guilabel:`Unsubscribe` link reveals an error page (*error 403
- Access Denied*). To make sure the link is working properly, create the mailing, and only send
it to a personal email.

:alt: View of a blacklisted contact detail form in Odoo Email Marketing.

In the :guilabel:`Chatter` of this page, there's a time-stamped message, informing the user when
that recipient blacklisted themselves (via a *Mail Blacklist created* log note).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
that recipient blacklisted themselves (via a *Mail Blacklist created* log note).
that recipient blacklisted themselves (via a :guilabel:`Mail Blacklist created` log note).

====================

To *Unblacklist* contacts, click the :guilabel:`Unblacklist` button in the upper-left corner to
remove the contact from the *Blacklist*, allowing them to receive mailings once again.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
remove the contact from the *Blacklist*, allowing them to receive mailings once again.
remove the contact from the blacklist, allowing them to receive mailings once again.


When :guilabel:`Unblacklist` is clicked, a pop-up appears. In this pop-up, the specific email
address is listed, and there's a :guilabel:`Reason` field, in which a reason can be entered,
explaining why this particular contact was removed from the *Blacklist*.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
explaining why this particular contact was removed from the *Blacklist*.
explaining why this particular contact was removed from the blacklist.

:alt: View of the unblacklist pop-up window in the Odoo Email Marketing application.

After filling in the fields, click :guilabel:`Confirm` to officially remove that particular contact
from the *Blacklist*.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
from the *Blacklist*.
from the blacklist.

@samueljlieber samueljlieber force-pushed the 14.0-email-marketing-add-new-docs-ksc branch from 1524758 to ae507a2 Compare April 28, 2023 14:18
@samueljlieber
Copy link
Contributor Author

Implemented technical changes in ae507a2.

@ksc-odoo
Copy link
Contributor

Hi @ksc-odoo 👋 I've made @jcs-odoo's suggested restructure as well as a full technical review of email_marketing.rst, mailing_lists.rst, and unsubscriptions.rst.

Please review my changes below and let me know if you agree with them and I will tag this PR for final review. I will be implement these changes in a commit after this review.

Most of my changes applied many of the concepts we discussed in our last workshop 🙂

Looks good to me. Thanks for all your help with this. I fully approve these changes. Feel free to tag this for Final Review. Thanks again.

@samueljlieber
Copy link
Contributor Author

Hi @StraubCreative 👋 this PR is ready for your final review :)

Copy link
Contributor

@StraubCreative StraubCreative left a comment

Choose a reason for hiding this comment

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

Hi @ksc-odoo
Can you take another look at these please?
I'm finding small things we've covered on previous PRs.
Thank you!

@StraubCreative StraubCreative added the repeat designation for PRs worth a second look label Jun 27, 2023
@ksc-odoo ksc-odoo force-pushed the 14.0-email-marketing-add-new-docs-ksc branch from ae507a2 to 992d1fc Compare June 27, 2023 18:10
@ksc-odoo
Copy link
Contributor

Hi @ksc-odoo Can you take another look at these please? I'm finding small things we've covered on previous PRs. Thank you!

@StraubCreative Just made all the suggested changes - it's ready for another look from you whenever you get a chance. Thanks! 👍

@ksc-odoo ksc-odoo requested a review from StraubCreative June 27, 2023 18:13
@ksc-odoo ksc-odoo force-pushed the 14.0-email-marketing-add-new-docs-ksc branch from 992d1fc to 34347f2 Compare June 27, 2023 22:25
Copy link
Contributor

@StraubCreative StraubCreative left a comment

Choose a reason for hiding this comment

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

really thorough, nice job @ksc-odoo 👍

@robodoo r+

@robodoo
Copy link
Collaborator

robodoo commented Aug 25, 2023

@ksc-odoo ya silly goose you can't reopen a merged PR.

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

Labels

repeat designation for PRs worth a second look

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants