Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create new doc for mailchimp plugin app #340

Merged
merged 12 commits into from
Nov 3, 2024

Conversation

CBID2
Copy link
Contributor

@CBID2 CBID2 commented Oct 27, 2024

Description

This PR updates the MailChimp plugin tutorial.

Issue

Closes #328

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

Appreciate this is still a WIP but hopefully the feedback will be helpful to nudge you along the right directions!

docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
@CBID2 CBID2 marked this pull request as ready for review October 31, 2024 04:33
Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

Thanks for the work on this PR @CBID2 - great job!

There's quite a lot of syntax issues which might be a result (if you're working locally) of not running make html on your code before you push it, to check it's working OK and not breaking anything?

I've tried to snag all the ones it's reporting, and also to suggest fixes flagged up with the grammar. Shout once you're done as we'll need to manually run the GitHub Actions as this is your first PR :)

docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved

Get MailChimp API key
===========
Copy link
Member

Choose a reason for hiding this comment

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

This underline needs to be the full length of the heading above.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey @RCheesley. I tried googling this information but it seems that I followed the syntax correctly according to this chapter in Read the docs' document


Authorize Mautic - MailChimp plugin
===========
Copy link
Member

Choose a reason for hiding this comment

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

This underline needs to be the full length of the heading above.


Configure the plugin
**********
Copy link
Member

Choose a reason for hiding this comment

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

This underline needs to be the same length as the heading above.

docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Outdated Show resolved Hide resolved
docs/plugins/mailchimp.rst Show resolved Hide resolved
Co-authored-by: Ruth Cheesley <[email protected]>
Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

I've fixed the headings - it was just a few that were 1 character too short - and also an image path which was incorrect. Good to go now!

@RCheesley RCheesley added the documentation Improvements or additions to documentation label Nov 3, 2024
@RCheesley RCheesley merged commit 8e73ba8 into mautic:5.x Nov 3, 2024
2 checks passed
@CBID2 CBID2 deleted the creating-new-doc-for-mailchimp-plugin-app branch November 3, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest-accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write documentation on Mailchimp plugin
2 participants