[IMP] marketing: RST format upgrades for marketing automation v14 #4320

ksc-odoo · 2023-05-02T17:12:52Z

v14 marketing automation > getting started > first campaign RST formatting updates/upgrades

made necessary formatting changes to adhere to rst decisions made during writer's workshop meeting

This PR should be FWP to 15.0 & 16.0

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

robodoo · 2023-05-02T17:13:12Z

Pull request status dashboard.

ksc-odoo

@samueljlieber would you mind giving this a quick technical review? I made some RST updates/changes to reflect the formatting decisions made during our recent Writer's Workshop meeting. Thanks!

Also, I'll be continuing to do this for all published Marketing docs, so if you think there's a better/easier way to do this - as opposed to a slurry of PRs - just let me know, and I'll make it happen. Thanks!

StraubCreative · 2023-05-02T19:35:15Z

5fbef09

renamed commit message to follow convention ( [TAG] module: short description] )
@ksc-odoo reminder for branch naming convention for next time: version-module-short-description-trigram e.g. 14.0-marketing-rst-upgrades-for-marketing-automation-ksc
rebased on fresh 14.0 pull

Super confused about all of the errors tbh. Will try a few things...

samueljlieber

Hi @ksc-odoo 👋
I've made some technical changes here. Please review and let me know if you approve or have any changes. I will push my changes up as a commit after this review 🙂

samueljlieber · 2023-05-03T19:18:38Z

content/applications/marketing/marketing_automation/getting_started/first_campaign.rst

Use menuselection here because we are directing the user.

Suggested change

To create a new automated marketing campaign, open the :guilabel:`Marketing Automation` app,

To create a new automated marketing campaign, open the :menuselection:`Marketing Automation` app,

samueljlieber · 2023-05-03T19:19:01Z

content/applications/marketing/marketing_automation/getting_started/first_campaign.rst

Spelling correction.

Suggested change

futher narrow down the target recipients/audience for the marketing automation campaign.

further narrow down the target recipients/audience for the marketing automation campaign.

samueljlieber · 2023-05-03T19:22:54Z

content/applications/marketing/marketing_automation/getting_started/first_campaign.rst

Icons in guilabels can't have a space after the first backtick and before the emoji, the guilabel wont format correctly. Also, include the parenthesis text within the guilabel too like this:

Suggested change

To add another node, click the :guilabel:` ➕ ` (plus sign) icon to the right of the filtering

rule. To add a branch of multiple nodes at the same time, click the :guilabel:` ... ` (ellipses)

To add another node, click the :guilabel:`➕ (plus sign)` icon to the right of the filtering

rule. To add a branch of multiple nodes at the same time, click the :guilabel:`⋯ (ellipses)`

samueljlieber · 2023-05-03T19:24:28Z

content/applications/marketing/marketing_automation/getting_started/first_campaign.rst

Updating to use global relative path rather than local relative path.

Suggested change

For further information on filters, refer to :doc:`this documentation page <target_audience>`.

For further information on filters, refer to :doc:`this documentation page

</applications/marketing/marketing_automation/getting_started/target_audience>`.

samueljlieber · 2023-05-03T19:28:14Z

Implemented my technical changes in afab01a.

ksc-odoo · 2023-05-03T21:36:29Z

Hi @ksc-odoo 👋 I've made some technical changes here. Please review and let me know if you approve or have any changes. I will push my changes up as a commit after this review 🙂

@samueljlieber I fully approve of the changes - thanks for the in-depth review, as always

samueljlieber · 2023-05-04T14:52:34Z

Hi @StraubCreative this PR is ready for your review!

StraubCreative

Hi @ksc-odoo

Couple small changes. Everything else looked good.
Tag me again when these are addressed and we can merge 👍

