mautic / mautic/user-documentation

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

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

Nobody has claimed this yet.

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

Description

[!NOTE]

To update the image for this issue, you need to have an existing account on Clearbit.

Description

The image in this documentation is incorrect, as it's a screenshot of Amazon S3 console.

Website page

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

Suggestions

  • Add new screenshots to authorize the plugin and the plugin usage for Clearbit.
  • Remove incorrect image.

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

Open docs/plugins/clearbit.rst and compare it with the Clearbit page at https://docs.mautic.org/en/7.0/plugins/clearbit.html. Follow the page instructions to capture light-mode PNG screenshots for authorization and plugin usage, then preview the documentation locally. Done means the incorrect Amazon S3 image is removed and the new images render correctly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.