Giter Club home page Giter Club logo

documentation's Introduction

codecov

All Contributors

About Mautic

Mautic is the world’s largest open source marketing automation project. With over 200,000 organisations using Mautic and over 1,000 community volunteers, we empower businesses by making it easy to manage their marketing across a range of channels. Stay up to date about initiatives, releases and strategy via our blog.

Marketing automation has historically been difficult to implement within organisations. The Mautic Community is an example of open source at its best, offering great software and a vibrant and caring community in which to learn and share knowledge.

Open source means more than open code. Open source provides equality for all and a chance for everyone to improve.

Mautic

Get Involved

Before we tell you how to install and use Mautic, we like to shamelessly plug our awesome user and developer communities! Users, start here for inspiration, or follow us on Twitter @MauticCommunity or Facebook @MauticCommunity. Once you’re familiar with using the software, maybe you will share your wisdom with others in our Slack channel.

Calling all devs, testers and tech writers! Technical contributions are also welcome. First, read our general guidelines about contributing. If you want to contribute code, read our CONTRIBUTING.md or Contributing Code docs then check out the issues with the T1 label to get stuck in quickly and show us what you’re made of.

If you have questions, the Mautic Community can help provide the answers.

Installing and using Mautic

Supported Versions

Please check the latest supported versions on the Mautic Releases page.

Software Downloads

The GitHub version is recommended for both development and testing. The production package (including all libraries) is available at mautic.org/download.

Installation

Disclaimer

Install from source only if you are comfortable using the command line. You'll be required to use various CLI commands to get Mautic working and keep it working. If the source/database schema gets out of sync with Mautic releases, the release updater may not work and will require manual updates. For production, we recommend the pre-packaged Mautic which is available at mautic.org/download.

Also note that source code outside of a tagged release should be considered ‘alpha’. It may contain bugs, cause unexpected results, data corruption or loss, and is not recommended for use in a production environment. Use at your own risk.

How to install Mautic

You must already have Composer available on your computer because this is a development release and you'll need Composer to download the vendor packages.

Also note that if you have DDEV installed, you can run 'ddev config' followed by 'ddev start'. This will kick off the Mautic first-run process which will automatically install dependencies and configure Mautic for use. ✨ 🚀 Read more here

Installing Mautic is a simple three-step process:

  1. Download the repository zip then extract the zip to your web root.
  2. Run the composer install command to install the required packages.
  3. Open your browser and complete the installation through the web installer.

If you get stuck, check our our general troubleshooting page. Still no joy? Join our lively Mautic Community for support and answers.

User Documentation

Documentation on how to use Mautic is available at docs.mautic.org.

Developer Docs

Developer documentation, including API reference docs, is available at developer.mautic.org.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Dennis Ameling
Dennis Ameling

💻 📓
Mohammad Abu Musa
Mohammad Abu Musa

💻 📓 👀
John Linhart
John Linhart

📓 👀 💻 ⚠️
Norman Pracht - Webmecanik
Norman Pracht - Webmecanik

📓 💻
Zdeno Kuzmany
Zdeno Kuzmany

📓 👀 💻 ⚠️
Steve Robinson
Steve Robinson

📓 🐛
Petr Šnobl
Petr Šnobl

💻 🐛
Lukas Günther
Lukas Günther

💻 📖 📓
Ruth Cheesley
Ruth Cheesley

📓 👀 📖
Anton Vlasenko
Anton Vlasenko

💻 ⚠️
Miroslav Fedeleš
Miroslav Fedeleš

💻 ⚠️ 📓 👀
gabepri
gabepri

🐛 💻
incentfit
incentfit

📓
Lukáš Drahý
Lukáš Drahý

💻 👀
Alan Hartless (he/him)
Alan Hartless (he/him)

💻
Mohit Aghera
Mohit Aghera

💻 📓 👀
Dom Parry
Dom Parry

📓
sensalot
sensalot

📓
Rahul Shinde
Rahul Shinde

👀 📓 💻
jos0405
jos0405

💻 📓
Nick Veenhof
Nick Veenhof

👀
Patryk Gruszka
Patryk Gruszka

💻 📖 ⚠️ 👀 📓
Alex Hammerschmied
Alex Hammerschmied

💻 📓
Dirk Spannaus
Dirk Spannaus

🐛 📓
Rehan Nischal
Rehan Nischal

🐛
Christophe9880
Christophe9880

📓
Saurabh Gupta
Saurabh Gupta

💻 👀
Tejas Navghane
Tejas Navghane

⚠️ 💻 📓 👀
Florent Petitjean - Webmecanik
Florent Petitjean - Webmecanik

📓
Oluwatobi Owolabi
Oluwatobi Owolabi

📋
Favour Kelvin
Favour Kelvin

📖 📢
Giovanni Mascellani
Giovanni Mascellani

💻
Raphael van der Woude
Raphael van der Woude

📓
mannp
mannp

🐛 📓
MarketSmart
MarketSmart

💻
Leon
Leon

📓
bryanitamazonva
bryanitamazonva

🐛
n-azimy
n-azimy

💻
Ikko Ashimine
Ikko Ashimine

💻
Max Lawton
Max Lawton

💻 📖
Rohit Pavaskar
Rohit Pavaskar

💻
Disha P
Disha P

💻
Adrian
Adrian

👀 📓 💻
vijayhrdm
vijayhrdm

🐛
julienWebmecanik
julienWebmecanik

💻
Johan Buchert
Johan Buchert

📓
TS16V
TS16V

