-
Notifications
You must be signed in to change notification settings - Fork 44
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
docs: create new doc for mailchimp plugin app #340
Conversation
Signed-off-by: Christine <[email protected]>
There was a problem hiding this 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!
Co-authored-by: Ruth Cheesley <[email protected]>
Signed-off-by: Christine <[email protected]>
Signed-off-by: Christine <[email protected]>
Signed-off-by: Christine <[email protected]>
Signed-off-by: Christine <[email protected]>
Signed-off-by: Christine <[email protected]>
There was a problem hiding this 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
|
||
Get MailChimp API key | ||
=========== |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
docs/plugins/mailchimp.rst
Outdated
|
||
Authorize Mautic - MailChimp plugin | ||
=========== |
There was a problem hiding this comment.
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.
docs/plugins/mailchimp.rst
Outdated
|
||
Configure the plugin | ||
********** |
There was a problem hiding this comment.
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.
Co-authored-by: Ruth Cheesley <[email protected]>
There was a problem hiding this 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!
Description
This PR updates the MailChimp plugin tutorial.
Issue
Closes #328