From e2f995d5ea8811aa7abc40d411b1958d26154a1b Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 14:25:09 +0100 Subject: [PATCH 01/10] Fix too short header underline --- docs/components/assets.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/components/assets.rst b/docs/components/assets.rst index 56691901..4d9bf05e 100644 --- a/docs/components/assets.rst +++ b/docs/components/assets.rst @@ -144,7 +144,7 @@ It's possible to delete an Asset by clicking on the 'delete' button while viewin Once deleted, you can't retrieve an Asset, and statistics relating to the number of downloads for that Asset are no longer be available. Contact Points accumulated as a result of accessing the resource remain. It's recommended where possible to unpublish Assets which are no longer in use - in future there may be an archive feature. Display Assets directly in the browser -============================ +====================================== By default, Mautic supports the following file types for direct display in the browser: From bb8c1e299911e07bd20d856ab7440f17705cabf8 Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 14:30:13 +0100 Subject: [PATCH 02/10] Fix duplicated headings --- docs/configuration/settings.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/configuration/settings.rst b/docs/configuration/settings.rst index 7f1ee1dd..08364c46 100644 --- a/docs/configuration/settings.rst +++ b/docs/configuration/settings.rst @@ -387,8 +387,8 @@ Unsubscribe settings .. vale off -Tracking Opened Emails -====================== +How to track opened Emails +========================== .. vale on @@ -400,8 +400,8 @@ It's possible to turn off the tracking pixel entirely if you don't need to use i .. vale off -Tracking links in Emails -======================== +How to track links in Emails +============================ .. vale on @@ -468,7 +468,7 @@ Company settings * **Merge by unique fields with operator** - You can determine which operator to use when merging fields if there is more than one unique identifier. Queue settings -**************** +************** Purpose of the queuing ====================== From c349784dfdf2229486c7b2ec222595d7fed5f64b Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 14:31:28 +0100 Subject: [PATCH 03/10] Fix duplicated heading --- docs/contacts/manage_contacts.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contacts/manage_contacts.rst b/docs/contacts/manage_contacts.rst index ab5aa8e4..092691fd 100644 --- a/docs/contacts/manage_contacts.rst +++ b/docs/contacts/manage_contacts.rst @@ -504,8 +504,8 @@ All the UTM tags are available in the time entry, just by toggling the entry det Please note that Mautic records UTM tags only on a Form submission that contains the action "Record UTM Tags". -Contact fields -~~~~~~~~~~~~~~ +Updating Contact fields +~~~~~~~~~~~~~~~~~~~~~~~ You can also pass information specific to your Contact by setting Mautic Contact ``field(s)`` to be publicly editable. Note that values appended to the tracking pixel should be ``url`` encoded - %20 for spaces, %40 for @, etc. From 949050c3fec5d7c809314a3f1db81ef20ac26050 Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 14:32:27 +0100 Subject: [PATCH 04/10] Update duplicated labels --- docs/contacts/manage_contacts.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/contacts/manage_contacts.rst b/docs/contacts/manage_contacts.rst index 092691fd..1612631c 100644 --- a/docs/contacts/manage_contacts.rst +++ b/docs/contacts/manage_contacts.rst @@ -523,15 +523,15 @@ If you're using a Content Management System, the easiest way is to let one of th Here are a couple code snippets that may help as well: -HTML -~~~~ +HTML snippet +~~~~~~~~~~~~ .. code-block:: shell mautic is open source marketing automation -PHP -~~~ +PHP snippet +~~~~~~~~~~~ .. code-block:: php @@ -543,8 +543,8 @@ PHP echo ''; -JavaScript -~~~~~~~~~~ +JavaScript snippet +~~~~~~~~~~~~~~~~~~ .. code-block:: javascript From 43bb523eb933ccecdab5c60df9cd1fb117b4d55b Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 14:32:54 +0100 Subject: [PATCH 05/10] Remove reference to Citrix --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 0b36867c..ae9f508e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -162,7 +162,6 @@ There are different types of documentation available to help you navigate your w plugins/plugin_resources plugins/amazon - plugins/citrix plugins/clearbit plugins/connectwise plugins/fullcontact From f4fc01240f9bd75a2446f01889dd07ea130a9632 Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 14:37:34 +0100 Subject: [PATCH 06/10] Fix duplicated headings --- docs/points/point_groups.rst | 18 +++++------------- docs/queue/queue.rst | 8 ++++---- docs/segments/manage_segments.rst | 8 ++++---- 3 files changed, 13 insertions(+), 21 deletions(-) diff --git a/docs/points/point_groups.rst b/docs/points/point_groups.rst index ab2acad3..55801c78 100644 --- a/docs/points/point_groups.rst +++ b/docs/points/point_groups.rst @@ -27,25 +27,17 @@ Enter a name and a description for the Group and click the "Save & Close" button Point Groups usage =================== -Point Actions -------------- - -.. vale on - +Using Point actions +------------------- You can change Contact's Points within a Points Group by using Points Actions. .. image:: images/point-action-with-group.png :width: 600 :alt: Screenshot of Points action with Group -.. vale off - -Point Triggers --------------- - -.. vale on - -You can use Point Triggers based on Point Groups to automatically trigger specific events within the system. +Using Point triggers +-------------------- +You can use Point triggers based on Point Groups to automatically trigger specific events within the system. .. image:: images/point-trigger-with-group.png :width: 600 diff --git a/docs/queue/queue.rst b/docs/queue/queue.rst index d77adbb7..7aad4e44 100644 --- a/docs/queue/queue.rst +++ b/docs/queue/queue.rst @@ -24,8 +24,8 @@ You can activate and configure the queuing mechanism by going to configuration: .. vale off -RabbitMQ -******** +Using RabbitMQ +************** .. vale on @@ -76,8 +76,8 @@ Example: 'rabbitmq_idle_timeout_exit_code' => 0, -Beanstalkd -********** +Using Beanstalkd +**************** :xref:`Beanstalkd` is another available queue protocol that Mautic supports. To use it, you must have a Beanstalkd server running. On :xref:`Beanstalkd website`, you can obtain instructions on how to install Beanstalkd. diff --git a/docs/segments/manage_segments.rst b/docs/segments/manage_segments.rst index c794ffc7..3dfbece8 100644 --- a/docs/segments/manage_segments.rst +++ b/docs/segments/manage_segments.rst @@ -135,8 +135,8 @@ Adding individual Contacts .. vale off -Campaign action -=============== +Using a Campaign action +======================= .. vale on @@ -257,8 +257,8 @@ Dynamic Segments Mautic moves Contacts into and out of dynamic Segments based on the filters applied to the Segment. As the data associated with the Contact updates, including Company associations and behaviors, Mautic updates Segment membership. -Segment filters -=============== +Configuring Segment filters +=========================== .. image:: images/filter-list.png :width: 400 From 195062f792a21e21b0df0f535f61da7561500a2a Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 15:14:24 +0100 Subject: [PATCH 07/10] Fix duplicate headings --- docs/configuration/settings.rst | 4 ++-- docs/plugins/clearbit.rst | 8 ++++---- docs/plugins/plugin_resources.rst | 4 ++-- docs/plugins/vtiger.rst | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/configuration/settings.rst b/docs/configuration/settings.rst index 08364c46..43d8effe 100644 --- a/docs/configuration/settings.rst +++ b/docs/configuration/settings.rst @@ -264,8 +264,8 @@ The table below lists available transport Plugins created for Mautic to include - ``composer require ts-navghane/sparkpost-plugin`` .. vale on -Queue settings -============== +Configuring the Queue +===================== The system can either send Emails immediately or queue them for processing in batches by a :doc:`cron job `. Documentation relating to configuring the queue is in the :doc:`queue ` section. diff --git a/docs/plugins/clearbit.rst b/docs/plugins/clearbit.rst index 359ad412..e553edac 100644 --- a/docs/plugins/clearbit.rst +++ b/docs/plugins/clearbit.rst @@ -5,8 +5,8 @@ This Plugin can: * Pull data from Clearbit via the API about Contacts and Companies into Mautic. -Requirements -************ +Clearbit Plugin Requirements +**************************** * Mautic installed on a publicly accessible URL. Due to the need for callbacks from Clearbit to Mautic, this Plugin won't work on a localhost. @@ -18,8 +18,8 @@ Authorize the Plugin .. image:: images/screenshot-consoleawsamazoncom-20200413-214631-35da93f9.png :alt: Screenshot of Clearbit -Usage -****** +Clearbit Plugin Usage +********************* A dropdown menu and a toolbar at the top are both present on the Contacts and Companies pages: diff --git a/docs/plugins/plugin_resources.rst b/docs/plugins/plugin_resources.rst index 55627a32..0a320800 100644 --- a/docs/plugins/plugin_resources.rst +++ b/docs/plugins/plugin_resources.rst @@ -57,8 +57,8 @@ Use any of those actions to test the Plugin and see if the Contact appears in th 5. Ensure that the Integration created the new Contact. -Troubleshooting ---------------- +Troubleshooting Plugins +----------------------- If the ``firstname`` value wasn't saved to the Integration: diff --git a/docs/plugins/vtiger.rst b/docs/plugins/vtiger.rst index a9d86a68..cc8ef897 100644 --- a/docs/plugins/vtiger.rst +++ b/docs/plugins/vtiger.rst @@ -70,8 +70,8 @@ If you want to use the Plugin, you have to publish it. .. vale off -Test the Plugin -*************** +Test the VTiger CRM Plugin +************************** .. vale on From 2af8092e5034687bd0dd3ca8a0356ca652e3c932 Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 15:16:07 +0100 Subject: [PATCH 08/10] Fix missing line breaks --- docs/translations/translations.rst | 2 ++ docs/troubleshooting/file_ownership_permissions.rst | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/translations/translations.rst b/docs/translations/translations.rst index 982e5d4d..3446001b 100644 --- a/docs/translations/translations.rst +++ b/docs/translations/translations.rst @@ -27,6 +27,7 @@ The default language configuration happens first in the Mautic configuration. Th :alt: Select the default language .. vale off + User language ============= @@ -93,6 +94,7 @@ Try searching for 'Dashboard menu' within the Mautic/Mautic repository, as there The first file found is ``app/bundles/DashboardBundle/Translations/en_US/messages.ini`` and there is the line ``mautic.dashboard.menu.index="Dashboard"`` within the file, which is text to override. .. vale off + Override the translation ======================== diff --git a/docs/troubleshooting/file_ownership_permissions.rst b/docs/troubleshooting/file_ownership_permissions.rst index 10c43546..45063e8f 100644 --- a/docs/troubleshooting/file_ownership_permissions.rst +++ b/docs/troubleshooting/file_ownership_permissions.rst @@ -112,4 +112,4 @@ To reset the ownership of files and folders, use the following command - ensurin This command **ch-**anges **own-**ership, using the ``-R`` flag which means recursively - including all files/folders within that location. Read more about the :xref:`Linux chown command`. -.. vale on \ No newline at end of file +.. vale on From 74ed045b10de1b32b5bbf1c02c36f85f1c46883d Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 16:09:04 +0100 Subject: [PATCH 09/10] Fixing broken links --- docs/configuration/settings.rst | 4 ++-- docs/index.rst | 1 + docs/plugins/zoho_crm.rst | 2 +- docs/troubleshooting/troubleshooting.rst | 2 +- docs/troubleshooting/working_with_resource_limits.rst | 4 ++-- 5 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/configuration/settings.rst b/docs/configuration/settings.rst index 43d8effe..8c40ac72 100644 --- a/docs/configuration/settings.rst +++ b/docs/configuration/settings.rst @@ -225,7 +225,7 @@ Example API transport installation .. vale on .. warning:: - Installing Symfony Transports is possible when you've :doc:`installed Mautic via Composer `. + Installing Symfony Transports is possible when you've :doc:`installed Mautic via Composer `. If you want to use :xref:`SendGrid` API instead of SMTP to send Emails, for example, you can install the official Symfony SendGrid Transport by running the following command mentioned alongside others in the :xref:`Symfony Mailer` documentation. @@ -248,7 +248,7 @@ This is how you would configure Mautic's Email configuration: To replace the SendGrid API key, add it to the relevant field in the Email configuration and save. Mautic now uses the SendGrid API to send Emails. .. warning:: - It's a nice perk that Mautic can use any transport provided by Symfony Mailer. However, be aware that such transports from Symfony **don't support batch sending, even via API**. They only send one Email per request, as opposed to a thousand Emails per request as is the case with some Mautic transports, which can make them slow at scale. They also **don't support transport callback handling used for bounce management**. If you plan to send larger volumes of Emails or need to use features which require callback handling, please consider using Email transports built specifically for such use. These Plugins are available in the :doc:`Mautic Marketplace `. + It's a nice perk that Mautic can use any transport provided by Symfony Mailer. However, be aware that such transports from Symfony **don't support batch sending, even via API**. They only send one Email per request, as opposed to a thousand Emails per request as is the case with some Mautic transports, which can make them slow at scale. They also **don't support transport callback handling used for bounce management**. If you plan to send larger volumes of Emails or need to use features which require callback handling, please consider using Email transports built specifically for such use. These Plugins are available in the :doc:`Mautic Marketplace `. The table below lists available transport Plugins created for Mautic to include support for batch sending and callback handling. diff --git a/docs/index.rst b/docs/index.rst index ae9f508e..742ae22a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -56,6 +56,7 @@ There are different types of documentation available to help you navigate your w configuration/cron_jobs configuration/variables configuration/settings + configuration/shortener .. toctree:: :caption: Authentication diff --git a/docs/plugins/zoho_crm.rst b/docs/plugins/zoho_crm.rst index 44602d47..540f417f 100644 --- a/docs/plugins/zoho_crm.rst +++ b/docs/plugins/zoho_crm.rst @@ -5,7 +5,7 @@ Zoho CRM .. vale on -Mautic can push a Contact to :xref:`Zoho CRM` based on :ref:`Campaign actions` or :ref:`Point Triggers`. +Mautic can push a Contact to :xref:`Zoho CRM` based on :doc:`Actions ` or :doc:`points trigger`. Language configuration warning ****************************** diff --git a/docs/troubleshooting/troubleshooting.rst b/docs/troubleshooting/troubleshooting.rst index 8d5b5fdc..ca338828 100644 --- a/docs/troubleshooting/troubleshooting.rst +++ b/docs/troubleshooting/troubleshooting.rst @@ -113,7 +113,7 @@ This error reported is: This means that the memory limit that Apache has available is too low. Edit the ``memory_limit`` in the ``php.ini`` configuration file. -Read more about this in :doc:`troubleshooting/working_with_resource_limits`. +Read more about this in :doc:`./troubleshooting/working_with_resource_limits`. A required PHP extension is missing =================================== diff --git a/docs/troubleshooting/working_with_resource_limits.rst b/docs/troubleshooting/working_with_resource_limits.rst index 86b24904..637fdfbe 100644 --- a/docs/troubleshooting/working_with_resource_limits.rst +++ b/docs/troubleshooting/working_with_resource_limits.rst @@ -11,8 +11,8 @@ You may come across limitations with your server configuration when installing o These are, in general, not errors with Mautic, but with your server configuration. To resolve these issues you need to make some changes to your server configuration. -Requirements -************ +Resolving issues +**************** To resolve these problems you require: From ead4a399e95ee48d91c7c538aa31e5b941cff0e1 Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 12 Apr 2024 16:12:30 +0100 Subject: [PATCH 10/10] Fix broken links --- docs/links/amazon_account.py | 2 +- docs/links/iam_user_signin.py | 2 +- docs/links/setup_iam_user.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/links/amazon_account.py b/docs/links/amazon_account.py index 04c7745e..d92d6ec2 100644 --- a/docs/links/amazon_account.py +++ b/docs/links/amazon_account.py @@ -2,6 +2,6 @@ link_name = "Create an AWS account" link_text = "Create an AWS account" -link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html#sign-up-for-aws-gsg" +link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html#sign-up-for-aws" link.xref_links.update({link_name: (link_text, link_url)}) \ No newline at end of file diff --git a/docs/links/iam_user_signin.py b/docs/links/iam_user_signin.py index 6b8267d6..168c659a 100644 --- a/docs/links/iam_user_signin.py +++ b/docs/links/iam_user_signin.py @@ -2,6 +2,6 @@ link_name = "Sign in as IAM user" link_text = "Sign in as IAM user" -link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html#signing-in-iam-user-gsg" +link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html#create-an-admin" link.xref_links.update({link_name: (link_text, link_url)}) \ No newline at end of file diff --git a/docs/links/setup_iam_user.py b/docs/links/setup_iam_user.py index 88c1a493..8f9e52e2 100644 --- a/docs/links/setup_iam_user.py +++ b/docs/links/setup_iam_user.py @@ -2,6 +2,6 @@ link_name = "Set up an IAM user" link_text = "Set up an IAM user" -link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html#create-an-iam-user-gsgD" +link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html#create-an-admin" link.xref_links.update({link_name: (link_text, link_url)}) \ No newline at end of file