documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[ADD] marketing automation: added 'getting started' section and docs …

Open ksc-odoo opened this issue 3 years ago • 7 comments

Task ID: 2942081

ksc-odoo avatar Aug 02 '22 17:08 ksc-odoo

@mivu-odoo hey there!

Added a "Getting Started" section (and Getting Started documentation sections) to the Marketing Automation documentation.

Once I get your approval, I'll be sure to send this along to Zac.

Thanks!

ksc-odoo avatar Aug 02 '22 17:08 ksc-odoo

Hello @ksc-odoo! I pushed commit fe684fd. In this commit, I updated the RST file names for getting_started.rst, first_campaign.rst, target_audience.rst, testing_running.rst, and workflow_activities.rst.

Before, all the RST files in this PR used hyphens instead of underscores for spaces. RST file names should use underscores for spaces. It can get confusing because image files names use hyphens for spaces.

I'll have to work on this another day to fix the No "build succeeded." found in logs. message; this PR is still failing the ci/documentation code check.

mivu-odoo avatar Aug 31 '22 23:08 mivu-odoo

Adding on commit 1e30c64

In this commit, I...

  • changed the code line in marketing_automation.rst to reference the new RST file name marketing_automation/getting_started (with the underscore, not the hyphen)
  • renamed the image folder to first_campaign (with the underscore) for first_campaign.rst
  • updated the image folder paths referenced in first_campaign.rst
  • renamed the image folder to target_audience (with the underscore) for target_audience.rst
  • updated the image folder paths referenced in target_audience.rst

Will need to push another commit to fix the image folder names and references for testing_running.rst and workflow_activities.rst

mivu-odoo avatar Aug 31 '22 23:08 mivu-odoo

Adding on commit 2b8ac51

In this commit, I...

  • renamed the image folder to testing_running (with the underscore) for testing_running.rst
  • updated the image folder paths referenced in testing_running.rst
  • renamed the image folder to workflow_activities (with the underscore) for workflow_activities.rst
  • updated the image folder paths referenced in workflow_activities.rst

mivu-odoo avatar Sep 01 '22 19:09 mivu-odoo

Latest commit b5ed0a7 - the build errors were corrected and the PR is now passing all the checks 🥳

For reference, the fixes in this commit were:

  • fixed the file path references from getting-started/[rst_file_name].rst to getting_started/[rst_file_name].rst in the toctree file getting_started.rst
  • fixed indentation on bulleted list items in first_campaign.rst and workflow_activities.rst; if the text of a bullet list item runs over onto a second line, make sure the first letter of the second line aligns with the first letter of the first line. Also, you don't have to put blank lines between each list item in a bulleted list.
  • shortened the :alt: text on the image directive for filters7.png in target_audience.rst from two lines to one line. I tried to just align the first letters of both lines, but it was still giving me a build error, so I just shortened the text to one line.

mivu-odoo avatar Sep 01 '22 21:09 mivu-odoo

Hi @StraubCreative this is ready for final technical review!

mivu-odoo avatar Oct 05 '22 22:10 mivu-odoo

@StraubCreative Alright - did my best to clean up the advanced doc (understanding_metrics). It's ready for your review. Ready to make any necessary changes. Thanks!

ksc-odoo avatar Dec 02 '22 23:12 ksc-odoo

Follow up from previous comment:

53b0c86: fixed alt texts on understanding_metrics.rst

Doc should be up to technical standards now. All checks pass 👍

StraubCreative avatar Dec 06 '22 03:12 StraubCreative

This PR for marketing automation is ready for your review @odoo/doc-review 🙏

StraubCreative avatar Dec 06 '22 03:12 StraubCreative

Hi @Feyensv Thank you for your review. I believe I addressed all of your your change requests on ee3a180. Please take another look when you have a moment 🙏

StraubCreative avatar Dec 06 '22 19:12 StraubCreative