draft messenger documentation #195
Conversation
Merge main into 5.x branch ready for release
…gues Point groups
email_transport queue is now called just email
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
Move Email config / DSN settings to Configuration section
add custom fields to cron docs
| .. code-block:: php | ||
|
|
||
| 'routing' => [ | ||
| \Symfony\Component\Mailer\Messenger\SendEmailMessage::class => MauticMessengerTransports::EMAIL, | ||
| \Mautic\MessengerBundle\Message\PageHitNotification::class => MauticMessengerTransports::HIT, | ||
| \Mautic\MessengerBundle\Message\EmailHitNotification::class => MauticMessengerTransports::HIT, | ||
| ], |
There was a problem hiding this comment.
What is this information for? Will users need to configure it themselves or change it?
There was a problem hiding this comment.
it is to show how routing is done so it is easier to understand why we configure just the one transport a little lower. so they understand the routing
message => route => transport => handler
| .. code-block:: php | ||
|
|
||
| MauticMessengerTransports::HIT => [ | ||
| 'dsn' => 'sync://', | ||
| 'serializer' => 'messenger.transport.jms_serializer', // Smaller payload | ||
| ], |
There was a problem hiding this comment.
Where should users put this? Or isn't this the default behavior?
There was a problem hiding this comment.
I have described it better now.
|
@escopecz I have fixed the issues and updated. |
There was a problem hiding this comment.
It seems there are unrelated comments in this PR now. But looking at them I think the new doc will have to be registered in docs/index.rst too. I'm also still new to this new doc. @RCheesley might tell for sure.
|
This PR still needs rebasing to 5.x please? Thanks! |
There was a problem hiding this comment.
Thanks for making a start on the docs @galvani !
Some general feedback:
-
Please move messenger/messenger to configuration/messenger - that is where a user would go to find information about configuring the email / messaging systems rather than a totally separate section.
-
Please update index.rst to include it in the section starting at line 40 as follows:
.. toctree::
:caption: Configuration
:maxdepth: 2
:hidden:
configuration/maxmind_license
configuration/command_line_interface
configuration/cron_jobs
configuration/variables
configuration/settings
configuration/messenger
This adds the file to the navigation structure.
-
Please install the Vale linter - it is available for PHPStorm and VSCode (and most other IDEs). This will help to pick up grammar issues as you type and help guide you to fix them. Ask for help if you need it with things like passive->active speech as that is hard to do even for a native speaker (ChatGPT can help sometimes!)
-
Any settings that relate to Messenger from the UI (if any - I wasn't clear on whether any of this is visible in the user interface) should be added to Configuration > Settings - this is where we run through every setting, option and switch in the configuration screens. So explain what they see in the user interface in that file. Link to messenger.rst for more details on what it actually means.
-
We have to consider that this is the user documentation, for predominantly marketers. I think we need a basic overview of what people need to know to use Mautic out of the box - what is configured by default and where, what are the default settings in the config (always useful if you screw something up and need to revert back without the undo functionality!) etc. Then we should have an advanced section which dives into more detail.
I've asked some users to take a look and give some feedback - we will help to work collaboratively on a structure for the information that will work for all users!
| By processing requests in the background, it ensures that the client receives a response before the completion of the request processing. | ||
|
|
||
| **Scalability** | ||
| It provides the flexibility to scale your Mautic instance by adding more workers. |
There was a problem hiding this comment.
Will marketers know what workers are? I don't know if we have explained that concept at all before.
| **Load distribution/control** | ||
| It enables you to balance and control the server load effectively. | ||
|
|
||
| **Improved client response** |
There was a problem hiding this comment.
What are we referring to here when we are talking about clients? Will marketers understand that?
|
@fedys made an update to @galvani 's PR in mautic/mautic#12648 which simplifies the configuration and still enables the option to overwrite it in config-local.php with more advanced configuration if needed. If that PR is accepted, I'll update these docs accordingly. |
|
Closing in favour of #178 |
Docs for mautic/mautic#12314