Skip to content

Update Configuration settings page images for the Mautic 5.2 UI - #911

Open
promptless-for-oss wants to merge 2 commits into
mautic:5.2from
Promptless:promptless/issue-391-update-settings-images
Open

Update Configuration settings page images for the Mautic 5.2 UI#911
promptless-for-oss wants to merge 2 commits into
mautic:5.2from
Promptless:promptless/issue-391-update-settings-images

Conversation

@promptless-for-oss

@promptless-for-oss promptless-for-oss commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Open in Promptless

Refreshes 43 of the Configuration settings screenshots with freshly captured Mautic 5.2.0 light-mode screenshots — System, Email, API, Asset, Campaign, Contact/Segment/Company, Message queue, Notification, Landing Page, Tracking, Report, Text message, SAML/SSO, and Webhook sections. Sandbox paths/URLs that appeared in default fields (asset-directory path, general-settings Site URL / cache / log paths, and the tracking-script mtc.js URL) were scrubbed to the generic documentation values used in the prior published images.

Scope notes:

  • social-settings.png is left unchanged — Mautic 5.2's Configuration has no "Social settings" section (the tab does not exist in this version).
  • The queue-transport images render the same generic DSN form in 5.2; the transport is a free-text Scheme value with no provider-specific fields.
  • sendgrid-api-dsn.png mirrors the generic Email DSN section because 5.2 has no SendGrid-specific DSN UI.

Review feedback addressed (@RCheesley)

Recaptured against a local Mautic 5.2.0 instance with the example DSN values populated, so the settings are visible instead of appearing empty:

  • Message queue transportsqueue-disabled.png (sync://), queue-doctrine.png (doctrine://default), queue-redis.png (redis://localhost), queue-amqp.png (amqp://guest:SECRET@localhost:5672), queue-beanstalkd.png (beanstalkd://localhost), and queue-amazon-sqs.png (sqs://localhost:9494/messages?sslmode=disable). The earlier captures were taken on a fresh install before any DSN was entered, so every field showed empty and the saved DSN read sync://.
  • queue-failures.png — recaptured showing the failure queue configured as doctrine://default?queue_name=failed.
  • smtp-dsn.png and sendgrid-api-dsn.png — recaptured with the documented example DSNs filled in (smtp://user:pass@smtp.example.com:port and sendgrid+api://KEY@default).
  • SAML filename typo — renamed SMAL-settings.pngSAML-settings.png and updated the .. image:: directive in docs/configuration/settings.rst.
  • monitored-inbox-settings.png (PHP IMAP) — you were right: the previous capture only showed the "The PHP IMAP extension is required" banner because IMAP wasn't loaded in the capture environment. The screenshot toolchain runs on PHP 8.4, which removed IMAP from core, and there is no installable php-imap package for it, so the Monitored Inbox form cannot be rendered there. I've restored the previously published Monitored Inbox screenshot (which shows the full form) rather than ship the banner-only image. A fresh capture of this one section will need an environment with the IMAP extension available.

Closes #391

Trigger Events

Refresh 43 of the Configuration settings screenshots with freshly captured
Mautic 5.2.0 light-mode screenshots. Sandbox paths/URLs visible in the asset
directory, general settings paths, and the tracking script were scrubbed to
the generic documentation values.

social-settings.png is left unchanged: Mautic 5.2 has no Social settings
section in Configuration to capture.

Refs mautic#391
@promptless-for-oss
promptless-for-oss requested a review from a team as a code owner August 1, 2026 05:23
@promptless-for-oss
promptless-for-oss requested review from adiati98 and favour-chibueze and removed request for a team August 1, 2026 05:23

@RCheesley RCheesley left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss some changes needed here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss this one requires some attention - it seems the PHP IMAP extension isn't enabled on your build environment?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss it looks like the settings may be missing here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss it looks like the settings may be missing here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss it looks like the settings may be missing here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss it looks like the settings may be missing here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss it looks like the settings may be missing here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss it looks like the settings may be missing here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss it looks like the settings may be missing here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss can we please fix the typo in the filename? SAML not SMAL.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@promptless-for-oss it looks like the settings may be missing here.

@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks @RCheesley — working through each comment. I'll fix the SMALSAML filename typo, and re-capture the screenshots where settings sections came out empty (including checking the PHP IMAP extension in the capture environment). I'll follow up here with the results and a clear note on anything that can't be reproduced in our capture environment.

@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Mapped all the flagged images to their causes. Most of the "settings missing" shots are the message-queue and email DSN builders captured with the fields left empty, so they show blank example values — re-capturing those with example DSNs filled in to match the previously published images. Your hypothesis on the monitored-inbox screenshot is correct: the PHP IMAP extension wasn't loaded, so Mautic hid the form and showed the 'IMAP extension is required' banner — I'm working on getting IMAP available in the capture environment so that section renders. I'll also fix the SMALSAML filename typo. Will follow up with the results.

Address PR review feedback on the Mautic 5.2 Configuration screenshots:

- Recapture the 7 Message queue transport images (sync, Doctrine, Redis,
  AMQP, Beanstalkd, Amazon SQS, and the failure queue) with their example
  DSN values populated, so the settings are visible rather than empty.
- Recapture the SMTP and SendGrid Email DSN images with example values.
- Rename SMAL-settings.png to SAML-settings.png and update its directive.
- Restore the previously published monitored-inbox-settings screenshot,
  since the monitored-inbox form cannot render without the PHP IMAP
  extension.

Refs mautic#391
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed.

@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks @RCheesley — all your comments are addressed (commit 17ac15e):

  • Message queue + Email DSN screenshots (sync, Doctrine, Redis, AMQP, Beanstalkd, Amazon SQS, the failure queue, plus SMTP and SendGrid) were previously captured on a fresh install before any DSN was entered, so the fields showed empty. They've been recaptured with the documented example DSN values filled in.
  • Filename typo fixed: SMAL-settings.pngSAML-settings.png, with its image directive updated.
  • Monitored Inbox — you were exactly right: that section only showed the 'PHP IMAP extension is required' banner because IMAP wasn't loaded in the capture environment. Our screenshot toolchain runs on PHP 8.4, which dropped IMAP from core with no installable package, so that form can't be rendered there. We've restored the previously published screenshot that shows the full form; a fresh 5.2 capture of just that section would need a capture environment with the PHP IMAP extension available.

Separately, heads-up: the failing build check isn't caused by these image changes — it's a pre-existing broken external link (https://aivie.ch, returning HTTP 415) in docs/builders/email_landing_page.rst, which is outside this PR's scope and identical on the base branch. Ready for another look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants