Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for shortener services #191

Merged
merged 13 commits into from
Jan 9, 2024
Merged

Add support for shortener services #191

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fea168f
Add shortener docs
kuzmany Jul 28, 2023
4dd6094
vale off
kuzmany Jul 28, 2023
a8f02d7
Update info about re-configuration this feature after upgrade
kuzmany Aug 1, 2023
aeb0c14
Add link file
RCheesley Aug 4, 2023
21716e1
Update docs/configuration/shortener.rst
kuzmany Oct 24, 2023
11b085b
Update docs/configuration/shortener.rst
kuzmany Oct 24, 2023
099ffc5
Update docs/configuration/shortener.rst
kuzmany Oct 24, 2023
b8c7d44
Update docs/configuration/shortener.rst
kuzmany Oct 24, 2023
d9ea5cc
Apply suggestions from code review
kuzmany Oct 24, 2023
8b9c124
Merge branch 'main' into shortener-service-support
RCheesley Oct 31, 2023
e9a8f89
Merge branch '5.x' into shortener-service-support
RCheesley Jan 9, 2024
539c641
Apply suggestions from code review
RCheesley Jan 9, 2024
9f39fb8
Update docs/configuration/shortener.rst
RCheesley Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/configuration/images/shortener-bitly.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/configuration/shortener.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
URL shortener service
#################
RCheesley marked this conversation as resolved.
Show resolved Hide resolved
#####################
.. attention::

Mautic 5 introduces a new shortening feature, replacing the previous legacy shortening system found in the settings. If you utilized the shortening service in Mautic 4, upon upgrading to Mautic 5, please follow the steps below to reconfigure it.

The new URL shortener service allows developers to create Plugins for any shortener service, with any type of authorization. By default, Mautic does not provide a URL shortener service Plugin; you must install it either from the Marketplace or manually.

Check warning on line 8 in docs/configuration/shortener.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Contractions] Feel free to use 'doesn't' instead of 'does not'.

Raw Output:
{"message": "[Google.Contractions] Feel free to use 'doesn't' instead of 'does not'.", "location": {"path": "docs/configuration/shortener.rst", "range": {"start": {"line": 8, "column": 145}}}, "severity": "INFO"}

Check warning on line 8 in docs/configuration/shortener.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Semicolons] Use semicolons judiciously.

Raw Output:
{"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "docs/configuration/shortener.rst", "range": {"start": {"line": 8, "column": 192}}}, "severity": "INFO"}


Example of setup Bitly plugin

Check failure on line 11 in docs/configuration/shortener.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Bitly'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Bitly'?", "location": {"path": "docs/configuration/shortener.rst", "range": {"start": {"line": 11, "column": 18}}}, "severity": "ERROR"}

Check warning on line 11 in docs/configuration/shortener.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.", "location": {"path": "docs/configuration/shortener.rst", "range": {"start": {"line": 11, "column": 24}}}, "severity": "INFO"}
=============================

1. Install the Bitly bundle from the Marketplace or using Composer:

Check failure on line 14 in docs/configuration/shortener.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Bitly'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Bitly'?", "location": {"path": "docs/configuration/shortener.rst", "range": {"start": {"line": 14, "column": 16}}}, "severity": "ERROR"}

.. code-block:: bash

composer require webmecanik/mautic-bitly-bundle

2. Obtain an access key from :xref:`Bitly API settings` and set up/enable the Bitly plugin.

Check failure on line 20 in docs/configuration/shortener.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Bitly'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Bitly'?", "location": {"path": "docs/configuration/shortener.rst", "range": {"start": {"line": 20, "column": 79}}}, "severity": "ERROR"}

Check warning on line 20 in docs/configuration/shortener.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.", "location": {"path": "docs/configuration/shortener.rst", "range": {"start": {"line": 20, "column": 85}}}, "severity": "INFO"}

3. Navigate to Configuration > System Settings > Shortener Service and designate Bitly as the default shortener service.

Check failure on line 22 in docs/configuration/shortener.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Bitly'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Bitly'?", "location": {"path": "docs/configuration/shortener.rst", "range": {"start": {"line": 22, "column": 82}}}, "severity": "ERROR"}

.. image:: images/shortener-bitly.png
:width: 600
:alt: Screenshot of Bitly enabled for SMS

Check failure on line 26 in docs/configuration/shortener.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Bitly'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Bitly'?", "location": {"path": "docs/configuration/shortener.rst", "range": {"start": {"line": 26, "column": 24}}}, "severity": "ERROR"}
7 changes: 7 additions & 0 deletions docs/links/bitly_api_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Bitly API settings"
link_text = "Bitly API settings"
link_url = "https://app.bitly.com/settings/api"

link.xref_links.update({link_name: (link_text, link_url)})