mautic / mautic/user-documentation

Update images in docs/plugins/mailchimp.rst in branch 5.2

Open
#381 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted
Dominant language
Shell
Stars
22
Forks
76
Avg merge
22h 9m
Merged PRs (30d)
33

Description

[!NOTE]

To update the images for this issue, you must create or have an account at Mailchimp.

Description

The user interface in docs/plugins/mailchimp.rst has changed, and the images in this documentation need to be updated to reflect the new UI.

Website page

https://docs.mautic.org/en/7.0/plugins/mailchimp.html

Suggestions

  1. Add a screenshot of Enabled/Auth tab to the "Authorize Mautic - MailChimp Plugin" section.

  2. The following images are referenced and need to be reviewed and updated as needed:

    • docs/plugins/images/plugins-mailchimp-create-api-key-1-and-2.png
    • docs/plugins/images/plugins-mailchimp-create-api-key-3a.png
    • docs/plugins/images/plugins-mailchimp-create-api-key-3b-and-3c.png
    • docs/plugins/images/plugins-mailchimp-configure.png

Important notes

  • Please follow the instructions on the website page to navigate Mautic.
  • Please use the light mode to take the screenshots.
  • Please zoom out bit by bit until you can capture the whole component if the component occupied the screen or need to be scrolled.
  • Please use red color if you need to highlight (create a box for) the components.
  • Please save the images in .png.
  • Always test and preview your changes locally to ensure that the images are rendered properly.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading docs/plugins/mailchimp.rst and checking the linked Mailchimp documentation page, confirming whether the 5.2 branch should follow the referenced 7.0 UI. Review the listed PNGs, add the Enabled/Auth screenshot to the authorization section, update images as needed, and preview the documentation locally to verify rendering.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.