From f89a5c0e5b9a0d006967c41fa191361af1365786 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Tue, 1 Sep 2026 18:02:31 +0000 Subject: [PATCH 1/6] Document Marketplace ratings and reviews, and campaign sharing to the Marketplace Documents the user-facing Marketplace changes from mautic/mautic PR #15904 (New Marketplace API, review, rating), merged to 7.x. Targets the 7.2 docs branch. - docs/marketplace/marketplace.rst: new Ratings and reviews section; Rate & Review now redirects to the public Mautic Marketplace website. - docs/campaigns/exporting_campaigns.rst: Export now opens a Share form offering Download ZIP and Publish. - docs/links/marketplace_mautic_org.py: new xref registry entry. --- docs/campaigns/exporting_campaigns.rst | 9 +++++++-- docs/links/marketplace_mautic_org.py | 7 +++++++ docs/marketplace/marketplace.rst | 24 +++++++++++++++++++++++- 3 files changed, 37 insertions(+), 3 deletions(-) create mode 100644 docs/links/marketplace_mautic_org.py diff --git a/docs/campaigns/exporting_campaigns.rst b/docs/campaigns/exporting_campaigns.rst index 34ae41396..315e33f79 100644 --- a/docs/campaigns/exporting_campaigns.rst +++ b/docs/campaigns/exporting_campaigns.rst @@ -42,8 +42,8 @@ You can export a Campaign in three ways. ========================= #. Go to the **Campaigns** menu. -#. Click the three-dot icon next to the Campaign's name that you want to export to open the options. -#. Select the **Export** option from the dropdown menu. It automatically downloads the ZIP file. +#. Open the options for the Campaign you want to export. These are available from the three-dot icon on the Campaign list row and from the Campaign detail page. +#. Select the **Export** option. Instead of downloading immediately, Mautic opens a **Share** form. | @@ -52,6 +52,11 @@ You can export a Campaign in three ways. | + The **Share** form offers two actions: + + * **Download ZIP** downloads the Campaign export ZIP file, now including a package manifest and any images you added in the form, to your computer, rather than publishing it. Use **Download ZIP** to get the export file, for example to move the Campaign to another Mautic instance. + * **Publish** shares the Campaign to the public Mautic Marketplace as a resource package. Publishing requires a **Title**, **Vendor**, **Version**, and **Description**, and lets you add **Images**. Use **Publish** only to share the Campaign with the wider Mautic community, since publishing makes the Campaign publicly available on the Mautic Marketplace. + .. vale off 2.\ Using the command line diff --git a/docs/links/marketplace_mautic_org.py b/docs/links/marketplace_mautic_org.py new file mode 100644 index 000000000..f514c0a5d --- /dev/null +++ b/docs/links/marketplace_mautic_org.py @@ -0,0 +1,7 @@ +from . import link + +link_name = "Mautic Marketplace website" +link_text = "marketplace.mautic.org" +link_url = "https://marketplace.mautic.org" + +link.xref_links.update({link_name: (link_text, link_url)}) diff --git a/docs/marketplace/marketplace.rst b/docs/marketplace/marketplace.rst index 6c7d148a2..380a564f3 100644 --- a/docs/marketplace/marketplace.rst +++ b/docs/marketplace/marketplace.rst @@ -102,12 +102,34 @@ Context menu ============ The context menu shows actions you can take. -* Close takes you to the List View +* Close takes you to the list view * Install installs the Plugin +* **Rate & Review** redirects you to the public Mautic Marketplace website where you can submit a review for the Plugin + * Issue tracker opens a new window with the issue tracker for the Plugin. It shows only if the Plugin has this information available. Use this option to search for issues with the Plugin and to report new issues to the maintainers. +Ratings and reviews +******************* + +The Mautic Marketplace shows community ratings and reviews for Plugins. This helps you decide which Plugins to install. These community ratings and reviews reflect other users' opinions, not a Mautic-verified guarantee of version compatibility or security, so always verify that a Plugin supports your Mautic version before installing. + +Viewing ratings +=============== + +Each Plugin in the list view shows its average Mautic Marketplace community rating, as a number rather than star icons, and its total review count. This community rating is separate from the Packagist stars shown in the same list, and gives you a quick sense of community feedback before viewing full details. + +On the Plugin detail page, a Reviews panel lists individual reviews from other Mautic users. Each review has a 1 to 5 star rating, the review text, and the reviewer's username. + +Submitting a review +=================== + +To submit a review for a Plugin, click **Rate & Review** in the context menu. This takes you to the public Mautic Marketplace website at :xref:`Mautic Marketplace website` where you can sign in and leave your review. + +.. note:: + + Reviews are managed on the public Mautic Marketplace website, not within your Mautic instance. This lets the community share feedback across all Mautic installations. Command line (CLI) command ************************** From 2706ab2b7be26d7fd7fcd2ff3929f3992a4e3a5b Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Tue, 1 Sep 2026 18:57:28 +0000 Subject: [PATCH 2/6] Address Vale warnings on Marketplace reviews and Campaign sharing docs Reword changed lines to clear Mautic.FeatureList and Google.Passive Vale findings flagged on the PR diff, without altering documented behavior: - marketplace.rst: 'other users' opinions' -> 'other people's opinions'; 'Plugin detail page' -> 'When you open a Plugin' (avoids the page swap and the detail-page/detail-view inconsistency); 'other Mautic users' -> 'other community members'; active-voice note ('The public Mautic Marketplace website manages reviews'). - exporting_campaigns.rst: 'Campaign detail page' -> 'detail view'; removed bare-verb 'publishing'; fixed ambiguous pronoun and duplicated destination in the Share form bullets. Residual Mautic.FeatureList suggestions on 'form' (the Share form) and the bold **Publish** button label are accepted false positives on correct UI terminology per the Mautic style guide. --- docs/campaigns/exporting_campaigns.rst | 8 ++++---- docs/marketplace/marketplace.rst | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/campaigns/exporting_campaigns.rst b/docs/campaigns/exporting_campaigns.rst index 315e33f79..f33c1c252 100644 --- a/docs/campaigns/exporting_campaigns.rst +++ b/docs/campaigns/exporting_campaigns.rst @@ -42,8 +42,8 @@ You can export a Campaign in three ways. ========================= #. Go to the **Campaigns** menu. -#. Open the options for the Campaign you want to export. These are available from the three-dot icon on the Campaign list row and from the Campaign detail page. -#. Select the **Export** option. Instead of downloading immediately, Mautic opens a **Share** form. +#. Open the options for the Campaign you want to export. These are available from the three-dot icon on the Campaign list row and from the Campaign detail view. +#. Select the **Export** option. Instead of downloading immediately, Mautic opens the **Share** form. | @@ -54,8 +54,8 @@ You can export a Campaign in three ways. The **Share** form offers two actions: - * **Download ZIP** downloads the Campaign export ZIP file, now including a package manifest and any images you added in the form, to your computer, rather than publishing it. Use **Download ZIP** to get the export file, for example to move the Campaign to another Mautic instance. - * **Publish** shares the Campaign to the public Mautic Marketplace as a resource package. Publishing requires a **Title**, **Vendor**, **Version**, and **Description**, and lets you add **Images**. Use **Publish** only to share the Campaign with the wider Mautic community, since publishing makes the Campaign publicly available on the Mautic Marketplace. + * **Download ZIP** downloads the Campaign export ZIP file, now including a package manifest and any images you added in the form, to your computer, instead of sharing the Campaign publicly. Use **Download ZIP** to get the export file, for example to move the Campaign to another Mautic instance. + * **Publish** shares the Campaign to the public Mautic Marketplace as a resource package. It requires a **Title**, **Vendor**, **Version**, and **Description**, and lets you add **Images**. Use **Publish** only to share the Campaign with the wider Mautic community, since anyone can then access it on the Mautic Marketplace. .. vale off diff --git a/docs/marketplace/marketplace.rst b/docs/marketplace/marketplace.rst index 380a564f3..66d69416c 100644 --- a/docs/marketplace/marketplace.rst +++ b/docs/marketplace/marketplace.rst @@ -113,14 +113,14 @@ The context menu shows actions you can take. Ratings and reviews ******************* -The Mautic Marketplace shows community ratings and reviews for Plugins. This helps you decide which Plugins to install. These community ratings and reviews reflect other users' opinions, not a Mautic-verified guarantee of version compatibility or security, so always verify that a Plugin supports your Mautic version before installing. +The Mautic Marketplace shows community ratings and reviews for Plugins. This helps you decide which Plugins to install. These community ratings and reviews reflect other people's opinions, not a Mautic-verified guarantee of version compatibility or security, so always verify that a Plugin supports your Mautic version before installing. Viewing ratings =============== Each Plugin in the list view shows its average Mautic Marketplace community rating, as a number rather than star icons, and its total review count. This community rating is separate from the Packagist stars shown in the same list, and gives you a quick sense of community feedback before viewing full details. -On the Plugin detail page, a Reviews panel lists individual reviews from other Mautic users. Each review has a 1 to 5 star rating, the review text, and the reviewer's username. +When you open a Plugin, a Reviews panel lists individual reviews from other community members. Each review has a 1 to 5 star rating, the review text, and the reviewer's username. Submitting a review =================== @@ -129,7 +129,7 @@ To submit a review for a Plugin, click **Rate & Review** in the context menu. Th .. note:: - Reviews are managed on the public Mautic Marketplace website, not within your Mautic instance. This lets the community share feedback across all Mautic installations. + The public Mautic Marketplace website manages reviews, not your Mautic instance. This lets the community share feedback across all Mautic installations. Command line (CLI) command ************************** From 5d66c26378251722b1d5a0763eb6a03a8f789bca Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Tue, 1 Sep 2026 19:29:32 +0000 Subject: [PATCH 3/6] Use accurate 'Publish to Marketplace' button label and resolve Vale warning Address @adiati98's review on PR #939: the Campaign Share form's submit button is literally 'Publish to Marketplace' (mautic.campaign.share.publish), not the bare 'Publish' that tripped the Mautic.FeatureList Vale rule. Use the code-accurate label and fence the button-label bullets with .. vale off/on so the entity activate/deactivate substitution no longer misfires on the button proper-name. --- docs/campaigns/exporting_campaigns.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/campaigns/exporting_campaigns.rst b/docs/campaigns/exporting_campaigns.rst index f33c1c252..f3c468824 100644 --- a/docs/campaigns/exporting_campaigns.rst +++ b/docs/campaigns/exporting_campaigns.rst @@ -54,8 +54,12 @@ You can export a Campaign in three ways. The **Share** form offers two actions: + .. vale off + * **Download ZIP** downloads the Campaign export ZIP file, now including a package manifest and any images you added in the form, to your computer, instead of sharing the Campaign publicly. Use **Download ZIP** to get the export file, for example to move the Campaign to another Mautic instance. - * **Publish** shares the Campaign to the public Mautic Marketplace as a resource package. It requires a **Title**, **Vendor**, **Version**, and **Description**, and lets you add **Images**. Use **Publish** only to share the Campaign with the wider Mautic community, since anyone can then access it on the Mautic Marketplace. + * **Publish to Marketplace** shares the Campaign publicly as a resource package on the Mautic Marketplace. It requires a **Title**, **Vendor**, **Version**, and **Description**, and lets you add **Images**. Use **Publish to Marketplace** only to share the Campaign with the wider Mautic community, since anyone can then access it there. + + .. vale on .. vale off From 3beed7868075cba45e887e3c8bc0f8bb4a0171c6 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Wed, 2 Sep 2026 12:48:27 +0000 Subject: [PATCH 4/6] Apply review feedback: correct Rate & Review placement and Campaign Share fields - marketplace.rst: Rate & Review is a standalone star-icon button on the Plugin detail page (not a context-menu item); opens the Plugin's own page on the Marketplace website in a new browser tab - exporting_campaigns.rst: correct Publish to Marketplace to five required fields (Name, Vendor Name, Package Version, Headline, Description) with constraints, optional fields, and image handling Addresses reviews by @vukovicpredrag on PR #939, verified against mautic/mautic 7.x. --- docs/campaigns/exporting_campaigns.rst | 10 +++++++++- docs/marketplace/marketplace.rst | 4 +--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/campaigns/exporting_campaigns.rst b/docs/campaigns/exporting_campaigns.rst index f3c468824..77a9eb628 100644 --- a/docs/campaigns/exporting_campaigns.rst +++ b/docs/campaigns/exporting_campaigns.rst @@ -57,7 +57,15 @@ You can export a Campaign in three ways. .. vale off * **Download ZIP** downloads the Campaign export ZIP file, now including a package manifest and any images you added in the form, to your computer, instead of sharing the Campaign publicly. Use **Download ZIP** to get the export file, for example to move the Campaign to another Mautic instance. - * **Publish to Marketplace** shares the Campaign publicly as a resource package on the Mautic Marketplace. It requires a **Title**, **Vendor**, **Version**, and **Description**, and lets you add **Images**. Use **Publish to Marketplace** only to share the Campaign with the wider Mautic community, since anyone can then access it there. + * **Publish to Marketplace** shares the Campaign publicly as a resource package on the Mautic Marketplace. Use it only to share the Campaign with the wider Mautic community, since anyone can then access it. It requires five fields: + + * **Name** + * **Vendor Name**, which must use lowercase letters, numbers, and hyphens. The name 'mautic' is reserved. + * **Package Version**, which must follow :xref:`semantic versioning`, formatted as major.minor.patch (for example, ``1.2.0``). + * **Headline**, which is limited to 60 characters. + * **Description**, which must be at least 100 characters. + + You can also add optional fields: **Keywords**, **Works with**, and **Languages**. Select at least one Mautic version under **Works with** before publishing. To include images, add a **Banner Image** and a gallery of additional images, each with its own alt text description. .. vale on diff --git a/docs/marketplace/marketplace.rst b/docs/marketplace/marketplace.rst index 66d69416c..31351082a 100644 --- a/docs/marketplace/marketplace.rst +++ b/docs/marketplace/marketplace.rst @@ -106,8 +106,6 @@ The context menu shows actions you can take. * Install installs the Plugin -* **Rate & Review** redirects you to the public Mautic Marketplace website where you can submit a review for the Plugin - * Issue tracker opens a new window with the issue tracker for the Plugin. It shows only if the Plugin has this information available. Use this option to search for issues with the Plugin and to report new issues to the maintainers. Ratings and reviews @@ -125,7 +123,7 @@ When you open a Plugin, a Reviews panel lists individual reviews from other comm Submitting a review =================== -To submit a review for a Plugin, click **Rate & Review** in the context menu. This takes you to the public Mautic Marketplace website at :xref:`Mautic Marketplace website` where you can sign in and leave your review. +To submit a review for a Plugin, click the **Rate & Review** button on the Plugin detail page. **Rate & Review** is a separate button, marked with a star icon. It isn't in the context menu. Clicking it opens that Plugin's own page on the public Mautic Marketplace website at :xref:`Mautic Marketplace website` in a new browser tab, where you can sign in and leave your review. .. note:: From 6b03232b13e07584ffa59c2b54b10d6e2b3b5151 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Fri, 4 Sep 2026 17:47:45 +0000 Subject: [PATCH 5/6] Address @adiati98 review: hyphen for example, active voice on Headline field - Package Version: replace parenthetical example with hyphen construction (house style) - Headline: rewrite passive 'is limited to' as active 'must be 60 characters or fewer' Reviews panel capitalization confirmed correct against Mautic 7.x source (marketplace.reviews='Reviews' panel-title), so left unchanged. --- docs/campaigns/exporting_campaigns.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/campaigns/exporting_campaigns.rst b/docs/campaigns/exporting_campaigns.rst index 77a9eb628..b461b72b1 100644 --- a/docs/campaigns/exporting_campaigns.rst +++ b/docs/campaigns/exporting_campaigns.rst @@ -61,8 +61,8 @@ You can export a Campaign in three ways. * **Name** * **Vendor Name**, which must use lowercase letters, numbers, and hyphens. The name 'mautic' is reserved. - * **Package Version**, which must follow :xref:`semantic versioning`, formatted as major.minor.patch (for example, ``1.2.0``). - * **Headline**, which is limited to 60 characters. + * **Package Version**, which must follow :xref:`semantic versioning`, formatted as major.minor.patch - for example, ``1.2.0``. + * **Headline**, which must be 60 characters or fewer. * **Description**, which must be at least 100 characters. You can also add optional fields: **Keywords**, **Works with**, and **Languages**. Select at least one Mautic version under **Works with** before publishing. To include images, add a **Banner Image** and a gallery of additional images, each with its own alt text description. From 19a05d6c7321cc7927f4e6cafed5150b0217a0c0 Mon Sep 17 00:00:00 2001 From: promptless-for-oss Date: Fri, 4 Sep 2026 18:32:07 +0000 Subject: [PATCH 6/6] Address @adiati98 Vale review: reword to clear Mautic.FeatureList annotations Reword to avoid Vale Mautic.FeatureList false positives on the PR's changed lines (reviewdog INFO annotations on PR #939): - marketplace.rst: 'Plugin detail page' -> 'Plugin's detail view'; 'own page' -> 'own listing' (not the Mautic Landing Page feature) - exporting_campaigns.rst: 'Share form' -> 'Share screen' (not the Mautic Form feature); update the dependent 'in the form' reference to 'on the Share screen' to keep the antecedent. --- docs/campaigns/exporting_campaigns.rst | 6 +++--- docs/marketplace/marketplace.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/campaigns/exporting_campaigns.rst b/docs/campaigns/exporting_campaigns.rst index b461b72b1..47e2fc51e 100644 --- a/docs/campaigns/exporting_campaigns.rst +++ b/docs/campaigns/exporting_campaigns.rst @@ -43,7 +43,7 @@ You can export a Campaign in three ways. #. Go to the **Campaigns** menu. #. Open the options for the Campaign you want to export. These are available from the three-dot icon on the Campaign list row and from the Campaign detail view. -#. Select the **Export** option. Instead of downloading immediately, Mautic opens the **Share** form. +#. Select the **Export** option. Instead of downloading immediately, Mautic opens the **Share** screen. | @@ -52,11 +52,11 @@ You can export a Campaign in three ways. | - The **Share** form offers two actions: + The **Share** screen offers two actions: .. vale off - * **Download ZIP** downloads the Campaign export ZIP file, now including a package manifest and any images you added in the form, to your computer, instead of sharing the Campaign publicly. Use **Download ZIP** to get the export file, for example to move the Campaign to another Mautic instance. + * **Download ZIP** downloads the Campaign export ZIP file, now including a package manifest and any images you added on the **Share** screen, to your computer, instead of sharing the Campaign publicly. Use **Download ZIP** to get the export file, for example to move the Campaign to another Mautic instance. * **Publish to Marketplace** shares the Campaign publicly as a resource package on the Mautic Marketplace. Use it only to share the Campaign with the wider Mautic community, since anyone can then access it. It requires five fields: * **Name** diff --git a/docs/marketplace/marketplace.rst b/docs/marketplace/marketplace.rst index 31351082a..52d2afb7f 100644 --- a/docs/marketplace/marketplace.rst +++ b/docs/marketplace/marketplace.rst @@ -123,7 +123,7 @@ When you open a Plugin, a Reviews panel lists individual reviews from other comm Submitting a review =================== -To submit a review for a Plugin, click the **Rate & Review** button on the Plugin detail page. **Rate & Review** is a separate button, marked with a star icon. It isn't in the context menu. Clicking it opens that Plugin's own page on the public Mautic Marketplace website at :xref:`Mautic Marketplace website` in a new browser tab, where you can sign in and leave your review. +To submit a review for a Plugin, click the **Rate & Review** button on the Plugin's detail view. **Rate & Review** is a separate button, marked with a star icon. It isn't in the context menu. Clicking it opens that Plugin's own listing on the public Mautic Marketplace website at :xref:`Mautic Marketplace website` in a new browser tab, where you can sign in and leave your review. .. note::