documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[ADD] sms marketing: added essentials/getting started docs

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

Task ID: 2942125

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

Hi @mivu-odoo

I added some basic, "essential," documentation to the SMS Marketing doc.

Once I get your approval/review, I'll pass it along to Zac.

Thanks!

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

Hi @ksc-odoo!

This PR wasn't passing the ci/documentation code check b/c of some build errors.

As of commit d542657

  • Renamed the RST files to replace the hyphens with underscores in contacts-blacklist.rst and sms-integrations.rst
  • Renamed first-campaign.rst to first_sms_campaign.rst to be more specific b/c I know PR #2552 is going to add a file named first_campaign.rst for Marketing Automation user docs, and I thought it would be confusing to have two files in different places with the same name
  • Fixed the RST file names referenced in essentials.rst to match the new RST file names (the ones with the underscores)
  • Renamed the image folders to replace the hyphens with underscores (so they match the new RST file names)
  • Fixed the image folder name references in first_sms_campaign.rst, sms_integrations.rst, and contacts_blacklist.rst
  • Fixed the indentation of sms_marketing/essentials and sms_marketing/pricing in sms_marketing.rst to align with the first colon of :titlesonly:

Despite all these changes, the PR still won't pass the code check b/c there's one error I haven't quite figured out how to crack.

When I run make html, I get an error for first_sms_campaign.rst:140: WARNING: unknown document: pricing_and_faq. I tried several different iterations like including more of the file path, but I would still get the same build error. Will probably have to loop in ZST to fix.

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

Hi @mivu-odoo and @ksc-odoo 👋

I fixed what was causing the build error here! It was due to an incorrect referenced doc path on line 140 of first_sms_campaign.rst 🙂

The path was: pricing_and_faq

The referenced doc path needs to be relative to the document you are linking from, so the correct path looks like this: ../pricing/pricing_and_faq

samueljlieber avatar Sep 02 '22 14:09 samueljlieber