Comprehensive UTM tags documentation (backport of #712 to 7.1) - #921
promptless-for-oss wants to merge 4 commits into
Conversation
to 7.1) Replicates user-documentation PR mautic#712 onto the 7.1 branch: adds an 8-page UTM Tags section under docs/utm_tags/, removes the old docs/channels/utm_tags.rst, repoints its two inbound :doc: links, adds the UTM Tags toctree caption, and adds CPC/DWC to the Vale vocabulary.
| @@ -0,0 +1,166 @@ | |||
| UTM tags overview | |||
There was a problem hiding this comment.
Verbatim backport (7.0 to 7.1) of the UTM tags documentation set authored and reviewed in PR #712. All eight new pages under docs/utm_tags/ (overview, landing pages, asset downloads, forms, emails, dynamic web content, campaign conditions, segment filters) reproduce PR #712's reviewed prose; product-behavior claims are inherited from that review and are not independently re-verifiable here since the Mautic application source is not in this docs repo. Only objective RST-defect fixes were applied during backport (duplicate nested .. note:: directive removed in utm_tags_landing_pages.rst; malformed inline-literal closing backtick fixed in utm_tags_segment_filters.rst; inconsistent utm_medium=Email capitalization normalized to lowercase email in four example URLs) — none altered meaning.
Source: #712
|
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. |
Cherry-picks the content of mautic#712's newest reviewed commit and applies the same outstanding fixes as the 7.0 follow-up, so this backport matches mautic#712's head: - Add the 'UTM tags recorded' Contact timeline screenshot (replaces TODO marker) - Record UTM Tags action-label casing (forms, campaign conditions, overview table) - Host swap yoursite.com/your-mautic.com -> example.com (emails, asset downloads) - referrer -> referer, User_agent -> user_agent (overview REST API bullet) - UTM -> UTM tags intro grammar; DWC line scoped to tracked links; 'links in the Email' - Bold Yes/No condition paths; terminal period on DWC page; 'edit its details' grammar GA-ID image retained as add_google_analytics_id.png for this branch. Vale clean on changed lines.
Follow the actual Campaign Builder UI, which distinguishes the Contact field value condition node's two outputs by green and red connectors rather than 'Yes'/'No' text. Matches the existing green/red path convention in campaigns/campaign_builder.rst. Per maintainer review on mautic#712. (cherry picked from commit eb60fd8)
Open in Promptless
Backports the comprehensive UTM tags documentation from user-documentation PR #712 onto the 7.1 branch, at the maintainer's request. It replaces the single thin
docs/channels/utm_tags.rstpage with a dedicated eight-page UTM Tags section underdocs/utm_tags/— an overview plus per-feature guides for Landing Pages, Asset downloads, Forms, Emails, Dynamic Web Content, Campaign conditions, and Segment filters. The two inbound:doc:links (from Focus Items and Dynamic Web Content) are repointed to the new overview, the old page is removed, the UTM Tags toctree caption is added to the docs index, andCPC/DWCare added to the Vale vocabulary.A few objective RST defects present in the source PR (a nested
.. note::, a malformed inline literal, and inconsistent casing inside example-URL code blocks) are corrected in this backport; a placeholder screenshot TODO in the Forms page is carried over as-is.Trigger Events
Synced from #712 code review (2026-08-14)
Applied maintainer @RCheesley's "Apply suggestions from code review" edits from #712 to keep this backport in step: swapped the placeholder example-URL host to
example.comindocs/utm_tags/utm_tags_forms.rstanddocs/utm_tags/utm_tags_landing_pages.rst(three sample URLs total). All three edits were applied verbatim. The third file changed on #712 (utm_tags_segment_filters.rst, an inline-literal typo fix onutm_content) needed no change here — that defect was already corrected in this backport, so it was a no-op.Synced with #712 current head + outstanding review nits (2026-09-07)
At @adiati98's request (cherry-pick #712's newest reviewed commit into the backports, and apply the outstanding fixes here too), this backport is brought in step with #712's current head:
.. TODO: add screenshotmarker on the Forms UTM page is replaced with the 'UTM tags recorded' Contact timeline screenshot (docs/channels/images/utm_tags/utm_tags_recorded_timeline.png). (Supersedes the earlier "TODO carried over as-is" note.)Record UTM Tagsaction-label casing — matches the on-screen label (verified againstmautic/mauticLeadBundlemessages.ini): fixed inutm_tags_forms.rst,utm_tags_campaign_conditions.rst, and theutm_tags_overview.rstfeature-group table.yoursite.com/your-mautic.com→example.cominutm_tags_emails.rstandutm_tags_asset_downloads.rst(matches RCheesley's merged host decision on EVERYTHING about UTM tags in Mautic #712).referrer→referer,User_agent→user_agentin theutm_tags_overview.rstREST bullet.UTM tags - Urchin Tracking Module - areintro fix; DWC component line narrowed to "tracked links in Dynamic Web Content"; emails step "links in the Email"; terminal period on the DWC page.Both items previously flagged for your call are now resolved per your reply on #712:
Yes/Nooutput-path references (intro, numbered step, and warning) inutm_tags_campaign_conditions.rstto the green/red path terminology the Campaign Builder UI actually uses (green = match, red = no match). Verified againstmautic/mauticapp/bundles/CampaignBundle/Assets/js/campaign.js: aContact field valuecondition node draws a green connector for the match path (--support-success-inverse) and a red connector for the no-match path (--support-error-inverse), with no literalYes/Notext — confirmed identical across 5.2, 6.0, 7.0, 7.1, and 7.2. Matches this repo's owncampaign_builder.rst("Green paths"/"Red paths").Open the … and edit its details:(dropped the stray "the"; kept the "its" wording).The GA-ID screenshot on this branch remains
add_google_analytics_id.png. Vale is clean on all changed lines.