Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
@RCheesley
RCheesley authored Jan 9, 2024
1 parent bf43a1f commit b3bb876
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions docs/configuration/settings.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -302,8 +302,14 @@ See :ref:`here<contact's unsubscribe email preferences>` to set the Contact's Em
Default frequency rule
======================


.. vale off
* **Do not contact more than <number> each <period>** - This limits the number of Marketing Messages a Contact receives in a certain period of time day, week, month. Transactional messages don't count towards this limit. You can adjust this at the individual Contact level, either manually or by Preference Center setting.

.. vale on
.. note::

More information is available in the :doc:`Default Frequency Rule documentation</contacts/frequency_rules>`.
Expand Down Expand Up @@ -459,22 +465,22 @@ Purpose of the queuing
Mautic can optionally use a queuing mechanism for sending Emails. This feature is essential when running Mautic **at large scale**. It's planned to extend the tasks that can utilize queuing in the future.

When you enable queuing, Emails are no longer sent immediately - for example, within the browser
but put in a queue and sent later using queue consumers (also known as workers). Using consumers help offload workload of your webserver and allows easier scaling of your instance.

When you enable queuing, Emails are no longer sent immediately - for example, within the browser.
but instead, Mautic places them in a queue and sends them later using queue consumers - also known as workers. Using consumers helps to offload the workload of your server, and allows easier scaling of your Mautic instance.```
Mautic doesn't use queues by default
====================================

After installing a fresh instance of Mautic, **the queuing feature is disabled** (the queue DSN is set to ``"sync://"``) as shown in the following screenshot.

Check warning on line 473 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is disabled').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is disabled').", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 473, "column": 68}}}, "severity": "INFO"}

Check warning on line 473 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.

Raw Output:
{"message": "[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 473, "column": 71}}}, "severity": "WARNING"}

Check warning on line 473 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is set').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is set').", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 473, "column": 97}}}, "severity": "INFO"}

After installing a fresh instance of Mautic, **queues aren't used** (By default, Mautic has the queue DSN set to ``"sync://"``) as shown in the following screenshot.
.. image:: images/queue-disabled.png
:width: 600
:alt: Queue is disabled
:alt: Queue is turned off

Check warning on line 477 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is turned').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is turned').", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 477, "column": 15}}}, "severity": "INFO"}

How to enable the queuing
=========================

First you need to choose what technology (queuing transport) will drive your queue. The are several options available at the moment. It is up to you to choose which one fits your needs the best.

Check warning on line 482 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 482, "column": 42}}}, "severity": "INFO"}

Check warning on line 482 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 482, "column": 62}}}, "severity": "WARNING"}

Check warning on line 482 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Contractions] Feel free to use 'it's' instead of 'It is'.

Raw Output:
{"message": "[Google.Contractions] Feel free to use 'it's' instead of 'It is'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 482, "column": 134}}}, "severity": "INFO"}

First you need to decide on a queuing transport to drive your queue. There are several options available at the moment. It's up to you to choose which one fits your needs the best.
**Currently available transports:**

* :ref:`Doctrine`
Expand All @@ -485,9 +491,9 @@ First you need to choose what technology (queuing transport) will drive your que

Doctrine
--------
This transport is easy to setup as it does not require installing any additional extension.
This transport is easy to setup as it doesn't require installing any additional extension.
It uses database table ``messenger_messages`` for storing messages (the table name can be changed via options). The screenshot below shows the basic settings.

It uses database table ``messenger_messages`` for storing messages - the table name can be changed via options. The screenshot below shows the basic settings.
.. image:: images/queue-doctrine.png
:width: 600
:alt: Example of Doctrine transport
Expand Down Expand Up @@ -517,7 +523,7 @@ See :xref:`queue-amqp-transport` for the complete list of configuration options.
Beanstalkd
----------
The Beanstalkd transport requires a running :xref:`Beanstalkd` service and a composer dependency installed via ``composer require symfony/beanstalkd-messenger``.

Check failure on line 525 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Composer' instead of 'composer'.

Raw Output:
{"message": "[Vale.Terms] Use 'Composer' instead of 'composer'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 525, "column": 78}}}, "severity": "ERROR"}
After installing the composer dependency, you can fill in the configuration as follows.
After installing the Composer dependency, you can fill in the configuration as follows.

.. image:: images/queue-beanstalkd.png
:width: 600
Expand All @@ -527,18 +533,18 @@ See :xref:`queue-beanstalkd-transport` for the complete list of configuration op

Amazon SQS
----------
The Amazon SQS transport is ideal when your Mautic instance is hosted on AWS. You will need to install a composer dependency via ``composer require symfony/amazon-sqs-messenger``. See the example of the configuration below.
The Amazon SQS transport is ideal when hosting your Mautic instance on AWS. You need to install a Composer dependency via ``composer require symfony/amazon-sqs-messenger``. See the example of the configuration below.

.. image:: images/queue-amazon-sqs.png
:width: 600
:alt: Example of Amazon SQS transport

See :xref:`queue-amazon-sqs` for the complete list of configuration options.

How to consume messages from the queue
How to consume messages from the Queue
======================================

To start consuming the messages from the queue, you need to run the following Symfony command.
To start consuming the messages from the Queue, you need to run the following Symfony command.

.. code-block::
Expand Down

0 comments on commit b3bb876

Please sign in to comment.