Skip to content

Commit

Permalink
docs: create new doc for mailchimp plugin app
Browse files Browse the repository at this point in the history 
Signed-off-by: Christine <[email protected]>
  • Loading branch information
@CBID2
CBID2 committed Oct 27, 2024
1 parent 97c9009 commit 799927d
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion docs/plugins/mailchimp.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,47 @@
MailChimp
#########

.. vale on
.. vale on
This plugin can send contacts to MailChimp cilents based on Contact actions or Point Triggers.

Check warning on line 7 in docs/plugins/mailchimp.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 'Plugin' instead of 'plugin'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 7, "column": 6}}}, "severity": "INFO"}

Check warning on line 7 in docs/plugins/mailchimp.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 'Contacts' instead of 'contacts'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contacts' instead of 'contacts'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 7, "column": 22}}}, "severity": "INFO"}

Check failure on line 7 in docs/plugins/mailchimp.rst

View workflow job for this annotation

GitHub Actions / prose 

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'cilents'?", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 7, "column": 44}}}, "severity": "ERROR"}

## Authorize

### Get MailChimp API key

1. Create a MailChimp account.
2. Go to *Account* / *Extras* / *API Keys* and create a new one.
3. Copy the created API Key.

### Authorize Mautic - MailChimp plugin

Check warning on line 17 in docs/plugins/mailchimp.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 'Plugin' instead of 'plugin'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 17, "column": 34}}}, "severity": "INFO"}

1.Fill in with your MailChimp's account **username**
2. Add the **API key**
3. Click on ***Save & Close***

## Configure the plugin

Check warning on line 23 in docs/plugins/mailchimp.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 'Plugin' instead of 'plugin'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 23, "column": 18}}}, "severity": "INFO"}

Navigate to the *Features* tab in the plugin configuration modal box. You should see this note:

Check warning on line 25 in docs/plugins/mailchimp.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 'Plugin' instead of 'plugin'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 25, "column": 39}}}, "severity": "INFO"}

> The Contact Field Mapping tab will appear after selecting a segment and will update after changing the selected segment.

Check warning on line 27 in docs/plugins/mailchimp.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/plugins/mailchimp.rst", "range": {"start": {"line": 27, "column": 33}}}, "severity": "WARNING"}

Check warning on line 27 in docs/plugins/mailchimp.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 'Segment' instead of 'segment'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Segment' instead of 'segment'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 27, "column": 63}}}, "severity": "INFO"}

Check warning on line 27 in docs/plugins/mailchimp.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/plugins/mailchimp.rst", "range": {"start": {"line": 27, "column": 75}}}, "severity": "WARNING"}

Check warning on line 27 in docs/plugins/mailchimp.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 'Segment' instead of 'segment'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Segment' instead of 'segment'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 27, "column": 115}}}, "severity": "INFO"}

![MailChimp Plugin configuration](plugins-mailchimp-configure.png "MailChimp Plugin configuration")

Check warning on line 29 in docs/plugins/mailchimp.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 'Plugins' instead of 'plugins'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugins' instead of 'plugins'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 29, "column": 35}}}, "severity": "INFO"}

Check failure on line 29 in docs/plugins/mailchimp.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'MailChimp' instead of 'mailchimp'.

Raw Output:
{"message": "[Vale.Terms] Use 'MailChimp' instead of 'mailchimp'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 29, "column": 43}}}, "severity": "ERROR"}

1. Select the Segment.

If you don't have a segment in [MailChimp][mailchimp] created yet, go to *MailChimp dashboard* / *Segments* / *Create List* and create one.

Check failure on line 33 in docs/plugins/mailchimp.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'MailChimp' instead of 'mailchimp'.

Raw Output:
{"message": "[Vale.Terms] Use 'MailChimp' instead of 'mailchimp'.", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 33, "column": 47}}}, "severity": "ERROR"}

1. Save the plugin configuration
1. Open it again.

The *Contact Field Mapping* tab should appear now.

1. Configure the [field mapping][field-mapping].

### Other configuration options

- **Push contacts to this integration**

This option is checked by default. If you uncheck it, the plugin will not push contacts to MailChimp any more.

Check failure on line 46 in docs/plugins/mailchimp.rst

View workflow job for this annotation

GitHub Actions / prose 

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'uncheck'?", "location": {"path": "docs/plugins/mailchimp.rst", "range": {"start": {"line": 46, "column": 46}}}, "severity": "ERROR"}

- **Enable double opt in** - If MailChimp should send a confirmation email to the contacts added by this plugin. The contacts will have to confirm that they really want to be added to the segment.
- **Send welcome email** - Whether MailChimp should send the welcome email.

0 comments on commit 799927d

Please sign in to comment.