mautic/documentation

Mautic End User Documentation

Mautic Documentation

THIS REPOSITORY IS NOW DEPRECATED. PLEASE MAKE PR'S AGAINST GITHUB.COM/MAUTIC/MAUTIC-DOCUMENTATION

Introduction

This Gitbook repository serves as the documentation for Mautic, the open source marketing automation system.

Everyone is welcome to contribute to improve this information as needed.

Download documentation as a PDF

Download the official Mautic documentation as a PDF in:

• English
• French
• Japanese

Mautic Developer documentation

If you are looking for details about the Mautic API, webhooks, theme or plugin development, please see the developer documentation.

Contributing to the Mautic documentation

See CONTRIBUTING

License

The Mautic official end user documentation is licensed under the Apache 2.0, a permissive license whose main conditions require preservation of copyright and license notices. Read more.

documentation's Issues

WebhookQueueEvent class returning wrong objects for "getWebhookQueue" and "getWebhook" methods

The app/bundles/WebhookBundle/Event/WebhookQueueEvent.php class' "getWebhookQueue()" method is returning $this->getWebhookQueue() which should be returning $this->entity and "getWebhook()" method is returning $this->getWebhook() which should be returning $this->webhook;

Please fix this issue as it is throwing errors recursively. Thanks

Possible wrong command in 'Cron Jobs' chapter

It seems that one of the cron commands in the chapter 'Cron Jobs' is not correct.
On that manual page of 'Cron Jobs' (beneath the 'To execute campaigns events:') it says: "php /path/to/mautic/app/console mautic:campaigns:update --env=prod" but I think it should be "php /path/to/mautic/app/console mautic:campaigns:trigger --env=prod". I'm not shure if I'm correct or not.

Section navigation prevents copy/paste by drag on Chrome

The previous and next navigation regions on pages overlap the help text body, as seen in the image. On Chrome this prevents copying a line if the cursor enters the navigation region. Triple clicking or clicking above the text to be selected and dragging outside of the region does work. Increasing the max-width of the content and the navigation controls, or narrowing the overlapping region should resolve.

Whats new is very outdated!

Need to bring this up to date!

Confusing list tag (CSS)

This may be related to #272

List tag CSS is not really well-balanced.
https://www.mautic.org/docs/en/emails/troubleshooting.html

It's hard to see which is new list items.

Automated email open tracking pixel is not recognised by gmail

Hi, recently found out Mautic as a serious flaw in the way that automated pixel is generated.

In the file "app/bundles/EmailBundle/Helper/MailHelper.php" line 879

$trackingImg = '<img style="display: none;" height="1" width="1" src="{tracking_pixel}" alt="Mautic is open source marketing automation" />';

Mautic email helper append style="display: none;" to the tracking pixel, that lead gmail not showing and rendering the pixel to the user. Since tracking openers is an important feature and gmail is a major email service provider we should remove style="display: none;" to the MailHelper.php file.

Another workaround would be to change style="display: none;" to style="display:none !important;" which is recognised by gmail. I did not tested out other major email service providers like yahoo, outlook or aol. But the removal is the best option imho.

add missing french doc

To do

• CRON jobs
• Getting started
• Tips/troubleshooting

needs CI to validate rendering to web

This repository contains both .travis.yml and appveyor.yml, but no CI build jobs are visible on any of the PRs. It's important that contributors are able to validate how their proposed changes in PRs render to HTML, to check that they will look right on the website when merged. Ideally there would be a CI job which outputs the rendered version as viewable artifacts.

Doc menu similar to Mautic admin

Proposition before pull request. Documentation's menu should be similar to Mautic administration interface to be user friendly. New Menu design accordingly:

1. Overview (add + text)
2. DashBorad
3. Calendar (add + text)
4. Contacts
5. Segments (add + text)
6. Components
7. Campaigns (up)
8. Channels (down)
9. Points
10. Stages (add + text)
11. Reports (down)

Cron > Tips & Troubleshooting

Under "Tips & Troubleshooting" section, there is an example of how to pipe cron output to a file:

To assist in troubleshooting cron issues, you can pipe the output of each cron job to a specific file by adding something like >/path/to/somefile.log 2>&1 at the end of the cron job.

But this would overwrite the log on every cron run, which isn't too useful. Better to use >> to append log.

missing marketing messages doc

Broken images on web notifications documentation

There are several broken images on the web notifications documentation, flagging so I can come back and fix it later!

campaign builder havn't *Send Text Message* action option

Hi

I want to Set the text message in mautic v2.16.0 . I have set the Twilio account details also. After that as per the document below, I went to the Campaigns --> and open the campaign builder but I didn't find any option like Send Text Message action see below screenshot

1. Go to Campaigns.
2. Edit an existing campaign or create a new one.
3. Open the Campaign Builder.
4. Add a Send Text Message action to the canvas.

Please guide how I get this option.

p Font size of Japanese version is now very small

I now realized that Japanese font size is very small.

I've notoced that

If we remove

