Skip to content
Merged
21 changes: 19 additions & 2 deletions docs/campaigns/exporting_campaigns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 view.
#. Select the **Export** option. Instead of downloading immediately, Mautic opens the **Share** screen.

|

Expand All @@ -52,6 +52,23 @@ You can export a Campaign in three ways.

|

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 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**
* **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 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.

.. vale on

.. vale off

2.\ Using the command line
Expand Down
7 changes: 7 additions & 0 deletions docs/links/marketplace_mautic_org.py
Original file line number Diff line number Diff line change
@@ -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)})
22 changes: 21 additions & 1 deletion docs/marketplace/marketplace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,32 @@ 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

* 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 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.

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.
Comment thread
adiati98 marked this conversation as resolved.
Comment thread
adiati98 marked this conversation as resolved.

Submitting a 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::

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
**************************
Expand Down
Loading