docs: Document A/B testing for Segment Emails#811
Conversation
Add a user-facing A/B testing workflow to the Segment Emails docs and a matching mautic:email:sendwinner cron job section, targeting the 7.2 branch. Covers converting an Email via the 'Convert to A/B test' card, configuring 'How to pick the winner', 'Wait before picking winner', and 'Test audience size', managing variants, scheduling, sending/winner determination, and viewing A/B Test Stats.
|
|
||
| .. _ab testing for segment emails: | ||
|
|
||
| .. vale off |
There was a problem hiding this comment.
New A/B testing feature for Segment Emails introduced in PR #15897. This PR adds the ability to convert Segment Emails to A/B tests with the 'Create an A/B test' card, manage variants, schedule tests, and determine winners via the mautic:email:sendwinner command.
Source: mautic/mautic#15897
| .. _determine ab test winner: | ||
|
|
||
| .. vale off | ||
|
|
There was a problem hiding this comment.
The mautic:email:sendwinner command is introduced in PR #15897 as part of the A/B testing feature for Segment Emails. This command determines the winning variant and triggers sending the remaining Emails with the winner's content.
Source: mautic/mautic#15897
|
|
||
| #. Open a Segment Email that you haven't sent yet. | ||
| #. In the right-hand column of the Email detail view, find the 'Convert to A/B test' card and select it. | ||
|
|
There was a problem hiding this comment.
The 'Convert to A/B test' card and the 'Convert to A/B test email' dialog labels come from PR #15897: messages.ini renames mautic.core.ab_test.create to "Convert to A/B test", and the dialog field labels 'How to pick the winner' (mautic.core.ab_test.form.winner), 'Wait before picking winner' (send_winner_delay), and 'Test audience size' (traffic_total_weight) are added in the same file. Defaults (24 hours, 10%) come from GenerateABTestType/ABTestController (DEFAULT_DELAY = 24, DEFAULT_AB_WEIGHT = 10).
Source: mautic/mautic#15897
|
|
||
| For A/B test Emails, Mautic hides the 'Send' button in the header. Schedule and send the test from the 'A/B Test' panel using 'Schedule sending'. | ||
|
|
||
| .. vale off |
There was a problem hiding this comment.
The mautic:email:sendwinner command is introduced in PR #15897 via SendWinnerEmailCommand (COMMAND_NAME = 'mautic:email:sendwinner', optional --id option). The behavior that remaining Emails are sent through the standard broadcast after the winner is determined comes from BroadcastSubscriber::onBroadcast A/B test logic in the same PR.
Source: mautic/mautic#15897
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions.
- Remove 'Screenshot' from image alt text per Mautic UI image guidelines
- Wrap the convert-to-A/B-test ordered list in vale off/on (UI-literal 'email')
- Use Mautic feature term ('Active') instead of 'published' for variants
- Rewrite the scheduling summary in active voice, drop 'will', capitalize 'Contacts'
- Make the :ref: anchor label casing consistent ('ab testing for Segment Emails')
|
Thanks for the detailed review, @adiati98! I've pushed a commit addressing all of these:
Vale is clean on the A/B testing content. Let me know if anything else needs adjusting! |
Address @adiati98 review on PR mautic#811: convert the 'Managing variants' bulleted list to an RST ordered list (#.) so it reads as step-by-step instructions.
|
Thanks @adiati98 — converted the variant-management bullets in the "Managing variants" section into a numbered ( |
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions.
|
Thanks for the detailed review, @adiati98 — I've pushed an update addressing all of your suggestions:
The A/B testing content remains Vale lint-clean. Ready for another look whenever you have a moment. |
|
Applied your suggestion, @adiati98. The
Changed it from a bullet item to a plain sentence to match your wording, preserved the surrounding RST/indentation, and confirmed the line stays Vale-clean. |
Open this suggestion in Promptless to view citations and reasoning process
Adds comprehensive user documentation for A/B testing for Segment Emails, introduced in PR #15897 (Mautic 7). Targets the 7.2 user-documentation branch per the branch-targeting table.
Changes
docs/channels/emails.rst
New "A/B testing for Segment Emails" section covering the shipped workflow:
mautic:email:sendwinnercommand, with remaining Emails sent via standard broadcastdocs/configuration/cron_jobs.rst
New "Determine A/B test winner cron job" section documenting
mautic:email:sendwinner [--id=ID], cross-linked with the emails A/B testing section.Notes
#., unordered lists use*, and prose uses active voice.Trigger Events
Tip: Point @Promptless at some of your docs debt and have it clean them up in the background 🧹