From 2a8ae97ec9a2ff8c2c5a91c76343d83739c28290 Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Tue, 8 Nov 2022 11:55:49 -0800 Subject: [PATCH 1/8] Revert "add logrocket documentation (#3778)" (#3785) This reverts commit 00c28630b0da40334ff6d4227daa18dd774949b4. --- .github/styles/Vocab/Docs/accept.txt | 1 + ...nimist-npm-1.2.7-51d33b1371-7346574a10.zip | Bin 0 -> 19994 bytes CONTRIBUTING.md | 35 ++-- package-lock.json | 164 +++++++++-------- src/_data/actions/mixpanel.yml | 167 ++++++++++++++++++ src/_data/catalog/destinations.yml | 56 +++--- src/_data/catalog/destinations_private.yml | 129 +------------- src/_data/catalog/slugs.yml | 4 +- src/_data/sidenav/main.yml | 11 +- src/_includes/components/actions-fields.html | 7 +- src/api/{config-api => public-api}/fql.md | 2 +- .../{public-api.md => public-api/index.md} | 2 + .../catalog/actions-hubspot-web/index.md | 2 - .../images/image1.png | Bin 0 -> 100871 bytes .../catalog/actions-logrocket/index.md | 25 --- .../catalog/actions-mixpanel/index.md | 22 ++- .../catalog/actions-pardot/index.md | 18 +- .../destinations/catalog/zendesk/index.md | 22 +-- .../destinations/destination-filters.md | 2 +- .../functions/destination-functions.md | 2 +- .../catalog/cloud-apps/amazon-s3/index.md | 8 +- .../libraries/server/http-api/index.md | 2 +- .../shopify-littledata/images/segment.png | Bin 0 -> 139149 bytes .../website/shopify-littledata/index.md | 60 +++---- src/engage/faqs.md | 3 +- src/profiles/faqs.md | 4 +- src/protocols/tracking-plan/best-practices.md | 8 +- src/segment-app/iam/roles.md | 2 +- styleguide.md | 25 +-- yarn.lock | 6 +- 30 files changed, 407 insertions(+), 382 deletions(-) create mode 100644 .yarn/cache/minimist-npm-1.2.7-51d33b1371-7346574a10.zip create mode 100644 src/_data/actions/mixpanel.yml rename src/api/{config-api => public-api}/fql.md (99%) rename src/api/{public-api.md => public-api/index.md} (98%) create mode 100644 src/connections/destinations/catalog/actions-linkedin-audiences/images/image1.png delete mode 100644 src/connections/destinations/catalog/actions-logrocket/index.md create mode 100644 src/connections/sources/catalog/libraries/website/shopify-littledata/images/segment.png diff --git a/.github/styles/Vocab/Docs/accept.txt b/.github/styles/Vocab/Docs/accept.txt index 6d4899d75b..8ef207e70c 100644 --- a/.github/styles/Vocab/Docs/accept.txt +++ b/.github/styles/Vocab/Docs/accept.txt @@ -102,6 +102,7 @@ NSDate NSNull NSNumber NSString +OAuth Okta Omnichannel onboarding diff --git a/.yarn/cache/minimist-npm-1.2.7-51d33b1371-7346574a10.zip b/.yarn/cache/minimist-npm-1.2.7-51d33b1371-7346574a10.zip new file mode 100644 index 0000000000000000000000000000000000000000..d60d312969c0e1d61a643b020f0de8e25ae41b88 GIT binary patch literal 19994 zcmb5Wb9AN4)-N2}b~+u~wr$(CZQC|Fww;d6PRF+GbdoRoyl3BYci(sKGrni!Sy_Lq z`i-htvt~`pNdkkQ0Q~XrRWCsN>&w4CU_bxc*cut@TH6{qTNyjj%Khz6(SHA_wYiPC zwYj6yzsCRpK>Q0{uySa75D)<17z6+S|8K|87&}^-+c-HGS|>@{?9#ymKe7wQIWw92 zSDXCwgfZcljH(df#gn(NLg{*qvk#PTKvO^REE3|GdtN(#3`H^I`L%JVbk&ON=QyMn zw!HnbtA`&;Mr~Q&Ew_XL2Xyjo@_SPYm2Z5BoYhh2--v#*$i7GB{!xi z29EnC8L-BSS*6{mprDg2e|l3XP_)D!3#|*>_)C;cq%U6e)1F5eHhsed~E`UNO#3j{t4wIVi@HY7l14nHkrM-hr93lm#ke|H+g#S4GB&P$Ry4^ z?G!pdYEx!OV25DMS?yjsDmF5T*{WL24h={(Mljy^1m(^$Tn;-wXV{BXObAxx+KCK# zmHH45(QYM()wuIju3ZjJ2w5S13DHVqvl?E-_x(^hD(S4GX+r#k;Z_YAc80+*iJG7* zsyI<63<+y7Z2XwUU8mtyLTq%@{*9IHdWGRa7Y85TMNxpD`xMv%7^4Dknm(Vw&4!g6 z?y~ebGYQnE)-1Yny{coE^%Si6SRwpFVuH*^YW@cnf=9ynLGVe{q` z$=HqWbmdCI0=?2!hMoob)oJVN${YCqaLu0_kPXvCk@LCp`=2k)-*bSCyP<<2bIc@M z03AZm^c}g_G+z`iSvS;q*tT&33}f+gbb5>N6RNB*yH)9JndBAxcZj`#4;7fQN$22YLkBE zAG=r$n=wyLnY39ysOxmrAH#MSu3FvTs6=0nwRp%EHGE{EB3F)4Jpl*sDWC*Ch5g3a zq7PQfwm<*?^q-uK`?u?o5*HMfQ505Ikd9rUL+CnGjbdw3XzY4430qc!b=gb%h9hVY zR)IjcO1|Q|nNGF3o*bt)WV=N-{ zn(~uHOFL>x76jj_wnVix$VH-gdK;$_)HlS&tbgzzj;rwp<(gF(+m>vZb7CgVjKHC7 zP1wX7I{5j#Aa>!UR;1U=t4;R`c~kh^luaXIcYKNRZJL_5u8_xS%vN#K#zyYe#oX3m zP`UwBHDL@6|2o^_-u9cjlj@^f-t`uZV1!u4BqDO$G){H5tLaO#WaX+CmNt&V5w3jh zLC~bwq_H&n{?j(F5NFK5*34tVegAp@!6~bTnMY-q(>Bi&rI&aBCC9YBfOyBm9iD26 zY3b9jOE?Dz@2mZtYsA8HnQIc+&L9j=6Y0kyje3e3-E)x2Ce;j}4Zf;3*I>TzCF!dg z#z{M5ZF1KzBnle|S7-nFrkC2?(Nk^}Z@$lHzPzTRUPho<-olA6N~a&HWv$M>9YV2^ zCvez|R0d%wHJy8qt^gYQ)n?OyG_ZuJfvReNq3nos6K#-J2=kP4dKMKKTuW-`PV5yBNQ0IPd*aHy=6i|~tV?$SA zb!&kTC|zQ|Z-3jW6sQhC@&)5H{s8!UxsCm|oa$u!{|N7C_t>gJW$`t zO4q>F){4f$u}i+grk@UG?G|;72)LQk-9ElfR~{wU;0L@CB5I@r0?PAaL`0^^m_j4g zUF+^T;`}Vt)+7=_bL|$v6tso%qHMX_1`hHt##4^Lu6%1Wf(GnDR4rk>8O{|FqEl>O zcuKDtw6bvuJ-`oF>3j){f>SpV@C@juH9n1mB#Kyaa@IoKpE+bd%gZxHyho}E6Fn$Z z{VRXgPqtxp6%Fl8U@vkP__7NbHo0v|4&Ihi+AeuQx6EhVFC|RlnU82M8l);&3R)!F zMOQB#+q*N-Iy}IbVASpca1Uk+r%m|?kZ#z=(rlNclSaUh%>wpuwO@6JLv0z`W>Ah6 z7uMp2zwl-|#F+E%=ix84%rJf2qwD@v9$o|2eoz1d0N5b_0DS#tqW+tpKUF1dcjyqh zA5|wNmBs`;HNwk7xzD^WA(TTfkgUTLJq7&BKfJkP3^Si+BRKH|Zq|`o#7YRq$e>{vhL@qDLZbBZe*ISaJr`+VX){og7%2-0$z<^zD&jr|VJ##tSfk#s-WSs3V5DDUzV-HJ^o&NoTUQ9mm$LOozbQD!V~KT!L6K-_AE-u<6-eeV`gevT@6W zfL&RCMO#mH;$)6sZD?ea?>2gPKa(3;nxzKibnc?@9Qe?oy^^%QNGY0qk4Zop z&#ADG@T?a>la)L&AsS6=_*v2I-8;foFO72W(KpgGr|@z6@<(43^Q?8yvmeEK7Lk-J z@5`^r7qRCnyyst(2@d))pZEI>MK-GCN`~n;j5RH5*^~{2V*`gHPKuI;aqBP9#KGH- z@Rn#cl9}Y06*@FOG$4fm1=(FUYZ8g3uoMU6Q;Ym~THm2yDIqaMlSK0<#wyDE-5OmF z6r_-j;g~Nn_jAXn&j;p zyU8shy(FG)r{{C`V#?lXkt~m4c&F**`yzT4AL)f6goyje&nr;_iTaCpP6u(S4>sre z*Me+)xJWdGBx)ax7K6vwn$9w=-(swlb6kUS~{5E}b z2%U$ho(=H^<>e>D%CTK{&=ASa9sXjyaLtM30>8R+zy@R1?c#RH@?;5_I-iCN);Ql;3nhI8q+wtQp*Bmoy?C5fYZP1$*8Bw;o- zF%!gA2osHjzN=AuX-&C_>{WQkcV=VIqu$`j!`VH z7Hs{ny#0-vJNwmlCdy!GB?e%F!}_5RM7Y3C#!Hh??BYLndM{JYS$zU6j=nY0R4- zdl5aB6hcSo?WBreoJMz#|lY&4#$-mfI#33w{unbdg1q*+TXFe5RXnJ({`ykS}<{e&Z*z6xU|Oet0AAiz!aile-0-co2U zusTi9S$=AqC4SQ&9Z~j}b(G;6D4h{WN%bBGn9~=3GOR$&10}%(?m_#c1Dez(GWjyC zW;7H&oF1WzWx`4Z;?QgJh>qbtc7%@-JYoF#!>dS+ENC79<&Qf8TX6LQPIB#kD<*%M z2K@GUnd;yG0KRwt0H1$LG?+&I@OCv1k)$H$&Q#@9e;~|nSTmANKrlvl(OX?fX=gazn{PPl?)%q0Qor z#r=o)82E(KhmWoAEpsmfOqD-A znfT?Ll|2 zp(bZI3P{Z=6~uGo?TXc(`Hix^B+WrgYWu)w!Q(Gh@4Ck^ls`(1!YmMIq)X%pIhXJijJlWQAB7=A_|22;~FjgXP;yDBwRRF1V66IdNbG34(B0));SnbrP~ zBm{^%hh!@LcwV#nkw~1O|s? zUGsd5Y8h}PhQd4Ti*gV~{Tb;!sMB+UhR9Vo6C&twsk6VKkEaO`m zZ_%z9r1R)hf?-^!NWO+xj;TFZ+qy*wtcs%gSy6gvys?G|ql6|xqj6(-m1Xn%c?w=* z6Y|n19TcgT8oDT=U7CGwHz=Of;o;@OV76tJVzMc89N#ZWI7%pIFa^a$6yyve9~vS2 z0u?QJ@g$eBk>(=q*D&0AbNKvaO`XPlC>3CLF|2ffMw9{@3Uz^N)+z@d-|{53p9cK| zFI|3L1bdzB-^hjN2iU_^Ah<3ILDfY(>28YoDxy%z6blS`3R$t0HW0I88^$Ea>fp?L zB;m|5t9G1W_+xkw85Y7X#~fJk;363`Hca7(bV-*@&EQ)4&Dh#KZXfP{u5KUQSIlA) zvfH%Hy|YjdJSu`}s|;Vy?^ARRqzZDGig;xy;9?tJg@JaZ8q zuPSUB_HZuuWNVH`zn{7lM3rH*vj~;Nc2*Yb z?Nn(pIhb@Cg(=?Vc@%3dC?LZxK46()J<6L|J9O^XEk8W&k*2l!e0G-iSuu8fm3zQ` z;MaNP{puJyU-X5^{j{PJ5o%wK-qJ}IN~7(AERbDPXMD(+&yS11mQfN#oy>1r_ai*)ET`?L zlTDL-n+EmLc)69dRONHoC{vp`1}=M+sJ4p?+V>Th0I0GLr0d|%xT<+J=?!(CTDMHZ!Mpf zvD>HS{9lZIOBY>7Gg}9zKXj9r4yZmp1mRb&!E=*f4EYW*i5>wV5)KQxgSzy};HS%r z5Wn8OF>fHcsn@CyZSD+P0mgh&Ka)hlnQ2jUMyzzaHiGf!#NP!DAF60 z4dmT8gO=fOPF?&2PhAWDk88V!*7^u!$!kB;)6RtpR)Uf|@d@A`7_Y@Xz<*tO6AGd9 z$>-9c|GU9pWou*lx$LI6UW-p(N64i+)cP4;MvlYrh`p@5guS9OG{$P(K8xJTMKVKs zvW+3M69M@!EpM+QVtcwTUr;02+DFi9RoZUmua??BL_fi|r$`)tg{7*#rU2khu@|KN{=Rhz*7A=D;uGMVAU~g_rmfR z_ZT#H5aYirgRep9 z55kMam#fk_%q;Z4p}@}jlCf1LWo}9qeWy1jy|^-cv&Mhf_5l8sx`^K-o4eGY`y7Z1{vxcfu=u+l-LHQYGYs&K2mnC%Ig!7_(Eg7d z^RLtJ=M0)YeR{hr2;GOO2qJ*Xeni8Wt)VD9Mc?tz$YvBHK^6M*tX}Hkg+z;RN1;C+ zr{d-Vk@icqt>9t?+x&}J)u5x z`V-y=H8Y`2kW#vNsV7)YZhc!*q}>_@AT+g`EPN`&FMP3IZ}t)~9EsB6)8RNLEm6bM zps96Y3`wQL!?0W6VmGmxR_wi$A-hDkEm7RihtpB_moml5RSPZmhyFTc_!hJb{FrG$=y7a8-Db=eXf5UX zG__QrdaW*ATeRrcJs~r(Af8<^=T5OT?>~VTOQ}Vrus0v5&k5;=dE%g7OxOEDkTZmx z=;B{sSqB)V+^dN)!A?>0!zNx;!&MmqE^4$sq4hzfl3XoG(Viir{S;Lc$mtbRL||PH z$@-Y(AwM(<=t{$5@8n2c$uCN|dyK6St|W>oCdxMXT<&Ys(769BLSnW)Jz$(^im(=$ zlCs7a!W)B*6V9-pcD3>vEe5+w{OqjMV~905${_L-mh=Kf+FnxrqrS>SkyM;ugxn7yw>=e!AY~J_9TD9R@tznxomK!OH6;(N z*Yb1N7SvlODEtP)A=VORLEf(v53kM(Pb~*KX@{uVOPLkaB;kypc!` zDpnYy!HM*d=b5Pvf|!iVJx!9w#kfTcK71%6dQT4cbhLa`R#laZ^3?hdA)XvEdQQdJI zUgYLmP;e`F042=6{F%1|arY;GEAJ9`MsY^WS8e zgRPV8A9sAxdQ1S_r~B^n>Y*f3bNYFv`(Tpj4SX3z04hRkG2T3g8hzOfEE4#s3P}nu z(4D8>;wrER2vRiiKLJE-!6QQY9hDf^d zZzRCfWyeAeF7U4Gx4z4S#E`s^l@|B2l&fxK=C>&BKChLBuujjr@6!jXejr&WU-h4* zzqaymoKEejdGDlY5u^vbZ3mRCcxSCYLOz2t4+!^gIY6 zQb(gYRw{+lV`BAeV#9z}2~ZubrSFlCI0oFCPbCG&nGH#|ON>C!J-&e3WgN7=25MTl zk#$V{c5mLz4EBV5ZZA97f8E|cRs5ey+O~mTP`oc|T5XpG+8eVy?Ur|agnuxVs%fK; z=`B_s`{I`lrZ{mtvf%CYwWT`7c;VCm!~_#vfd$~42q3_N_9AEWOvPX+3YBY$>C3>d zF#3g>X(P%LeQ_i~(W^@x39T#+r@#P}o!sUEURU}qDbVQ7UbLR`0}{Z+cs@A!?GXp8<&2VyFKEtCDcWJtc4S zCspc(=I${mXCQ|`Do+UIIh;l}p0)cIlS-nrf{Hl%j41kDmZ5_4ZmoroQ~QlKtO9n@RT1x`(5at(~s1zJrzf=V8^BnS}aO$h%)r+M4=KE@E)Kp)d(o zq@W93tev9jTy+TZtE{OA$02<8l3;v37$3n^p=6WEIfJR|7i?1B+Ah;sxq zfV1%RZoU)tP7Ye#B(f^%rS=|*;R&tib@qHG78^JLXjy)&;B$n$1iBF;9nv4oK2>j5 z9{OUSQc-A$oQBwdG!&vns8j}pJnnK1Di+QPm^)RF*XZy^1rXl#c zc#ki(aq5z2nLi%J0NZpY~tFPCU;kP{^e(Bfd=?~x5A=uO#Y5DPq$D9_rC5Rfvr|xx;iv-HolYPGz!V#4er+_)tjx z;*HiGrQi{U>0hl;*>Q`Ftt!ANs6UWRM_Oepf^OE5%-V%eUc#i-jT5Ct>zq@wx}2#C z%*OU5d)pMb_DNmO#N2&I>UhO@M$9pvbf*2Mna^{HqYvrP9#H&*yC&Y-S?{QkszH+^ zlq%g?#cArQpS_Z(%}1Y`&GGtir$wihKcXB(cXnkRL)d>ddCb_fYCq9_yAZE6z~+uF zg+yg+3e`E9sIY0p-d0tRoxx;pMm%%z^OY}3ekP5>?r!tTm6hfFvQG`AvDL_~p^$Z<4+coj+y;5#9)LsA5kBvaVH|C z`)TFzPogU2npeIxe0lFEgTjI!VqaV9Xb(D?>suncrhXj=sa#iBWvyV?7JiR!9Z6T^nzLiP<=auW`7Ta0Wv?U2<~TCp3%wC@L4v@w{G7JfxZC z3=&FEM#zpY-APbgTRNJ_mz)WqJcdE$_?D}|1e|E0vpS`~XzfR*&4el@nZ%m5&}6Xo zYM0)NoShk`_Y7*mCsm9C!@)%u6#`99o1R0g2a?JnlRV+Ry@Owj>>(8E#r9H1Vkr+o z3T&pFl_G`qMG0M)7mnXrAv8C4?g!u@Lv?2QR`J>t`Dp~Yg8B4hKjIr*(5UiBZ@6Fy zATw2H91Yq;K%Msj&wPEmw40Rd6%~jsH!XD)A&&(tvn2XdOHI%~-6;xfSvk%wt5yKJ ztJ=tA-wKk=H?_8-ma!FwhhZ{o_@KB{^Z;<=b+P*R#z?rN<~;-XE2HVdgW3#i0Z~zq zuL3Oi=tq2+;mWEMHxfAf1HGfKUoxg_vkXzt;S`3zXy+kP6fKjP%Tg^48RzcW4Mr|# z$Xki2#z*$=4|7#@ZEb4IlA{wpTHSWM5PH`$Yx7jRmC0!*J z>_^^pi|CpbpM$`0hMHCk7dsxezHpm|1WVVPLIqU9=qy^}arl@~2I=tI1ng3AMLBGEFG;%e@WKQZFs;l5{@!((>AVR2V{yN>GenMpRfzR+PrtC|hGS21nGv`%o1{DQ^z3EOsjy#8%} zm*G%WTc4g)=g?h@otXA{9=!JJrRdnze9rq}_@to=_ekA{`F%r<%VRo)i{{W{)iD=Q zSKEzWyYcM~XOH@4SNbr(KKpJ*8y}prWzdU{Z+GjvY&jvm-j5fA-H^vO&)OUpo3q=v zJ%+Al>#MBWak?D{H-z_zmX{xq58HG$ijSM~@TxreY zot`+49W8cunYQhZvcF{3mMcd4UA(x45BhvOmo8fRpY+|HuW@;JgL5{R8690+S(kgx zS+ey6tl0W~#6a6q38;dU4V3&Sj&s;IY}&V~P@4;MOw$$@RQ$ zm0C};z=7R}Mj?rpb)$rmx+X-LC}mp#P7ob7MaMq-!`)2Whvxx*{Njo0JM4~@C?R?W z{c7@7!`%crIiVr{o>>z0podA86OE!{V95Fdos5nY???6NbO(95lbOtUpO|+jnd@|Z z4P?~@>Urhdcp%g2Ge&m87-FoEFd54*Mx!Ft@&NH}z564$$H_Y%sgSwbM$B;?<(vKH zdI_N%(}pVgC48>JqLYd+ff+=muFm00`xrDZj$)C?r+abH7=HHHU zec$?Z-(LF^>|`dskdRPtAH_kYU>l(G4mrIgUv$&@^5*Tz8-l!E2w@%@+kU(4HwY_u#M@Lu zv5+j={#3s-xJ;t~GG2)9W&{hG8g-xENhTi>#~@Aj3J$w_HTTuA|Hs=gTNGh;sSd<8 z(DVMed9$N%@!7Tz&GKMW&eqokk|i=A)a|9!>6beMC~KL+)>XLJ%#{QZRt#G4k^SDZ zb0*VrHdrFY^Dfi@w3Dw;fq|~kJtz_LkB)WYMl$KlA;C;44sM}3Mf<#`9>*8Z6uM`>VaLjKHs%)ULCPw-!@&7ZRr^~WrEZou3lE-bxE=2*N4vI=3Pu`=3j9@p5B#`G^p{Bdz&?|+eyMuvI z@$Vg+O#InSIzFEGvx3wYvTYhTY9j?I)x-TY`#kH8e1Re5i#Ca*G*0p$3?hflPG|D1 zG!*FsVbyU&Tg}1!8#h+)L;&rBRWtGz9|Ao#J6jm_sff>1%i!>x?d*sa%;eJ@8XEi5 znw@vzkM)*1?B*>`_#Y0oDH?_fp4h43*LkV5ZuNP--*^1t0!&VWBIF@!4XJVD z4H#apD3A@bNuG$2cT^ed#rvQUdfE*{f*BGiQN$Y*qmY)GnVLS@4HN+;!Da{h)T!tj zyE9!-;0_gWEm$Ne2X69Nmidp#_8FK$5jOx{w<7iUM|_NNQ?L*#?p=a7CRe*xe?0(} z@7_QPshtC}_^Hx7>NiWKocdv6$!h^x^kHh|`OwM3LWs_lzr@9c+7jphwub_P&_`?? z=4w9qzPE|+CkS7qi0aq>0A!xbzD-UZ3oBQRLzOolLc(fOZ6Vt|l^dcV+tn3Z_Eq@c zbEj}s`uPNr;m#G^|7y#cY3tj5d6Zhq>+ddF8g$V{@npm4f=J<};I>IMn^SUY6Z);^ z4QMO5gV|2CUWfx+gFht$myJs(#FeGEyx3ZNnFvmX5`!>cu8N&{Rks}Pbmv;_8m9h% zuSZEPlt{9E{JGD{bY$d+8NGThEwT>f`Ww?RRRr&D?xxYslNLn3 zZXzmKIJeoEists@zLbZpM19+m2p5>zpJxH0fqs8lc91^?3^Z;t$~sFL+QbC7ks`v6 zZup|P;RZ)P;I?Naf)Yl$;pJWeH%8oMuv@qsFXE&QrGe@MBr0R9Aa5+V@hl;+s>Y>< z;s*~acSR5((#u^pFHAA$9@*gESA9=_4Z5-xfbM)NSd zbd+QHo25Hx##tU1ePxwhU%_oWv#{xu47B0c=*eQNCeCDr8l zhR1ztPR(Qk&?pupL!VbP25F!*r-5JTX?*!QDMV-8`CAtsxVnRgLyv)wvV~)q z6fMxlG^7_EDm65SP7Jb%47@jhz=_VvV^z}X*9{;d7OD~idcN8D+{!H>a?%i4$q zB-*#<^NG^OZNt^=>=ov1RXN(rOYy+w=lw#9=0wD7&VXq5Ilx~$0;&cCY5H4~2$;{! zA}aKBE>-c+z>3aF-rqz{O0lL&6bt#o`UzL$GBtbH@pcHsN>Cxx$TmPj zvP;66+(Lcw-m6uF0MBQ}?O9jJ?I7+TW2^NcgaHc9giBZ3$xVs1B^_jMA-7CTfusM#p!6K~2VxpE3e$ ze>tn4xF-^z%*K7P*c;t%9vAG1@;;KNr~q#ym|E)5(uRcB*IdN6$ekSLPCx&0*%)rN z{iSA5KHzMZ0jmm^BVK7kn}2k{FG2eeY3Tzz31Ep1Pu3TPJL59wJ4vy7eWQV*bv<+n zm#G{-K?l(D858tcI!*-2D47SMPRIE`T$!E*jVWkDw(Oj6F0$;H<*r~900Wlg9oQtL zdHX<8mEzP{LDn+*nED!*yK?i>{V3})1NKGF+H2OT=+Ze$Dq?L-BiOTm-y4)V<0>W+ z{ZGc|JU@|`+!-ER*JW_&_^2MRxEf6om_z4oi)4?OtqSM&CH&lGHI<_WrP$?`{_d1L zKKP@EdoJUKHvRO=O9FOaU3(a|Rq?!^#<*Vx3co|J(9HWA3tZEXed}+$y>(Cps`1Hi z5jsgJ8H=xSd$dY5WKj1LE-$A9X3~L^`ynN4jzZ*eD%msbp7ELtWrf5fl=%e%*>@#4 zbeot?@mM3~Y}TQPeU*Pm6bVT1M~6W|3JVG{^N(Oib0k((viYp){(#&(Is7XqXx)p) zLSAddQhi?n?!;1+kR%661m5N6f;Oq(uYS2WL0nj3N-RJKSpEpsfwwO={qDZ*b+N*F zKGcggiMRvMLkLV7MAHS72##d@=91h5@N=wFtmK1U@zREz?cg_Yr**kCidP5(+^Lc) z%hhcOUZKUx#4Lqv#CUup4l1 z3}J(cZ`Ik6vsh&KeJR1=EiU$~37(vtw`iQVY{&iDXvel-f$?|h92gnMfc4pes%F^dY`Y?2@9C0w+w4%i&v-R_m!+!D`47151CxRDede#84_}{b#{DE9}|^n zyLPpDigz6!g+r4z~zR^DzK2si1knFswWtwLW?OeiZLAhwX~SZNC}DuuPfA}KtvaK6ibhTw zsZ@hzZkt23$gQrGL#4~D{_BPQd`-YX_-9#7s-}rbYV4ugGtjKC=bYEzRn}Pn@+de` zb%eBC8JWTNf(tstRo~K z;b3tj_9U+q2B;Z!Tq}jt>?1i@!xQJF@n!-KX>w;t!8(Jd8@p*2t#1bTlM(l0JEV|& z;@{}G0?J$scPR_HY1YnyOLY6KSp z{OMjR+o~k*LfmrD+1X!xJDxCHz74$_lUfIOE6@8uTz#)hHDIsFJ-;%@PY2FsEqf9n zF9;5z5YL}xUsN)}B`iVKNsXNb2O*zU4cMNc)9MgjwdRRFXLc?x5?ZFl?{2_702imT zKp|X;jYEm{U;FMyuAq0($T-dpv-ll`Ig}Iuul!X&)|z)gkYNc`waSDudd1GokY1*K zO`Mt*?om( ztGG$)XXtOexGXHfvM7F1o5(IoF|}x}5M>&x(@-3UwvWOr#0}Sj-Kr2;#r0|9zEm=X z8P6QIGR?cA0CzbcQvyqCM~ICOoknNrygjS7@3X~;b%MyAMT%Ol@)~fg`|Z)eK^Ug>b9#Q2tJ#-^udt|6hct<@n0;m@MSlY%f2s9yYHaQzQiI&Az!TrbgCs-fz2}{2vG&REIXl{14zMs6n z>sQW0`Ruuqr!1D2?Mi#1u1dFQ>9BHj?0*aEDodF@92ms7NuH~EgK|5Fo2RMi5Tvps z(uuho5V=biQF{q0(b`(&Tkd&Gsxc->67DPKh6#G}lznRGR!lx%mzaLt<>T4_aVQX7 z)nm@UjIl3-i#Dp<9)j8`zH5?$b3&HVKU>$(D0RM|1axz-1pMZT=7eZAQWKB+3>4+h zd6)D6=cbGZP1!nTv`zV?0haVEsE!cfvD1d4S1qI1&Tu&dyKm(?JH~ZOs)$qpkJqfz z97Z;zCGuBss%H}iu56!a1|?$S00K7fnkm{*`ecf=XJ5iw8n0kR)}S9mgCHu}g1PGGiGF$d@YvynkiGz^Jg-g%tr zzw~h?A#FRqJ|Xlv3;|rA+X+m6rg0yaq1lPZDotY29<^e{E>BTMaLzwNRE~7U+l()1 z60#_GLTh(xs@>wSFrBK;kw3|>+Z+d$3o6ww8bZrfg-c)Du)q? zfvPM5F_<&xYKHcrpbwpeSF8d?cf1n$3Sem0OZKo;>nJkum!HTGK|~;J%D(&_xN1^)6!H) z`r+3uDav(+-3Hl~MG1~7>sQA(B-;pj3odq2cxN<=1nmA6;I81lBaXOLlrEg7gh%oa z1$G+xGj06~yCAtk2G#ifQfrV=+YSIbOJ@>re;7Us zdgXjrpXDOWbIC46{8tQPs_vfDS6kR)OB?b@B8EkaBFeHn(6?K}shrpI} zmc7?!60z1jhg;kj0+d=R3vv9w86n#|)4jz92-9#grTNg}6u^(9F3GNvEPML8yEa(V zA_;st=q)svOekxPA$ ze1OXOGi6KQ11j2?td+ogr4M-tuh|AyC%pu z+Dv5fqr5?;M7uc1tP>c%zmr)Byxt+u5jghFjF4dI)t5$_M*d;s;#_#g*sbGb2|r@E zY88GjEep~WFod(UTcU?hbuv4K4hZ#m(iUeW2o#wPWGpjnhJ_Z@7AV)^W*F$2zW0#p zPZv5?oD#P8s;hd;WJC4n8{4#iVXx6wBPz&{XQHxceO<^L(z_XJX!RGD&0_~f|H!X1 zFgq(G;mj&mV^Ed!3Qa#MFTa<DpKo zNV5;B)S4}#uRw6-=rdlR2ivR~olOpMYT>)G4uEn2WV>!20#5`ge`Z|Sm;*`&;i}mT z83w?d=}E4~M{uS}F-Y%-q7}KbTXh{Kg>L2<7jxGKT6=&bI;Sr+p(xv!gMS%0;fq}# z^aQM-_3?0azmMQnYwrn5Uj)y4g?`DAG@M_}_rB-SbPQ~3b8)_}zrA`s+J5szA{26! zEf~KyyvVMBxiEf$JpAZn>QrBKw{xmkx!_GeM13{8xg0s$%AGOI4*1bBtI(E8w%=J| z{-Hd`Erjjm>rg18J$po@NeWiMUjU7tJoWJI5?!FVv^6{Ibdk2i`#+Jy&%ojTk32^j zQ*$RXXM^AJHLiAqeULvx{DPm6Zt_pO|2@U<&#@xPGD6}qqBQQ-R^Btc7C`g}U|XI! z2HykGn;P%->U1bjHHx^y#aK8yI6qSc8O*QGv720=jk`c^-gp@q10La!17aY^L%++{ zhLF5wctOWlHX>A}gcM3jG!bc6AJo>p$_!gn1f+zW9nu9bqnROeM*zZ>p{ND5K>KCU zd7R7H^Yt)VQDf!H;>dKPK}6~Psf z*2EQmDDa-8IOF7W8ihVXDkal*q5B0KAw;y*OAzV|d3avlFZQ0|jjA0}^CtB58e}Rq z^jhVQ>{CD>Uf{oPf%3i9o+t5E-l_wO3y-|>Dgr~MC}0?a?-{k6FEcii7A zQ2&GL`q>BQAJ%R3XFclgh`*O}{s+3%LUIg(UJQj?9#QUF;h~MFU&-(ul-2Yd|9h@Kx1W_1{ z1Wz_#1i_rF!h@Kb7yGaZu?0&IEJH0wJbHBoe7?=ondF|24Plcd{F_sgazA?jAiJRR z&jWiLkM(gD$w=m5VY+B=59@rm4qAxc)zp5TW@nF!fJV(Co0Q0B{hE{*)CJE7elG484}fJsFqQZdRk!6 z>+D7R|H8{2Lp}WzKyR{&yzhqrV180Q{q~y(!%7York}0@Ik3y1Rjdkk+p)bc{l``F Ms literal 0 HcmV?d00001 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ffbc45271f..127d796ab2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,8 @@ Before you begin: Not all pages have a 1-1 mapping with their location within the repository. This can make browsing and locating the file you're trying to reference a challenge. As you browse [segment.com/docs](https://segment.com/docs), you'll notice two links in the right sidebar, at the top of the page. Click **Edit this page** to open the page in the GitHub editor. Or, click **Request docs change** to create a new issue that references the page. +This is the best path to update a single page, or make a small change to a single article. + ## Want to go deeper? Fork the repository You can fork this repository and clone it to your local machine to make larger changes. Examples of larger changes include: @@ -19,7 +21,15 @@ You can fork this repository and clone it to your local machine to make larger c - adding or updating images - updating navigation items -In this scenario, you'll fork the repository, clone it locally, make your changes, and submit a pull request to have them reviewed and merged back into the site. +In this scenario, you'll fork the repository, clone it locally, make your changes, and submit a pull request to have them reviewed and merged back into the site. For more information, see the [Dev Guide](devguide.md). + +## Have your changes reviewed + +When you update a page on the Segment Docs site, either by the "Edit this page" link, or by forking the repository, your changes will go through the Pull Request process. When you open a Pull Request, you're saying "Hey Segment Docs team, I'd like to update the site with these updates." When the Pull Request is opened, it is assigned for review to the docs writer who is most active in that area of the documentation. This is maintained in the CODEOWNERS file. If there is no writer assigned to a specific area, your pull request will be randomly assigned to a member of the team. + +Once you submit, the reviewer may have questions about your submission. This conversation will take place with GitHub conversations in the context of the Pull Request. + +When your Pull Request is approved and merged, it will go live on the site with the teams next deploy (mornings, Pacific time on Tuesdays and Thursdays). ## Site structure @@ -33,17 +43,17 @@ Anything that starts with an `_` is a utility directory of some sort (and Jekyll The most interesting ones are: - `/src/_includes/content/` This is where all the includes or "partials" - the reusable content - are stored. -- `/src/_data/catalog/` This is where we keep the data we've pulled from the ConfigAPI in structured `yml` files that are used by the build. -- `/src/_data/sidenav/` This is where the navigation structures are. (Several sections in the doc have their own left-nav, making them "microsites".) They're just YML files that we manually update so we have maximum control over what's shown and what's not. +- `/src/_data/catalog/` This is where data pulled from the Public API is stored, in structured `yml` files that are used by the build. +- `/src/_data/sidenav/` This is where the navigation structures are. (Several sections in the doc have their own left-nav, making them "microsites".) They're just YML files that manually updated. ### Images -**Save all images locally! No linking to third-party hosted images!** Images are published to our CDN from the build step, and this means they won't go missing if the hosting service dujour goes out of business. +**Save all images locally! No linking to third-party hosted images!** Images are published to the Netlify CDN from the build step. -There are no _enforced_ naming conventions at this time. Files that start with an underscore are ignored by Jekyll. Anything you see with `asset` was dowloaded by a script to migrate it out of Contents.io. +There are no _enforced_ naming conventions. Files that start with an underscore are ignored by Jekyll. -In general, it's a good practice to name images with a description that helps you (& other docs maintainers) figure out where they should go within a page, or within a larger folder of images. +It's a good practice to name images with a description that helps you (& other docs maintainers) figure out where they should go within a page, or within a larger folder of images. A few possibilities/suggestions: @@ -63,9 +73,9 @@ Each also contains a `catalog` directory, which contains all the directories wit ### Programmatic content -Programmatic content is sections of documentation that are built conditionally, or using public information from our Config API. This is *awesome* and like the holy grail of docs systems. +Programmatic content is sections of documentation that are built conditionally, or using public information from the Public API. -Programmatic content is built using information in the files in `/src/_data/catalog/`. These files (with the exception of `warehouses.yml`) are built by the `make catalog` command, which contacts our public ConfigAPI, gets a list of all the available integrations using the Catalog API, and then parses them into static `.yml` files. +Programmatic content is built using information in the files in `/src/_data/catalog/`. These files (with the exception of `warehouses.yml`) are built by the `make catalog` command, which contacts the public Public API, gets a list of all the available integrations using the Catalog endpoint, and then parses them into static `.yml` files. Most of the programmatic content is built into the `_layouts` templates that each page uses. Sources, Destinations, and Warehouses use the `integration.html` template, which uses some Liquid logic, and calls an `include` depending on the integration type. Most of logic for the actual content must live in the include file itself, however logic controlling *if* the include is built can live in the `layout`. @@ -94,7 +104,6 @@ Front matter variables have unique functions, including the following: #### Content-related front matter - `beta`: default false. When true, show an "in beta" warning in the page layout (see the warning in `_includes/content/beta-note.md`) -- `rewrite`: defaults to false. This is a legacy front matter flag that comes from the old `site-docs` repo, and which labels any destination that was rewritten in ~2018 to a standardized template. It disables the duplicate "connection modes" table that would otherwise show up in the boilerplate content at the end of the page. - `hide-dossier`: defaults to false. When true, hides the "quick info" box at the top of a destination page. - `hide-boilerplate`: defaults to false. When true, none of the content from `destination-footer.md` is appended to the destination page. - `hide-cmodes`: defaults to false. A renaming of "rewrite" for more clarity, hides the connection modes table in the boilerplate. @@ -103,12 +112,12 @@ Front matter variables have unique functions, including the following: - `source-type`: These are only used to supplement when a Cloud App in the sources path doesn't appear in the Config API list, and needs its type explicitly set. It runs some logic in the `cloud-app-note.md` to explain which cloud-apps are object vs event sources. #### Utility front matter -- `published`: defaults to true. Set this to "false" to prevent Jekyll from rendering an HTML page for this file. Good for when you're working on something in the repo but aren't ready to release it yet, and don't want to use a Draft PR. +- `published`: defaults to true. Set this to "false" to prevent Jekyll from rendering an HTML page for this file. Good for when you're working on something in the repository but aren't ready to release it yet, and don't want to use a Draft PR. - `hidden`: omits the file from the `sitemap.xml`, adds a `` to the top of the generated HTML file, and drops it from the convenience script for regenerating the nav. -- `hide-sidebar`: defaults to false. When true, hide the entire right-nav sidebar. Use with `hide-feedback` if you want to disable *all* feedback affordances. -- `hide-feedback`: defaults to false. When true, hide the feedback in both rnav and footer. Good for landing pages. +- `hide-sidebar`: defaults to false. When true, hide the entire right-nav sidebar. Use with `hide-feedback` if you want to disable *all* feedback opportunities. +- `hide-feedback`: defaults to false. When true, hide the feedback in both nav and footer. Good for landing pages. - `hide_toc`: hides the right-nav TOC that's generated from H2s. Also good for landing pages. - `landing`: defaults to false. Use this to drop the noun set by `integration_type` from the tab title. -- `redirect_from`: Defaults to null. Takes an array of URLs from the front matter in a file, and generates a "stub" page at each URL at build-time. Each stub file redirects to the original file. Use the path from the root of the content directory, for example `/connections/destinations/catalog/` rather than `/docs/connections/destinations/catalog/`. **Note** We are mostly using NGINX redirects for SEO purposes. Approximately quarterly, we'll collect these and add them to NGINX. +- `redirect_from`: Defaults to null. Takes an array of URLs from the front matter in a file, and generates a "stub" page at each URL at build-time. Each stub file redirects to the original file. Use the path from the root of the content directory, for example `/connections/destinations/catalog/` rather than `/docs/connections/destinations/catalog/`. - `seo-changefreq`: default: `weekly `. Use the values [in the sitemap spec](https://www.sitemaps.org/protocol.html#xmlTagDefinitions). - sets the `changefreq` tag in the sitemap.xml generator, which tells search crawlers how often to check back. - `seo-priority`: values from `1.0` to `0.1`, default: `0.5 `. Sets the `Priority` tag in the sitemap diff --git a/package-lock.json b/package-lock.json index 08eea7ba76..a2c9b8eb85 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1623,13 +1623,13 @@ "dev": true }, "@jridgewell/trace-mapping": { - "version": "0.3.14", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.14.tgz", - "integrity": "sha512-bJWEfQ9lPTvm3SneWwRFVLzrh6nhjwqw7TUFFBEMzwvg7t7PCDenf2lDwqo4NQXzdpgBXyFgDWnQA+2vkruksQ==", + "version": "0.3.17", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.17.tgz", + "integrity": "sha512-MCNzAp77qzKca9+W/+I0+sEpaUnZoeasnghNeVc41VZCEKaCH73Vq3BZZ/SzWIgrqE4H4ceI+p+b6C0mHf9T4g==", "dev": true, "requires": { - "@jridgewell/resolve-uri": "^3.0.3", - "@jridgewell/sourcemap-codec": "^1.4.10" + "@jridgewell/resolve-uri": "3.1.0", + "@jridgewell/sourcemap-codec": "1.4.14" } }, "@nicolo-ribaudo/chokidar-2": { @@ -1718,9 +1718,9 @@ } }, "@types/eslint": { - "version": "8.4.1", - "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-8.4.1.tgz", - "integrity": "sha512-GE44+DNEyxxh2Kc6ro/VkIj+9ma0pO0bwv9+uHSyBrikYOHr8zYcdPvnBOp1aw8s+CjRvuSx7CyWqRrNFQ59mA==", + "version": "8.4.7", + "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-8.4.7.tgz", + "integrity": "sha512-ehM7cCt2RSFs42mb+lcmhFT9ouIlV92PuaeRGn8N8c98oMjG4Z5pJHA9b1QiCcuqnbPSHcyfiD3mlhqMaHsQIw==", "dev": true, "requires": { "@types/estree": "*", @@ -1728,9 +1728,9 @@ } }, "@types/eslint-scope": { - "version": "3.7.3", - "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.3.tgz", - "integrity": "sha512-PB3ldyrcnAicT35TWPs5IcwKD8S333HMaa2VVv4+wdvebJkjWuW/xESoB8IwRcog8HYVYamb1g/R31Qv5Bx03g==", + "version": "3.7.4", + "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.4.tgz", + "integrity": "sha512-9K4zoImiZc3HlIp6AVUDE4CWYx22a+lhSZMYNpbjW04+YF0KWj4pJXnEMjdnFTiQibFFmElcsasJXDbdI/EPhA==", "dev": true, "requires": { "@types/eslint": "*", @@ -2011,9 +2011,9 @@ } }, "acorn": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz", - "integrity": "sha512-V/LGr1APy+PXIwKebEWrkZPwoeoF+w1jiOBUmuxuiUIaOHtob8Qc9BTrYo7VuI5fR8tqsy+buA2WFooR5olqvQ==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.0.tgz", + "integrity": "sha512-QOxyigPVrpZ2GXT+PFyZTl6TtOFc5egxHIP9IlQ+RbupQuX4RkT/Bee4/kQuC02Xkzg84JcT7oLYtDIQxp+v7w==", "dev": true }, "acorn-import-assertions": { @@ -2102,6 +2102,13 @@ "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", "requires": { "ms": "2.0.0" + }, + "dependencies": { + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + } } }, "follow-redirects": { @@ -2870,6 +2877,13 @@ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", "requires": { "ms": "2.0.0" + }, + "dependencies": { + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + } } } } @@ -3230,9 +3244,9 @@ "integrity": "sha512-+nVFp+5z1E3HcToEnO7ZIj3g+3k9389DvWtvJZz0T6/eOCPIyyxehFcedoYrZQrp0LgQbD9pPXhpMBKMd5QURg==" }, "enhanced-resolve": { - "version": "5.8.3", - "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.8.3.tgz", - "integrity": "sha512-EGAbGvH7j7Xt2nc0E7D99La1OiEs8LnyimkRgwExpUMScN6O+3x9tIWs7PLQZVNx4YD+00skHXPXi1yQHpAmZA==", + "version": "5.10.0", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.10.0.tgz", + "integrity": "sha512-T0yTFjdpldGY8PmuXXR0PyQ1ufZpEGiHVrp7zHKB7jdR4qlmZHhONVM5AQOAWXuF/w3dnHbEQVrNptJgt7F+cQ==", "dev": true, "requires": { "graceful-fs": "^4.2.4", @@ -3486,6 +3500,13 @@ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", "requires": { "ms": "2.0.0" + }, + "dependencies": { + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + } } } } @@ -4292,12 +4313,6 @@ "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.0.tgz", "integrity": "sha1-Wx85evx11ne96Lz8Dkfh+aPZqJg=" }, - "json-parse-better-errors": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", - "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", - "dev": true - }, "json-parse-even-better-errors": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", @@ -4441,9 +4456,9 @@ } }, "loader-runner": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.2.0.tgz", - "integrity": "sha512-92+huvxMvYlMzMt0iIOukcwYBFpkYJdpl2xsZ7LrlayO7E8SOv+JJUEK17B/dJIHAOLMfh2dZZ/Y18WgmGtYNw==", + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.0.tgz", + "integrity": "sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg==", "dev": true }, "loader-utils": { @@ -5162,9 +5177,9 @@ } }, "minimist": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz", - "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==" + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.7.tgz", + "integrity": "sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g==" }, "mitt": { "version": "1.2.0", @@ -5178,9 +5193,9 @@ "dev": true }, "ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" }, "nconf": { "version": "0.12.0", @@ -6658,6 +6673,13 @@ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", "requires": { "ms": "2.0.0" + }, + "dependencies": { + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + } } } } @@ -6742,20 +6764,6 @@ "@types/json-schema": "^7.0.8", "ajv": "^6.12.5", "ajv-keywords": "^3.5.2" - }, - "dependencies": { - "ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, - "requires": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - } - } } }, "search-insights": { @@ -6831,6 +6839,11 @@ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", "integrity": "sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw==" }, + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + }, "setprototypeof": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz", @@ -6872,6 +6885,13 @@ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", "requires": { "ms": "2.0.0" + }, + "dependencies": { + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + } } }, "depd": { @@ -7345,9 +7365,9 @@ } }, "terser": { - "version": "5.14.2", - "resolved": "https://registry.npmjs.org/terser/-/terser-5.14.2.tgz", - "integrity": "sha512-oL0rGeM/WFQCUd0y2QrWxYnq7tfSuKBiqTjRPWrRgB46WD/kiwHwF8T23z78H6Q6kGCuuHcPB+KULHRdxvVGQA==", + "version": "5.15.1", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.15.1.tgz", + "integrity": "sha512-K1faMUvpm/FBxjBXud0LWVAGxmvoPbZbfTCYbSgaaYQaIXI3/TdI7a7ZGA73Zrou6Q8Zmz3oeUTsp/dj+ag2Xw==", "dev": true, "requires": { "@jridgewell/source-map": "^0.3.2", @@ -7357,16 +7377,16 @@ } }, "terser-webpack-plugin": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.0.tgz", - "integrity": "sha512-LPIisi3Ol4chwAaPP8toUJ3L4qCM1G0wao7L3qNv57Drezxj6+VEyySpPw4B1HSO2Eg/hDY/MNF5XihCAoqnsQ==", + "version": "5.3.6", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.6.tgz", + "integrity": "sha512-kfLFk+PoLUQIbLmB1+PZDMRSZS99Mp+/MHqDNmMA6tOItzRt+Npe3E+fsMs5mfcM0wCtrrdU387UnV+vnSffXQ==", "dev": true, "requires": { - "jest-worker": "^27.4.1", + "@jridgewell/trace-mapping": "^0.3.14", + "jest-worker": "^27.4.5", "schema-utils": "^3.1.1", "serialize-javascript": "^6.0.0", - "source-map": "^0.6.1", - "terser": "^5.7.2" + "terser": "^5.14.1" } }, "text-table": { @@ -8017,9 +8037,9 @@ } }, "watchpack": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.3.1.tgz", - "integrity": "sha512-x0t0JuydIo8qCNctdDrn1OzH/qDzk2+rdCOC3YzumZ42fiMqmQ7T3xQurykYMhYfHaPHTp4ZxAx2NfUo1K6QaA==", + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.0.tgz", + "integrity": "sha512-Lcvm7MGST/4fup+ifyKi2hjyIAwcdI4HRgtvTpIUxBRhB+RFtUh8XtDOxUfctVCnhVi+QQj49i91OyvzkJl6cg==", "dev": true, "requires": { "glob-to-regexp": "^0.4.1", @@ -8035,43 +8055,35 @@ } }, "webpack": { - "version": "5.66.0", - "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.66.0.tgz", - "integrity": "sha512-NJNtGT7IKpGzdW7Iwpn/09OXz9inIkeIQ/ibY6B+MdV1x6+uReqz/5z1L89ezWnpPDWpXF0TY5PCYKQdWVn8Vg==", + "version": "5.74.0", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.74.0.tgz", + "integrity": "sha512-A2InDwnhhGN4LYctJj6M1JEaGL7Luj6LOmyBHjcI8529cm5p6VXiTIW2sn6ffvEAKmveLzvu4jrihwXtPojlAA==", "dev": true, "requires": { - "@types/eslint-scope": "^3.7.0", - "@types/estree": "^0.0.50", + "@types/eslint-scope": "^3.7.3", + "@types/estree": "^0.0.51", "@webassemblyjs/ast": "1.11.1", "@webassemblyjs/wasm-edit": "1.11.1", "@webassemblyjs/wasm-parser": "1.11.1", - "acorn": "^8.4.1", + "acorn": "^8.7.1", "acorn-import-assertions": "^1.7.6", "browserslist": "^4.14.5", "chrome-trace-event": "^1.0.2", - "enhanced-resolve": "^5.8.3", + "enhanced-resolve": "^5.10.0", "es-module-lexer": "^0.9.0", "eslint-scope": "5.1.1", "events": "^3.2.0", "glob-to-regexp": "^0.4.1", "graceful-fs": "^4.2.9", - "json-parse-better-errors": "^1.0.2", + "json-parse-even-better-errors": "^2.3.1", "loader-runner": "^4.2.0", "mime-types": "^2.1.27", "neo-async": "^2.6.2", "schema-utils": "^3.1.0", "tapable": "^2.1.1", "terser-webpack-plugin": "^5.1.3", - "watchpack": "^2.3.1", - "webpack-sources": "^3.2.2" - }, - "dependencies": { - "@types/estree": { - "version": "0.0.50", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.50.tgz", - "integrity": "sha512-C6N5s2ZFtuZRj54k2/zyRhNDjJwwcViAM3Nbm8zjBpbqAdZ00mr0CFxvSKeO8Y/e03WVFLpQMdHYVfUd6SB+Hw==", - "dev": true - } + "watchpack": "^2.4.0", + "webpack-sources": "^3.2.3" } }, "webpack-cli": { diff --git a/src/_data/actions/mixpanel.yml b/src/_data/actions/mixpanel.yml new file mode 100644 index 0000000000..f9ef006c42 --- /dev/null +++ b/src/_data/actions/mixpanel.yml @@ -0,0 +1,167 @@ +config: + - category: Connection Settings + settings: + - name: API Secret + connection_mode: + - cloud + - device-web + - device-mobile + configurable: true + location: Global Settings + notes: The setting is called `Secret Key`. + - name: Token + connection_mode: + - cloud + - device-web + - device-mobile + configurable: true + location: Global Settings + notes: The setting is called `Project Token`. + - name: Connection Mode + connection_mode: + - cloud + - device-web + - device-mobile + configurable: false + location: + notes: + - category: Event Tracking + settings: + - name: Track All Pages to Mixpanel with a Consolidated Event Name + connection_mode: + - cloud + - device-web + configurable: true + location: Subscription **Page Calls** + notes: When enabled, Mixpanel (Actions) tracks all Page calls as `Viewed {name}` by default. You can change the default name by updating the `Event Name` field. + - name: Events to increment in People + connection_mode: + - cloud + - device-web + - device-mobile + configurable: false + location: + notes: Not supported with Actions. + - name: Track All Pages to Mixpanel + connection_mode: + - cloud + - device-web + configurable: false + location: Subscription **Page Calls** + notes: When enabled, Mixpanel (Actions) tracks all Page calls as `Viewed {name}` by default. You can change the default name by updating the `Event Name` field. + - name: Track Categorized Pages to Mixpanel + connection_mode: + - cloud + - device-web + configurable: false + location: Subscription **Page Calls** + notes: When enabled, Mixpanel (Actions) tracks all Page calls as `Viewed {name}` by default. You can add {category} to the `Event Name` field. + - name: Track Named Pages to Mixpanel + connection_mode: + - cloud + - device-web + configurable: false + location: Subscription **Page Calls** + notes: When enabled, Mixpanel (Actions) tracks all Page calls as `Viewed {name}` by default. You can change the default name by updating the `Event Name` field. + - category: Traits & Properties + settings: + - name: Group Identifier Traits + connection_mode: + - cloud + - device-web + - device-mobile + configurable: true + location: Subscription **Group Calls** + notes: When enabled, you can set the group key as you specified in Mixpanel under Project settings to the `Group Key` field. You can also specify group id in the `Group ID` field directly. + - name: Group Traits to Set Once + connection_mode: + - cloud + - device-web + - device-mobile + configurable: false + location: + notes: + - name: Legacy Super Properties + connection_mode: + - device-web + - device-mobile + configurable: false + location: + notes: + - name: Traits to set as People Properties + connection_mode: + - cloud + - device-web + - device-mobile + configurable: true + location: Subscription **Identify Calls** + notes: When enabled, Mixpanel (Actions) maps Traits as People Properties by default. You can change it by updating the `User Properties` field. + - name: Properties to increment in People + connection_mode: + - cloud + - device-web + - device-mobile + configurable: false + location: + notes: + - name: Properties to send as Super Properties + connection_mode: + - cloud + - device-web + - device-mobile + configurable: false + location: + notes: + - category: Identity Resolution + settings: + - name: Use Mixpanel People + connection_mode: + - cloud + - device-web + - device-mobile + configurable: false + location: + notes: + - category: Other Settings + settings: + - name: Cross Subdomain Cookie + connection_mode: + - device-web + configurable: false + location: + notes: + - name: Enable European Union Endpoint + connection_mode: + - cloud + - device-web + - device-mobile + configurable: true + location: Global Settings + notes: The setting is called `Data Residency`. + - name: Persistence Type + connection_mode: + - device-web + configurable: false + location: + notes: + - name: Secure Cookie + connection_mode: + - device-web + configurable: false + location: + notes: + - name: Automatically set all Traits as Super Properties and People Properties + connection_mode: + - device-web + - device-mobile + configurable: false + location: + notes: + - name: Source Name + connection_mode: + - cloud + - device-web + - device-mobile + configurable: true + location: Global Settings + notes: The setting is called `Source Name`. diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index bfe1d86959..ef54438405 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -630,8 +630,8 @@ items: type: boolean defaultValue: false description: >- - If this setting is enabled, we will add `context.app.build`, if present, - to Adobe's AppID, as ` ()`. + If this setting is enable, we will add `context.app.build`, if present, to + Adobe's AppID, as ` ()`. required: true label: Add application build to Adobe's App ID - name: collectHighEntropyUserAgentHints @@ -8883,7 +8883,7 @@ items: enableHtmlInAppMessages is true, this option will also be set to true. [See more details](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#initializationoptions) - required: false + required: true label: Allow User Supplied Javascript - name: api_key type: string @@ -8898,7 +8898,7 @@ items: Version to which user events sent to Braze will be associated with. [See more details](https://js.appboycdn.com/web-sdk/latest/doc/modules/appboy.html#initializationoptions) - required: false + required: true label: App Version - name: automaticallyDisplayMessages type: boolean @@ -8908,7 +8908,7 @@ items: automatically delivered to the user. If you'd like to register your own display subscribers or send soft push notifications to your users, make sure to disable this option. - required: false + required: true label: Automatically Send In-App Messages - name: contentSecurityNonce type: string @@ -8917,7 +8917,7 @@ items: Allows Braze to add the nonce to any