mautic / mautic/user-documentation
Update images in docs/plugins/social_login.rst in branch 5.2
Nobody has claimed this yet.
- 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 a developer account on the developer platforms such as X or Facebook.
Description
The user interface in docs/plugins/social_login.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/social_login.html
Suggestions
-
In Mautic UI, navigate to
settings > Plugins > Facebook or Twitter. Then, create a screenshot that highlight below info and give numbers based on the steps:- Mautic's callback URL (1)
- Client ID and Client Secret fields (2)
- Authorize App button (3)
- Active toggle (3)
Add this screenshot to the end of "Step 1 - authorizing social media Plugins" section, before the Tip.
Here are some examples of highlight:
-
Remove below images:
- docs/plugins/images/Call_back.png
- docs/plugins/images/API_key.png
-
The following image is referenced and need to be reviewed and updated as needed:
- docs/plugins/images/adding_social_login.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) 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read docs/plugins/social_login.rst and compare it with the linked Mautic 7.0 page and current plugin UI. Review docs/plugins/images/adding_social_login.png, remove the two named obsolete images, and create or update the requested light-mode PNG screenshots. Preview the documentation locally to confirm the images render correctly and the instructions match the updated UI.
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