From fea168ff0c399748a271c3774d1cdb6378cb659a Mon Sep 17 00:00:00 2001 From: Zdeno Kuzmany Date: Fri, 28 Jul 2023 08:27:37 +0200 Subject: [PATCH 01/11] Add shortener docs --- docs/configuration/images/shortener-bitly.png | Bin 0 -> 7158 bytes docs/configuration/shortener.rst | 30 ++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 docs/configuration/images/shortener-bitly.png create mode 100644 docs/configuration/shortener.rst diff --git a/docs/configuration/images/shortener-bitly.png b/docs/configuration/images/shortener-bitly.png new file mode 100644 index 0000000000000000000000000000000000000000..9bbc46fe38c69eedff3dc2a4a39896aaaca29033 GIT binary patch literal 7158 zcmd6sXHZk!x9|ff3P@Lc1QA7wRHdnaG$|qU8k&G~Lg-aW04p7&1qe-q5a}&+2q?Wv z4INQh2t`V0p}gV$+?hM`etSQ>ckY@=&f4dkIcLpUd#(Lj`$Xty0cojOsQ~~0El5>K z4*|h@&~Rx=I>TxvQFZ0RVJu zmp`&Dw{Nxp09zDDNx|Ta#pWE-%CFpf*?lk&xYa+f zw8C@cM!lEUMT;y-%xgth@k!WWlh@!K%VcGeIhR5oRaN`17U~e+PW~S?boGBiJ1!JF z2&SF!+p0PIF9Y(im`&XS3mK5$zb9G+QnjxCs}4PkxO5;%{+DWdh9(=Z_D~o%x1Omf z4+td0CBfZMO0xOrT)gw>Nh;>pe=q^~ndiG92m2sd2;f&u#LZic(@;T=3$JcFi06>$X8*9U#Cqk^ekZ6{5OOCQF4MAAg3mRtM+VV;AZ|0vnSw>7y@-|vN7h`eI+ zE%)v5&u+ZHp}n+@JCMwp2{L0TmM(C!t<(p7MkP-pio8DENT?b*%8{&H>p<={26BAP zY>XTb30>23U{Ysep;eI`xOjOFA*l%$3LcpSjY@k0M>-!r11VU=!)}^+E6rrc%?U7< z9VMIZoxu<-x-0#Goi}ouHxjb@Y(g5kg3kLPwY{4yXEA8U`1?_o0frO7r*1@cQY_S` z(XQ;#9cYb4LVf@W2Wz$~ia^cI2dv8IFX)6ZB{mVyP5oDnQ#3U^NTKS@-fn4Y+Fmpn zT`E-XO8aMN2bGol_^C_H0@;1ABe@d}U$nGUkf=dK&gg4xSQgRJXr@A~*Ejv-&~fDA zZ+&L=O?W`1+10PN-g~b6($CZHqB{^E$ILVuor@mwO`U4K%@8ebc_B-bO$%x>6kYBt zTCTXZ6>lNa&=YWhs{H#g1^JHcSbj`$?Z?*ill_h1@r{e6t~My`gNwhpKHoLotYyl% z1c^&;W%xM^69&K9FB+8{|I8RY>rl6lpiQJSvFWlj`m;BCC&;fkxa$bdlP=guY@D46 z@`GFUeJ_2uzh%Fc-Ilo{mo$WNInmIcUC1$$nb0eDX*?E$Wk1}fEA}eIZ2LIoo~}ne z8@T&7cNz^()Ov1luyG8|GTr|gblzd)ISry%>Q_MZzO58J?t%(9oz;^8p4Qw4H5zU*gYRsRs>HY);p-Y~H;f;CdJvqK(lVPFAi&$rxYvJ$^; zO4}XPJ0OM^0x@S`3zKuo+=|eD@?1td&SE8q(e*+qVvU4f~<&^{k#-QE&(9y?JS65~WYZnqV zEkkS$$duxw5{;+-@pfDoJpF;a)#~_pccO8-FG^d^X^UZNelPPy_1aZ0t@qi19B)*E zf3Bwf@^{IY?Sa!zlqTZDE}TVo1B`Zl(}dWn1VR|{(tMgJzQrU4w_uFq6y*fO9-5yY z{hWR6Ub8yWEb1`-GHr*LKH%^2h{N9+Q%?zt!GIV3VCW9B`Szt|X>%|a5ywLa+bpkZ z-Y*9o6L;jshA@Ha7l=;=z*<<9Pr788nGB}esXvj4Su<0S*`pyg`CMZ^F#D*FV+oz8 z?fmnw5XMbhj?&b6(qP6j7hLb zKb-jaC-K@{w^;UuzbB7{S?#QE#PEvSkEV7-l(D|FDG@TG8Ng_%=~Y-TJUE{@Phv?*JZ&|4i#2$QVb3INZ^|L_Tv4)6v*`815;K{tsoX|M z-!&pZxR7UQkj)offKQEgRa3+m;S%4fz4~qq!I9zStE*;1R&DXy0*dDq&L5kaS17z( zw=rk-?JNMmUzSZrh-dd55ku^NGH_KZZA7F>F~-=Yb?2<#)XV8{I4B>gCNyMpjIih0eORNRDe|!XN5Qw^`tZe_v)Jl$S5<2=00S-B3)LsQ z)^f3E&52U1bM8oAv4361xUhw!+V>Lglr-3!&hMe>I;@IwqBeixFMkni@68fAnYWoV zm__yMx4r{m?fQse(L!>HrJ4WFun5vza5#O`{C(SZxAmOo`#t{8I%O6q+Q5>7wfPQN zat5Jw4Qt$7eY$JX7=v$G?CEhUA2xCh6u zj!yd&eKhg>rF3kVn$5MC2jXyd$LO2|lt`GO4Py)l&`!4r#O*7f=vUEVh!Ix+o!@y28c!4oJ@f6P^eNE_+1{HUO!1_S1K>8v zT*(8jldyX!S@G#yn!~ldHVa!Vky-a^Wnn?U$Xsf0eW@C4Iqc4=_$p)>X@8~8^EZn_ z0Yx*}(G0%yi3nBb$h#nbuUHe)Z!bP%}RSjq&XaW~-D-9l+UJzmz8(nV7aY*k-($`B>x&8$L zd3KoV6YTHWQ$WMK$6_oyG)KtY2EvO z*MbaL0$bqk-jVYO3&VSR)f!1X;Fsg5sHj9VTD+&f9}VTq-7kga^|pWuG3T?TJNdnI znMn7Ey#rluRV}TjNSB!!U)s=zR;z=Vq>h1~6g1zMXPIaHHkJO`6|f~(^N4hJxdm)_ zII43>Lf-kCSOk))xUy0dq^T+K_AUS*U;LBp4e?+zkwwThbQBnDpJUiyG zHSR84tT$5j;y$+#5-5noZVjgRb~RmhE{8_iC1 z730q(Iqs?J>?4`L19TifJm2x;OcW$&uF|y+EBU=e0W2K$p?TWs%cS18WBU6~o>S+; zxBBuoz8%8#gMwaAkvdTZFY)u?=Z{AAshNtQpz7aRBV6rsLJ59lSmh%uvOW|gWDBdCyzNuHe1|OWx_ozFQY190i(DRl*_)?3nzA0 zmfZq;%^L4CO!@gCJ|z+sgK(#?zHu>50RX&78r6ti;?H-+cz(U$;8?YLw`am%3_3XhT3<4==^IO z$@}UDTe&GJK5&r;A~X!bp-k~q^LAQ$ydmSTwPjQ_lo}w;_FXA{t1+(G;AJUIxCqzf z#>R_&T<-HT_^;qAk)mfj4$#{GM+*%Bhuc_Jt|;9ick!p9Jqae9Q?MNTmHR7i zkc&kg?C8#L^Z#5WJ?57`qqcSP#c)8Hj2{Meg|uN}4uKTBAZ}FY>FB)1UU8mlFw6=* zflSr9Wt+cuXRTp33pXcGOxiX36)V#1IJ&%nbpo~6OIZ&n$a)wqh8k%Hzy? zDJZX~SfuLSF+E?e#S49O>owoaV=EpXC6J8vj zOjJH0&_;J6lEmasKoP~S8lSk&i}J1B6B8BC*^0mQeuLRFwzzJpfIi7wa&>YQFt!}7 z!F#&cbG9iHpV`qk&|U0CU7NPq$PvtWak!>$-wqE{f@8MejrXp{PUuM023u z9hm?$7Y`4jeO#cd$-1Verzany7)EMm>9rOD7hs3u{8H0J^+k2wIR+rN2>ML0<0vF- zXHKaQ?vs*WHHZ9N^pwfZhncsMGCH}3f+Dx#w9k_pyI!Y-5$uyK(5ES(b5^P8N62Wd zXb!;VIfTklOeU)wH~;nR&k0n5k%$Kqj6|G1lc=es_4YC2_Mi?(Ty@w3A}Y#n~snBAj;n|GwFEBmXp zG<)wnP)wv*_9(I#I+h(wsm^X@e8UkcB@w`+j$*_lG@45J72kQy!^_|T!mCmF@0G2iJl`^l}ZqqJ>1{} zB|ef*w0fu#T^@%h0J9h0-?rzwc%#ieO1+)(fq5o8s9NXX;(?A=D_8S$xZB?k^2*FT ztad&xXuRw?M>ugVo6>xOeEWUUA33LPPwLZ%4Z@?YneHrxov+iCj9d9kjP_GRB#-dC6zxLa1)Sn`T-_CK<8}haQ#tL*3jHMcSP3ZBvY{8G^2Jdmo zRlobJ=<{--Vt2k}BAwA#?T}EVSNxh8Kq57B3g~ig@_}ya?s6Yg=pgtBqFidbX>TJp zbYsIAGF6F$jWs1}2k7v(Fz?Ws+^33aseu+5ZuZw679LL@R2(A0Gc!hTinrsukvY_u zc-jdbKUac5&K-`cT4@F0`lzca9#gB$Rg+?&DmHNwv*qGOrxV*SlxeO|+c<>0f8K@j z?NXBJP72gE=u59>?A_7cX|BWgw85nBj4&=CcRl-oM#G?nd@xbrtyd0BJH>T;cyR=> zhxhRJ7A+EQ?^9v=fc-5pqL{tW_ZoJDwD($}z-%1FB9uUJjZT%c)MkX7AKN!BL<)F& z94czs64uAnPY&s$&$s3pYw!Badf3Z7?T;U6X?bW^qLuQ&#C%gK`LQ8lmYP&@QYNKF zMx@6jKJlA-=2Pa=Q1*?jGa8wsTwS+MtMkP@z53e+@c;k_XD>1;qvI*}rWMqbin$}!8C^J{G!c1AV8iHXhL(Va zwzk{(==C;}7ZVx+`=GVl$4CsbL1-V(9*1KCF*mlM4&_~`%3C0bj$)$G52^qFn@r>A}5k_Mv zR`oY2Y=m zY(YyB#1m@!3-@7X?m%_9?F{K%arQ2Jlxns=i&yjD(- zhu-miJG`MAdbH?cR@AV-s95W>W^4@iGCclUMnWc@2 zE)Ly#ZM8oI&l4@ywS~o#Z>s?#yex! zkPbsx2aKVeH#J);p1&ZOVRJv?Ru*L}i6F$UfQnV}X`g@u+w1a&bl5*seIZIZWH@0- zU_p}m6aGA;lq$lzHX8+t9p5|lIACD$CP5KN9*rTQ2CLv{X}Q~u?dUjI*MqRB|<9MA2ZZOYK_ziMqpf215^7#m4_ZAV83$lt&I z5@Q(5#OX%fJkkp?4@^TfUSl>foh33pQY-s@7e669tacHbn3#yvu7;Z;<`g&}tRQ@AD7j1!Kx3!!iBVKnrUytq|85y}`^xody4OY^UKlx=Ru2X@P zUODnHo(nRbA2Wr$sh&)bn**DkrG&E(O^eO-zb5+@*SamZCK$(SfXN4v&nQWo^NlwgnTvcZ_PD@Mk z)wI1^hc_+wd!fFBAKGMfD^%U)nmIpuN9rKFKd4$;e?>#FgQaBdTpP3X`fBRx$h^FE zQg2hm@`B$CGv~tLZ&`N0ZfiV** System Settings > Shortener Service and designate Bitly as the default shortener service. + +.. image:: images/shortener-bitly.png + :width: 600 + :alt: Screenshot of Bitly enabled for SMS \ No newline at end of file From 4dd60944b36afa47e73cb539bbf1158b767ec83c Mon Sep 17 00:00:00 2001 From: Zdeno Kuzmany Date: Fri, 28 Jul 2023 08:38:37 +0200 Subject: [PATCH 02/11] vale off --- docs/configuration/shortener.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst index 81cacee1..4772ae28 100644 --- a/docs/configuration/shortener.rst +++ b/docs/configuration/shortener.rst @@ -3,8 +3,6 @@ Shortener service ######### -.. vale on - .. attention:: Mautic 5 introduces a new shortener feature, replacing the old legacy shortener setup found in the configuration. From a8f02d778fbc7a3ecd65858bd75a90fc49e5ee16 Mon Sep 17 00:00:00 2001 From: Zdeno Kuzmany Date: Tue, 1 Aug 2023 11:24:19 +0200 Subject: [PATCH 03/11] Update info about re-configuration this feature after upgrade --- docs/configuration/shortener.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst index 4772ae28..9ae2958d 100644 --- a/docs/configuration/shortener.rst +++ b/docs/configuration/shortener.rst @@ -5,7 +5,7 @@ Shortener service .. attention:: - Mautic 5 introduces a new shortener feature, replacing the old legacy shortener setup found in the configuration. + 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 shortener service allows developers to create plugins for any shortener service, with any type of authorization. By default, Mautic does not provide a shortener service plugin; you must install it either from the marketplace or manually. From aeb0c14e2308b1f11e1c2f229179634094e0c06a Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Fri, 4 Aug 2023 16:43:28 +0000 Subject: [PATCH 04/11] Add link file --- docs/links/bitly_api_settings.py | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/links/bitly_api_settings.py diff --git a/docs/links/bitly_api_settings.py b/docs/links/bitly_api_settings.py new file mode 100644 index 00000000..27f476df --- /dev/null +++ b/docs/links/bitly_api_settings.py @@ -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)}) From 21716e105647b921e204314784239b116f02f34e Mon Sep 17 00:00:00 2001 From: Zdeno Kuzmany Date: Tue, 24 Oct 2023 20:35:21 +0200 Subject: [PATCH 05/11] Update docs/configuration/shortener.rst Co-authored-by: Ruth Cheesley --- docs/configuration/shortener.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst index 9ae2958d..d4c9e4c0 100644 --- a/docs/configuration/shortener.rst +++ b/docs/configuration/shortener.rst @@ -1,7 +1,7 @@ .. vale off Shortener service -######### +################# .. attention:: From 11b085b7224be620088295d38828cc59d1c886a4 Mon Sep 17 00:00:00 2001 From: Zdeno Kuzmany Date: Tue, 24 Oct 2023 20:35:30 +0200 Subject: [PATCH 06/11] Update docs/configuration/shortener.rst Co-authored-by: Ruth Cheesley --- docs/configuration/shortener.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst index d4c9e4c0..86c65760 100644 --- a/docs/configuration/shortener.rst +++ b/docs/configuration/shortener.rst @@ -7,7 +7,7 @@ Shortener service 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 shortener service allows developers to create plugins for any shortener service, with any type of authorization. By default, Mautic does not provide a shortener service plugin; you must install it either from the marketplace or manually. +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. Example of setup Bitly plugin From 099ffc5ec4f2d1ab35c8ddb4a984ba4209b1bd2c Mon Sep 17 00:00:00 2001 From: Zdeno Kuzmany Date: Tue, 24 Oct 2023 20:35:41 +0200 Subject: [PATCH 07/11] Update docs/configuration/shortener.rst Co-authored-by: Ruth Cheesley --- docs/configuration/shortener.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst index 86c65760..b517f1f1 100644 --- a/docs/configuration/shortener.rst +++ b/docs/configuration/shortener.rst @@ -1,6 +1,6 @@ .. vale off -Shortener service +URL shortener service ################# .. attention:: From b8c7d4457b0ff09718c5ac459454770b726bb463 Mon Sep 17 00:00:00 2001 From: Zdeno Kuzmany Date: Tue, 24 Oct 2023 20:35:50 +0200 Subject: [PATCH 08/11] Update docs/configuration/shortener.rst Co-authored-by: Ruth Cheesley --- docs/configuration/shortener.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst index b517f1f1..fc9db7d1 100644 --- a/docs/configuration/shortener.rst +++ b/docs/configuration/shortener.rst @@ -13,7 +13,7 @@ The new URL shortener service allows developers to create Plugins for any shorte Example of setup Bitly plugin ================= -1. Install the Bitly bundle from the marketplace or using Composer: +1. Install the Bitly bundle from the Marketplace or using Composer: .. code-block:: bash From d9ea5cc31094806c37e5a7b953b08ca5fb3d2377 Mon Sep 17 00:00:00 2001 From: Zdeno Kuzmany Date: Tue, 24 Oct 2023 20:36:33 +0200 Subject: [PATCH 09/11] Apply suggestions from code review Co-authored-by: Ruth Cheesley --- docs/configuration/shortener.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst index fc9db7d1..93593c3c 100644 --- a/docs/configuration/shortener.rst +++ b/docs/configuration/shortener.rst @@ -11,7 +11,7 @@ The new URL shortener service allows developers to create Plugins for any shorte Example of setup Bitly plugin -================= +============================= 1. Install the Bitly bundle from the Marketplace or using Composer: @@ -19,7 +19,7 @@ Example of setup Bitly plugin composer require webmecanik/mautic-bitly-bundle -2. Obtain an access key from https://app.bitly.com/settings/api and set up/enable the Bitly plugin. +2. Obtain an access key from :xref:`Bitly API settings` and set up/enable the Bitly plugin. 3. Navigate to Configuration > System Settings > Shortener Service and designate Bitly as the default shortener service. From 539c641eb392d2fb79a19ace09c7e5ed58a00c6f Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Tue, 9 Jan 2024 18:34:34 +0000 Subject: [PATCH 10/11] Apply suggestions from code review --- docs/configuration/shortener.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst index 93593c3c..25d03764 100644 --- a/docs/configuration/shortener.rst +++ b/docs/configuration/shortener.rst @@ -1,8 +1,6 @@ -.. vale off - URL shortener service ################# - +##################### .. 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. From 9f39fb85836861f11a3ac678dd6f8311e448623c Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Tue, 9 Jan 2024 18:35:37 +0000 Subject: [PATCH 11/11] Update docs/configuration/shortener.rst --- docs/configuration/shortener.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst index 25d03764..114b953e 100644 --- a/docs/configuration/shortener.rst +++ b/docs/configuration/shortener.rst @@ -1,5 +1,4 @@ URL shortener service -################# ##################### .. attention::