🐛
rafalsk
rafalsk

🐛
Jonathan Dahan
Jonathan Dahan

🐛
j26w
j26w

📓
Theodoros Ploumis
Theodoros Ploumis

💻
Sreenivasulu Avula
Sreenivasulu Avula

📓 👀
Mohammad Lahlouh
Mohammad Lahlouh

📓
ArnaudSau
ArnaudSau

💻
Andrew Bell
Andrew Bell

📓
Alfredo Arena
Alfredo Arena

💻
mollux
mollux

💻
ekkeguembel
ekkeguembel

📓
Madlen
Madlen

📓
Kathrin Schmid
Kathrin Schmid

🌍
Rahul Dhande
Rahul Dhande

💻
Artem Lopata
Artem Lopata

📓 👀 💻
Anthony Bailey
Anthony Bailey

💻
Eloi Marques da Silva
Eloi Marques da Silva

💻
Tomasz Kowalczyk
Tomasz Kowalczyk

💻
jensolsson
jensolsson

📓
Tony Bogdanov
Tony Bogdanov

💻
Brady Cargle
Brady Cargle

📓
mmarton
mmarton

📓
bodrak
bodrak

💻
nick-vanpraet
nick-vanpraet

💻
Volha Pivavarchyk
Volha Pivavarchyk

📓 💻
Nish Joseph
Nish Joseph

💻
Damzoneuh
Damzoneuh

💻
alinmbb
alinmbb

💻
Déborah Salves
Déborah Salves

📓
automatyzuj
automatyzuj

📓
KN4CK3R
KN4CK3R

💻
Benjamin Lévêque
Benjamin Lévêque

💻
Benjamin
Benjamin

💻
Iris Amrein
Iris Amrein

📓
peter.osvath
peter.osvath

💻
poweriguana
poweriguana

📓 📆
OnyXxL
OnyXxL

📓
Dominik Lacković
Dominik Lacković

📓
Omer Toledano
Omer Toledano

📓
ZebruhDivs
ZebruhDivs

📓
Alan Wierzchoń
Alan Wierzchoń

💻
Tomazz Jurich
Tomazz Jurich

📓
putzwasser
putzwasser

🐛
erk
erk

📓
Daniel
Daniel

📓
agencia904
agencia904

📓
mbfds
mbfds

📓
Lucas Lazarini
Lucas Lazarini

📓
Gonzalo Cao Cabeza de Vaca
Gonzalo Cao Cabeza de Vaca

📓
Robmobius
Robmobius

📓
Marc Beinder
Marc Beinder

💻
bergwerkweb
bergwerkweb

💻
Rembrand
Rembrand

📓 💻 👀
TechBill
TechBill

📓
Irfan Hanfi
Irfan Hanfi

💻
Anna Munk
Anna Munk

💻
Sven Döring
Sven Döring

📓
Pedro de Jesus
Pedro de Jesus

💻
Jean-Marc
Jean-Marc

📓
Paul Sanduleac
Paul Sanduleac

💻
Lenon Leite
Lenon Leite

💻
Alan Syrgak
Alan Syrgak

📓
Mohammed Header
Mohammed Header

💻
Dana Linhartová
Dana Linhartová

💻
Thanks
Thanks

⚠️
Patrick
Patrick

📓
Tomas Votruba
Tomas Votruba

💻
Tirtharaj Ghosh
Tirtharaj Ghosh

📖
Ruben Nogueira
Ruben Nogueira

💻
Oleh Vanin
Oleh Vanin

👀
Tim Mallezie
Tim Mallezie

💻
Markus Staab
Markus Staab

💻
code5rick
code5rick

🐛 💻
jcrandell7
jcrandell7

📓
Jason Woods
Jason Woods

💻
Enkhjargal Lkhagvaa
Enkhjargal Lkhagvaa

👀
alexbusu-motork
alexbusu-motork

👀
David Gorges
David Gorges

🐛 💻
Gernot Pansy
Gernot Pansy

🐛 💻
andersonjeccel
andersonjeccel

💻 ️️️️♿️ 📖 🐛 👀 📓 🎨 📆
Alexei Pl
Alexei Pl

🐛 💻
Alvaro
Alvaro

🐛
Ajit
Ajit

💻 🐛
Esthertests
Esthertests

👀
magdalenaleonow
magdalenaleonow

🐛
Priyanshi Gaur
Priyanshi Gaur

💻
Damian
Damian

👀 🐛
Markus Heinilä
Markus Heinilä

👀
Juan Gadiel Rosado Colon
Juan Gadiel Rosado Colon

🐛 📓

This project follows the all-contributors specification. Contributions of any kind welcome!

documentation's People

Contributors

aarono avatar alanhartless avatar aschempp avatar citizenmatt avatar codepiano avatar davidagraf avatar dongilbert avatar escopecz avatar imrodmartin avatar isleshocky77 avatar katzueno avatar kuzmany avatar mandelliant avatar maxell92 avatar mqueme avatar nithinga avatar npracht avatar petertl avatar pierreammeloot avatar ramezrafla avatar rcheesley avatar rlmv avatar samypesse avatar sawanoboly avatar shaform avatar tekapo avatar virgilwashere avatar virlatinus avatar wgxo avatar woeler avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation's Issues

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)

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.

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.

image

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

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.

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.

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)?

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.

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.

image

Please guide how I get this option.

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?

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 ? :)

p Font size of Japanese version is now very small

I now realized that Japanese font size is very small.

image

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?

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

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.

mautic-help-overlap-issue

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.