Remind me: should these changes be forward ported to 15 and 16 (it's the same content right)?

Later:
At some point let's talk about consolidating some of these docs so they're each a more complete use case.

As is, this doc only covers the macro settings of a MA campaign, however, these settings aren't enough to launch an MA campaign; a partial walk-through of the UI isn't as useful as, say, a doc that builds a campaign from start to finish and clicks launch.

cc: @samueljlieber

content/applications/marketing/marketing_automation/getting_started/first_campaign.rst

StraubCreative · 2023-05-11T01:57:01Z

content/applications/marketing/marketing_automation/getting_started/first_campaign.rst

@@ -1,59 +1,70 @@
 ====================
-Marketing Automation
+Marketing automation


This should be a different title.
As it is the TOC navigation is Marketing Automation --> Getting Started --> Marketing Automation

I'm thinking this doc can be called Getting started, which funny enough @ksc-odoo might have been the same or similar title you gave it originally on the initial PR 😄

Also do we need the subsections Getting Started and Advanced?
Can we just have all 5 docs listed under Marketing --> Marketing Automation, like how Events is structured?

cc: @samueljlieber

I changed the title to "Getting started" (per your suggestion)

And, honestly, in my opinion, no, I don't think we need the subsections - I was just working off the previously established format. I believe we can have all 5 docs listed under Marketing --> Marketing Automation, just like the Events structure.

cc: @samueljlieber

ksc-odoo · 2023-05-11T16:28:18Z

Hi @ksc-odoo

Couple small changes. Everything else looked good. Tag me again when these are addressed and we can merge 👍

Remind me: should these changes be forward ported to 15 and 16 (it's the same content right)?

Later: At some point let's talk about consolidating some of these docs so they're each a more complete use case.

As is, this doc only covers the macro settings of a MA campaign, however, these settings aren't enough to launch an MA campaign; a partial walk-through of the UI isn't as useful as, say, a doc that builds a campaign from start to finish and clicks launch.

cc: @samueljlieber

Re: if it should be forward ported to 15 and 16....

I'd say "yes" because this meets the current formatting guidelines, and would only need minimal adjustments (perhaps an updated screenshot/removal of "save" mentions, etc) - which I can take care of in the near future - but this version is better than the current doc for Marketing Automation, in my opinion

@samueljlieber @StraubCreative

Also, I made the necessary adjustments, sent a fresh, fully-updated RST file to @samueljlieber and he should be able to push it (and forward port it) soon.

If there's anything else you need from me, just let me know.

thanks!

samueljlieber · 2023-05-11T19:14:04Z

Hi @ksc-odoo, I implemented your changes in 69fa638 and I feel this PR is good to go!

I agree with @StraubCreative's comment about restructuring Marketing Automation to be more like Events. @ksc-odoo lets create a task for this 🙂

StraubCreative

Approving so we can merge the good progress we have already.
Can work on small stuff later as well as restructure.

In the future I don't want to see creative parenthesis use or idioms 😉

@robodoo r+

StraubCreative · 2023-08-04T19:53:44Z

content/applications/marketing/marketing_automation/getting_started/first_campaign.rst

+
 - :guilabel:`Templates`: represents the number of pre-configured mail templates being used in this
-  particular campaign. (Templates can always be created on-the-fly as well).
+  particular campaign. (Templates can always be created on-the-fly, as well).


A sentence that's in entirely in parenthesis is not grammatically correct.
Avoid idioms like "on-the-fly"

Suggested change

particular campaign. (Templates can always be created on-the-fly, as well).

particular campaign. (Templates can always be created on-the-fly, as well).

StraubCreative · 2023-08-04T19:54:03Z

content/applications/marketing/marketing_automation/getting_started/first_campaign.rst

   :align: center
   :alt: A dashboard showing the creation of a new marketing automation campaign in Odoo.

+**Smart buttons**


Should be an h3 heading?

StraubCreative · 2023-08-04T19:54:10Z

content/applications/marketing/marketing_automation/getting_started/first_campaign.rst

 - :guilabel:`Participants`: represents the number of contacts that have directly participated in
  this campaign.
+
+**Fields**


closes #4320 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

ksc-odoo added the 14.0 label May 2, 2023

ksc-odoo requested review from a team May 2, 2023 17:12

ksc-odoo self-assigned this May 2, 2023

ksc-odoo commented May 2, 2023

View reviewed changes

StraubCreative changed the title ~~RST format upgrades for v14~~ [IMP] marketing: RST format upgrades for marketing automation v14 May 2, 2023

StraubCreative force-pushed the ksc-odoo-v14-format-upgrade branch from e55bd3f to 5fbef09 Compare May 2, 2023 19:29

samueljlieber force-pushed the ksc-odoo-v14-format-upgrade branch from 5fbef09 to 91cbe6d Compare May 3, 2023 18:39

samueljlieber self-requested a review May 3, 2023 18:39

samueljlieber changed the base branch from 14.0 to 15.0 May 3, 2023 18:42

samueljlieber changed the base branch from 15.0 to 14.0 May 3, 2023 18:42

samueljlieber requested changes May 3, 2023

View reviewed changes

samueljlieber force-pushed the ksc-odoo-v14-format-upgrade branch from 91cbe6d to afab01a Compare May 3, 2023 19:27

samueljlieber approved these changes May 4, 2023

View reviewed changes

samueljlieber requested a review from StraubCreative May 4, 2023 14:52

StraubCreative requested changes May 11, 2023

View reviewed changes

[IMP] marketing: RST format upgrades for marketing automation v14

69fa638

samueljlieber force-pushed the ksc-odoo-v14-format-upgrade branch from afab01a to 69fa638 Compare May 11, 2023 19:11

samueljlieber requested a review from StraubCreative May 11, 2023 19:14

StraubCreative approved these changes Aug 4, 2023

View reviewed changes

robodoo pushed a commit that referenced this pull request Aug 4, 2023

[IMP] marketing: RST format upgrades for marketing automation v14

b5bde91

closes #4320 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

fw-bot mentioned this pull request Aug 4, 2023

[FW][IMP] marketing: RST format upgrades for marketing automation v14 #5275

Closed

robodoo temporarily deployed to merge August 4, 2023 20:47 Inactive

robodoo closed this Aug 4, 2023

AntoineVDV pushed a commit that referenced this pull request Aug 7, 2023

[IMP] marketing: RST format upgrades for marketing automation v14

e54c58c

closes #4320 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

	To create a new automated marketing campaign, open the :guilabel:`Marketing Automation` app,
	To create a new automated marketing campaign, open the :menuselection:`Marketing Automation` app,

	futher narrow down the target recipients/audience for the marketing automation campaign.
	further narrow down the target recipients/audience for the marketing automation campaign.

-To add another node, click the :guilabel:` ➕ ` (plus sign) icon to the right of the filtering
-rule. To add a branch of multiple nodes at the same time, click the :guilabel:` ... ` (ellipses)
+To add another node, click the :guilabel:`➕ (plus sign)` icon to the right of the filtering
+rule. To add a branch of multiple nodes at the same time, click the :guilabel:`⋯ (ellipses)`

	For further information on filters, refer to :doc:`this documentation page <target_audience>`.
	For further information on filters, refer to :doc:`this documentation page
	</applications/marketing/marketing_automation/getting_started/target_audience>`.

	particular campaign. (Templates can always be created on-the-fly, as well).
	particular campaign. (Templates can always be created on-the-fly, as well).

[IMP] marketing: RST format upgrades for marketing automation v14 #4320

[IMP] marketing: RST format upgrades for marketing automation v14 #4320

Uh oh!

Conversation

ksc-odoo commented May 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

robodoo commented May 2, 2023

Uh oh!

ksc-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

StraubCreative commented May 2, 2023

Uh oh!

samueljlieber left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samueljlieber commented May 3, 2023

Uh oh!

ksc-odoo commented May 3, 2023

Uh oh!

samueljlieber commented May 4, 2023

Uh oh!

StraubCreative left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ksc-odoo May 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ksc-odoo commented May 11, 2023

Uh oh!

samueljlieber commented May 11, 2023

Uh oh!

StraubCreative left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ksc-odoo commented May 2, 2023 •

edited

Loading

ksc-odoo May 11, 2023 •

edited

Loading