p {
    font-size: 1rem;
}

from CSS, it will solve the issue.
However, I cannot seem to find where this CSS was set.

It could be coming from Mautic WordPress Theme, and messing up the CSS file?

'addLead' variables order is $listId, $leadId. Not the other way around.

The documentation says:
$listApi->addLead($leadId, $listId);

Should be:
$listApi->addLead($listId, $leadId);

JS tracking code has moved to Tracking Settings

The JS tracking code has moved from 'Landing Page Settings' to 'Tracking Settings'

Notifciations - images missing

Two images missing on https://mautic.org/docs/en/notifications/index.html but already exist in repositary.

Elastic Email integration documentation disappear

This PR was merged but doesn't show in documentation #126

Missing 'Search' documentation page

In section 4.1, there is a line: "You can learn more about the powerful search options available on the search documentation page."

However, I can't find a search documentation page. Does this exist?

Tail end of variables has broken layout

@virgilwashere just noticed the tail end of the Variables file seems to fall out of the table - see https://www.mautic.org/docs/en/setup/VARIABLES.html

Separating database reads and writes

Can mautic separate database reads and writes to utilize read replicas? Thank you.

Wrong command in bounce processing

Cron command for processing bounced mails is written like this in the doc

php app/console mautic:fetch:email

While correct version is

php app/console mautic:email:fetch

Web push notification doc is missing

Hi,

It seems that web push notification mautic/mautic#1656 is a great feature. But it's not usable without a documentation. Could someone (@dongilbert ?) write this?
Thanks for help,

N.

Contact stage doc is missing

Hi,

It seems that contact stage management mautic/mautic#1770 is a great feature. But it's hard to correctly use without a documentation. Could someone (@mqueme ?) write this?
Thanks for help,

N.

Link to contrib file doesn't work from the web-rendered version

@virgilwashere the contrib file results in a 404 - maybe this file is excluded by Gitbook?

https://www.mautic.org/docs/en/CONTRIBUTING.md is the generated link

Download as PDF! Link is broken

Download as PDF! Link is broken

Mautic.org site documentation UX scroll case (incorect scroll position).

@Techmind commented on Thu Dec 20 2018

Not sure, that this is the right place for this sort of issue.

Loom video explaining: https://www.useloom.com/share/207dd7c3cbde4f1d8f3e560698e57455

Bug Description

Text description:
Trying to read the documentation on site is irritating because then you click on the link at the side menu (table of contents) scroll stays at the same height.

Browser: Chromium Version 67.0.3396.99
OS: Ubuntu 16.04

Steps to reproduce

1. Go to https://www.mautic.org/docs/en/index.html
2. Click '6.1.2. Bounce Management'
3. A page opens with scroll position at the middle of the page

Expected:
3. A page opens with scroll position at the top of the page

---

@npracht commented on Thu Jan 03 2019

@escopecz with beta of github you might be able to move the issue to mautic/documentation repo. Could you ? :)

Menu: target should lead to top page

When clicking on documentation left menu, the reader should land on the top of the page, not at the bottom.

Social Monitoring on Cron Documentation

Social Monitoring Cron Job is not listed on the Cron Documentation page.

e.g. */5 * * * * /usr/bin/php /www/app/console mautic:social:monitoring --env=prod

Relative paths for images

I had made a pull request (#131) to correct the image notation in the docs for the Salesforce plugin so that it would display on github as well (I believe) on the docs website.

However, after reading the first page of the docs I see that it is recommended that the image paths are absolute root relative (i.e. "/plugin/media/image.png").

For linking between pages it is recommended to do relative paths (i.e. "./../plugin/page2.html)

The latter works on github as well, why are the images done with absolute paths? Can we change this so images are displayed on the docs page as well as in github and people's local machines (clone'd code)?

Incorrect PDF documentation link

The link "Click here to download these docs as a PDF." https://mautic.org/docs/mautic_docs.pdf in the "Download as PDF" section is invalid.

Contact Monitoring Markdown Formatting Awry

Certain sections are being formatted as code blocks, when really they should be broken up into smaller pieces.

There is likely a missing triple-tick ```, and once that is addressed everything will be fixed.

There is no folder called `app/cache` in Mautic mention in getting started document

While installation of Mautic found one issue is mentioned on getting started with Mautic documentation.
https://docs.mautic.org/en/setup/getting-started. As I know only var/cache folder exist, there no existence of folder app/cache.

Correct document reference : https://docs.mautic.org/en/troubleshooting/file-ownership-and-permissions

Fixed for this change text from app/cache to var/cache

documentation building instructions missing

The README.md in this repo is quite nice and detailed, but it omits one crucial detail: how the documentation is rendered into an HTML website. This is problematic because contributors need to be able to test how their proposed doc changes render. Ideally this would be possible to do locally before submitting any PR, to avoid wasting other people's time reviewing changes which aren't yet rendering correctly. But at very least it should be possible to check the rendered version of the PR via the output of a CI job. I've filed #311 regarding the latter.