From e72312ddbd19432a0515e5b077264db495381f02 Mon Sep 17 00:00:00 2001 From: Struchkov Mark Date: Wed, 22 Feb 2023 01:03:42 +0300 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D0=BB=20?= =?UTF-8?q?=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82=D0=B0=D1=86?= =?UTF-8?q?=D0=B8=D1=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .drone.yml | 40 +++++- documentation/docs/architecture/concept.md | 0 documentation/docs/assets/favicon.ico | Bin 0 -> 14794 bytes documentation/docs/blog/index.md | 10 ++ .../docs/getting-started/configuration.md | 0 documentation/docs/getting-started/index.md | 10 ++ .../installing-dependencies.md | 122 ++++++++++++++++++ documentation/docs/guides/index.md | 10 ++ documentation/docs/index.md | 9 ++ documentation/mkdocs.yml | 91 +++++++++++++ 10 files changed, 291 insertions(+), 1 deletion(-) create mode 100644 documentation/docs/architecture/concept.md create mode 100644 documentation/docs/assets/favicon.ico create mode 100644 documentation/docs/blog/index.md create mode 100644 documentation/docs/getting-started/configuration.md create mode 100644 documentation/docs/getting-started/index.md create mode 100644 documentation/docs/getting-started/installing-dependencies.md create mode 100644 documentation/docs/guides/index.md create mode 100644 documentation/docs/index.md create mode 100644 documentation/mkdocs.yml diff --git a/.drone.yml b/.drone.yml index 9bc2bd9..2598878 100644 --- a/.drone.yml +++ b/.drone.yml @@ -98,8 +98,46 @@ steps: - echo "$DOCKER_REGISTRY_TOKEN" | docker login docker.io --username $DOCKER_REGISTRY_USER --password-stdin - docker buildx create --use - docker buildx build --push --platform linux/amd64,linux/arm64/v8 -t "$DOCKER_IMAGE_NAME:latest" -t "$DOCKER_IMAGE_NAME:$DRONE_TAG" . + +--- +kind: pipeline +type: docker +name: create-docs-site + +trigger: + branch: + - docs + - master + +steps: + - name: build site + image: upagge/mkdocs-material + environment: + SSH_DEPLOY_KEY: + from_secret: SSH_DEPLOY_KEY + SSH_DEPLOY_HOST: + from_secret: SSH_DEPLOY_HOST + SSH_DEPLOY_PORT: + from_secret: SSH_DEPLOY_PORT + SSH_DEPLOY_PATH: + from_secret: SSH_DEPLOY_PATH + SSH_DEPLOY_USER: + from_secret: SSH_DEPLOY_USER + commands: + - eval $(ssh-agent -s) + - mkdir -p ~/.ssh + - echo "$SSH_DEPLOY_KEY" >> ~/.ssh/id_rsa + - chmod 700 ~/.ssh + - chmod 600 ~/.ssh/id_rsa + - ssh-keyscan -p $SSH_DEPLOY_PORT $SSH_DEPLOY_HOST >> ~/.ssh/known_hosts + - chmod 644 ~/.ssh/known_hosts + - cd documentation + - mkdocs build + - mv site gitlab-notification + - scp -r -P $SSH_DEPLOY_PORT ./gitlab-notification $SSH_DEPLOY_USER@$SSH_DEPLOY_HOST:$SSH_DEPLOY_PATH + --- kind: signature -hmac: 35a90784852fd87ed37036310873fb0c02457fb3dafd79cd2c1661b36b56117a +hmac: 8dbac280687d64b7b49961e75c59ea29ee1dfd395b8284404a1371b30f11dbb3 ... diff --git a/documentation/docs/architecture/concept.md b/documentation/docs/architecture/concept.md new file mode 100644 index 0000000..e69de29 diff --git a/documentation/docs/assets/favicon.ico b/documentation/docs/assets/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..032718bcbd2eaebfbeef63dfc082020d8a802b14 GIT binary patch literal 14794 zcmeHuWmuKXxA$yXQbeRnKokU|I}|BV8tG74Qc^&|0)tLzlub&ffP{i{$fg?vflW#` z`^YgWx~tu^ybQ(c*in4TB_K&Gm4R~rBv_+K1AL;!#7 zJ{vrSzwq4esOl2If6s}m-on2xxT+Ys13=z_{XxX>kTbxCbRLQZ9y%^I9^Q}Ktbw<; zH=n(;gS+J;S8F~OH{0Y5X?g%yf$H7cy3bP9r+h31_fj!iBi@2FLUZatco#19W;l7S z&-o5=Ghe@&Q8iUH;ZRq2wq8|t{_UVz#H{jVeL-cRt?`$kC&nY0A%xeB;^;N+Dzc_X zuy!n59kD9v+oYhSiL$g26q?!WJ~%p5V-wn`dh^`;=$l;nL0hz%E}u(5yO>S5z{9XV z0wVFq3D&J$C~>;5iGwW8XyWw(Y7ptx98JJUre(g8 zPiS3_^73)2n^Md&QpXGG{IhzmKKoGEa9AR~|GBErTG0g%sa6mc?K5n!*k_aBXzg&e zaJ!C&KCgfbC`FLOV4w*jD_|`O*I9}c)%co zhUZv(xz#Se;G)UaFG4WN!>XoXL^(BeIoDrl@8RIa%inR-2#f7PhPEZeLKj*?^B9lV zsXYK(FG}6)s^y_4KKu43Ng~yY#+@Ua9O%u=2o6vQB+w@Y#_KwI%K*^w=$A@k+0|i+ zq~ao{in@;qPpv?1jgP_uasJIG9mnrEim|grzRu-5n{MAR@6o?M6VQhoU?(A39x-F8tu=ZyBON4nLmA^@Ai}W z^}PWcFB(ffkXxIzCER7X5vx@=RSBsC3@dd}osDF7*%Xyk64%LoT@0B}3Q?H*6W#E{ zmI;8-CWEq#?g%4&=lUnU#Z364+q0>s^{rGg%dPJf96E z2$~PRp4jI3SWY z)Y@#@x0z=1u&<_0aLb480#NpM=~C6|I#rKPjD6RK3s}`El`@AF3-yN@QZ^{=od}-B zT8E{F`+n~G`RzP;urZDYN+-IK0yK$yi3Xf5?-%4(+DPakS)jmr{(ph<1kOmlts z%&ZmZlqDh>)USuz2@j!b8kMC7SGAfB3S1nlCahd%wJP^gZ&gj1F@8S-u*5 zAm@#B1{!D=Olk*W6oUab^wxt09dU$P^ZA@lYn~nAf=Fg1^IUHGZ!&r=3DH2azF^Bp z^b`Ri&Eh>eV*i9;;yxeHC*J5{kh2W+xkbH+4?uW3Z6<$}iNySQ)VGee%;W!xNn=++ z6`$RQ1?n^MktMn!zRUJo^cn*P6L=EuluY~ZSs1dTqk#|rm2u~;yWuXiZe9+8{OV6A znzkD4+9`OprM93DoA{{0xHh9|kE>&h-e_=xwK~+nf|VHw0NO3fEor|`H#v4tuZ@9D zyp!};d%3o@nIH=h{F3`gsHaj_TqO^ckJcST#(xY*jPrqNt}x_CU5ey$nq{?_NWIuJ z4aXo35n*%n`w%$*)ZKO4EuB>t@Shd~UH*yZ`N+6;-(aA$3KfWl6aJ~>`F-^JEAwJy zwG$sH=_)VXP_y=9HoMqAY>fS&(L$c9n0t&;2dyMC zIK{CMg(1f;n~T9hqQlQ-77*kZ!?Ip8`ZKn>(-*ic| zSNy#B_FW+4J+p+f$GP@#Yy7LTMK*m@!MNWY}A%4)$K1wG!gW*Kg4pVxsq>0gxZ3 zvur4uNu;RQmAeS?yQ)$+?Vl*+|1*j(oD zD^+OLfz14j145V2TtCU>o+Kx=%{Q!ooL?+kpuY|ucf3Lc@Bkm~qu77U`pbK1>sL9g z=YQ&fg{tj@4g~=1Z*zO!pUqEi)_>fK&gokwA+fb1hn0XRrO`XpfaKqcCGm(s5b0XNI-NA~96 zmSEesF*H_4$+LjNaKL%oh^{kYt*VY0GDhf2WhETXg^&x;01RIrWqORFWFj=eV>bDoFu@{%AQDRW>BPQq#pg@BZwta7=YU>mzx<8k6GJ4l~ zd5LL%_3Ra;%(-(qvq`lw!`XLIy?0gyLtUa&!vJi$-?#o0KX~Nv-7&p2f%*JX;4Lk7 znaWc08PlP>#c54??iLlS;-ZoHZpByn_Ut=M(rrR{R66|j2{Vs3ZKZaXC;V^t$RWvj zp>_q#KPlS|#XnI^)xbQ{eJB0!$xLHGQzi>v?w|k_i5?~;{R}~V2TqsJQI4dF;O<9B zreEp4sq-}8eflxsR@}VO7Z>q-WAl}JC$?;|(01SshLY2zw%;;IztYP$u>85@Cb=9U(iS4#-E4!V$5I(Jl8)1&rm;&l@Z#%ba{SW;w5U4BVU}&q8)ngvxa} zkH-2(G<4JA6zs35K|wUx#3Sdg(b#u1u*oRbKINyu`$39d#Q^zr)HdB1I&y!0+%51Y zNwoExO(wA-GlT(WT?vvRrPq(nc~gF%z9{AF7B%%})JDhl*T$uP#Ag3+xzeL^@Dgv{ z4tk9)E1Ve>bHl+H*DGPx7ivi5l_L{;K*p=^-w!?|&Xagd7YLdfEDgkJZLF-eeUYOb zx+cd9>L7y_uiczfG-?Z-$gclj0~1)?T~IVrv%Swh1dTyfqVRP?0M76)j5i*P6fGUR z3cjeqPjA319;7Ay5>8#=QKUiB$1`$>nq)!6sB5v;H+=Zd*Ke^l+OvfoXp3F7OCUq5 z=7gPR90zB5B_JT3S((iD(n)glx@s%WCGDTQTVBawZo{O!ffs)!Dev^S6X(Z2^YmqKe9%YCJR@9%L z!U+Xh!cQshUd{8ir?g<(bY2q6FPI{)r+w^8t}6;C`SH3TlGlok~u1*emS(}kB|BGX6~4~65| zWF%ftfnEi;0HVryVh>pbUpMWYv=XnqH|u=3gscFR^nCm+&HK?1>msD+jzGnanT_V{Mj8x|KeU4Nf8x_GqdsU#Bs!PJ@sy zQf^8-W3zB&a4$!rB&$kS;4ywv2Yf9&*URxmZ@Nx4r@MbrXJi^B9WmWhb(L~;{dnOE zi`_``gTuNrLl#iwfj=a2xwMXy5eKg0_Jiv^SVCAw`Pey$R-O2%;=7hAJM}GJs3`B5 z&%^y{-C?)WzJ5qyS|@t5-%#jYrB#sz*GTN!s(>d2PGq?OZ_JA~-(y}J{)~vtDgE4S zXK^$GhX-~2F+{0~a2iRs<&@jT3L?4QK%IH+OzIQ*?FFS{g3f&?w`k}az2&DXCdevmg{}dMdCgw4M(K{_62-G`=rW4qaA>i zYu-g>_G-*?GpPS;lBFYI{*c}zsW(x(gRKEmyLWPu{1h(Kd%+O8A>OFXrNOJJ@sw`( z*QJX)fhmyOg82W$ey#_+k5n|0zSZ~{?D0tL8oB@Onud0}oc5DS#NY8YJ$E@_7p7Mk zI*MjMT9(Fe?DC|cwb8Be`#+DQ_Xn~Hv|TUTdw^w>;lIXM-GN2DRW^q|1%zJ6w}X5jS>?jJzJcfpI?TtDx<(9RI@-h45KYJitm4#@7kG z_g-a1kqJgq@2cIq`NKll2s5f^ZSKtd6@MMru9V zR+!0xm8y_uSVaa8a9y9lpQpY6#$Ldv_p5sgU()4aB47Sap6_LUf2q)lK9>1CgW6MM zsf55J7c&zsrAXM{Kp`svxHG(cXKj`$_2s@Aj3^IRCxZ1Fe-t;0MV!)3K-Zosb^WZK zWR&uh*<_Y_xd-f(6Wor%!^R1J9Dkpw-Tjs9cUkp2UfmcKvB&0b z)ui8L)Qs_%azeP^5@|Kbt=vo4T`MIqi@PJI*d<4^W%=B*-st?XzV^})#o}(Jn&-)n zd-@w=vv~6RFtX5HVnDf{Ly#eaY@hTbW8_d7x{DS)GI9LuL;jXZ-G3=Zcnkbl%DX`!^=4vN`>Goq7 z+@X-@6nq(T9jvb=LBGJg4JPpJg%UlfqEkctL9r z!(6%y7xXB#&r|tZS;t~;Mv*ysWM_gv=X~0k0WOG1hRu`o?iwHN1-SU97AhM1%gpbW z+w7Nj+Cp#i4)pb==LSl5$~61`?uQ9$0gTDypCD8!w_RgG?R404?(Q-14KFqBW%2Ei zOnG|Gowb?4AbeXO{ZOLi76RFRsG=uWav;NFRTf*uZLQ#2D9p%;m-IRnVlTMC~IS z=$nVdkf^~+(4-Sx2bbse{EhY>=hOzH>gJ!9^?j+M+n`DyfaY@v0VIlH7|#>&g8)X) zxHED6<{n(dQ1M@f7&(9c^N&>d2V@6xy}@69VfxhZzycCl!;Vdy{T5?->*bv=X=5ie z@k(%9s;~2^yprsuI}7(nnC<=9LFJTCq?i{aD1%#ygmvpz9Nv_k$TX8*3~yJ$8@*SH zf|=h4{<7Hjz3IPHv30!tG!u1hSYs6y{RghRB82StXkNwKJhtKuv>}``Mvys9v!i{i*8*y+qTW^W6?31?T@&ky8>|=-Pxo`MK&kvBF2gz2QX%S z`;{r=K!=K1J+E?C87W-;6&&8ZcVrn(pIYokqk$^edflm;fk~et0wvT6zLS>5-YQ*= z(0ZR&)EYDz2uIDy-e|cHw59~)Ti4}~OD`p4!>m;_)ES7BJZ%*soC7PRGX2lbV0ha5 zp_M5%0WC5V1cl}?>1XWNCfGx>45#mj`eJfmmX5)1JjG3f5p!Y5uofM9;drg|Pu24P zKEE&jVjL?W9DvIIJox2JIUQE<;ipAn={qG^SJHG5_;*wwG}EI+Km`;6A*hw z1XLt~cfaa)rIk4Q=jlW=OxZdxx$_Wv_Tf{}ZNw-!pfR>GI6(VqUv&7Ff8cwqg*pry zCN{S&5AmC=_G{>SJBT}Omi_%o;2aH94AW8@aYwXNwuH8bmc|P_( zPd5Aer8!$R@V?{MKE0gKc_RCy%C!p)`sSk>g12Du%i#!(-`yr2{o6;jr|^139pmW2 zo+$$Bv&B-g+@mO*h=6Yy+O|+k?BbYo1|sm5M8Wssz&OqDHjUKYN%aY%0KW4|!a< z!O@}O`^2)*`T2Blyi70pL~yc=`9(>;lxXNvr4>rRs+!MaoUyYMi_Pw`1(Ad&-%5Eh zj;RBb_nwn%-}LuB$MZj?4L%v23o}K$aZFl%J9rg*9sS=>@%zcz3W-DFtK(Av%MUxd z9~7zfp28P`k1#c_z^ouC`uiN|o6vxBqv{QVslp%yIL?#$O|9P+hhD;tQhZ@&$c?13LjCQqY>qUA>^6h&KDL*>DtkHkE212@tFy zKZAEo#QSpIYo8alelLW3!Z9^dxXE}W$Jvrx_)uVqczk9Kc}XQtZtrbBLRmJ?XWR=P zRb`7|-Z`KM;gO{Z1-Yenph0zkn_0SCHa1;NH_n5uu`z!+1=Gii7sNQrv%7pVc$ZaO zfi3f7cz?M{zfR<0=(uU`?V->ysY%;b@!%8jcQNX(EEb4>A-7x~ii-~Q3h&#EBtiRHT|9Sa~?NIb+EvE zJ}l7=^ET%+^Y6j39Gu2buOF6w7^)iUPzX{Li1oIw#4!V1KS+ za3XI|{cSW$dB)8vUG5shqmtGs4O{&JUI{P7oz`d{HY!AfUiHBPgyNs_RYuZf(?aAf z2{MY-e)*(aUF@~tbB+sh<74!Xci0-oR2C}&YU%+VNQN-^!48l3{_EE*y*pwOhmhlN z=9pr?g!`!7QqqGCQFTVDuqbvgx)z&ssVA{X>~70a;r=7j>L11W$-!%UoNPJjJpCGd zmR~ih9s^D1t6DChEf zm~>GNC#XkO`km0Zc!fpFa+-)t?Rwls!NhAlm_c_XQX3g5xA)kb?xxof0nslDr$Xd& zW4yTe=5r(AH&4-D${e9+Bkn(jv>og^ioB?Pw+*z}terK#5cRgY|ULIt@TUT3}rzM5Qr>@hQLcD5V`QHHJlzp9Y%{C2+gx*w|IveAra!JKP+ zwiY8LqRA$3da#&ejN^|{pCjEbh$O~`Q?VQNHjF&79gsrvcAzs>v~W$n)$F-r-8ims ztwkBm2I!IZg|EC41g{RXF07{gj4}AxsZ}fhuIC8EHQQ*ho9;OJ4evjX`Uu&FNGmDO zTxVGBR8FGsu13HkVhRjnD_KxY7?=gcB7`1i#EnzdtYJU;>z9r+Y8^s03Xc(ah7Jsmktm=c&J9IZ^!#I|8Nk@;OyS1d)~1=FB}&ClW6QzfWk z$lO#`s6o^Ss;r#5;u+t`LpLTG@JALW=#_LuKm@%J&T%7G*wD*F>u#cUHwdz71G3Ef zT)H;0&ObtwJyriKT2?p;9p~JHFJBV@W^aX=-ZtGnbPnV188}5}Nmgdxg{jcorMR0Y zs<+F8fvc!9m$i;#`1bs@O{NVUtiZ=(g6C{TuXiMu-VrwkIHM(Gc;(qlhcg1-kUI=l8P&uU!N2}bM zwe7g-(Nt-zG3OC8lU$7oWMH^Mgi|s*n$xhZzQPi2^=rTCn8s$7B47=UN1ZvxCBQKh zx={0Q75UCzZv>9~6?#%dEGDb}YN;t!yfUbjx#PJ#_&8O#@-Ei^Uwf|86dSK!sg8#8 zT6JA)EH}^JWteuaKp^CmfWuH=-_z@NJ(3njo_utS3WY1fCR5@Zv3=8iBVhfd#{C=d z2~)3cRR1qzvp9M&B(n|L1!s(|RQ%4Fvm$1OX%shd9^y?&XYHuoT;6^t%p^hXnT_Z& zqd}Fx=Q$c;vYQEVAu!nFJmBeHC*g8ynE4rsvj8`RNnF!rEOu!)ZRdbrOf852?Pp>#}uf zsyx9bv##_;xYDPl9CeKj&7!6XlrlA?nEJ4%LTxn5gGrZCO>{m-=+k@=my-%83#CQp z6nmlDiWi*I<*>!n|5O4>>n@8AuI^$?-+-Xl(FKYp5LMUF`|84tDRW3sGRtODtGR~y zjoV|!ThZt9d7?5^Y}J7)3Ht;USfn}F-~FQL(^K4xx)MTQFV-Ne!6k^d`T(YkQrNQq zo5@nH_a2m5I>(;ut=1nG+e)qRv9B+V#IIDj^XNUC4S$fLqAvbK*Ly;gEci2wTBJ`~ zy&o?KW908*Ed~1%kAz9=v@z46oo6X;b@!W0B{|t$rU&_Yc&(&t+ z>a>azz#(HhSnavAC~mHr z&piWSgBgCa|Ha1OE6%`!0V47&f7Sx!nT>%=mrW;{!F2|`Z`G!n$d}&+3n-qsc|16M zy>fNR=bR(V_AAAuig+qe1c_PFsk&5BtimnqY;ALjySI85#*9>xa&N)8?yU}UeJKaL zV$b|OX5*sd-j5llm)~%FZQD36fqes5@S}s+eVCS*u5eN`H*R9TiUeDY?yRVPWbwTl z^_ovG|I2k<#XS9W+%e39zSUBXb^H0fta&BuS}&gkdjB@LST+nN3#bl=IPasX+uQDK zIZj|!GrILf_(7a?@A7BqslYia=5t!gMNAzmnM=%Vc~dp!d(RcDO|!}QJHB8(F^PlK z2uJT5?QSNBHEg!`TFzxf|N3{W23U0|cxOE}hJP~H&*}SnXDCTl^k83*wH)VB%ua&& z+$_x3F8Bp!8dX}}`ZV(FCVKLwF@6b$|Bj`l$4qobQB4{h8umt5=l+IHHhEuM2<3{l z!?n@@*LRJM`)lHAk1t<4Ve=dX%P=)t2yJv`)?`hwW5~G9QzV!Mt2`9xg~QP`&_`~E z8!BLCDj_wxv+ucSGw}utP0 zPdA3y^l;vh=JcY+Wh|)2FnvmWRpZA+Kn~N0l61Q{MxUH{tG4#j*gI46|v-i>*W zE<@`3`wHU)kIoyvP=ZLE;5$k@RoD6nTz_#lef(YD?2oP5K_h2W#>~LftX-m`0+Awk z*{=6Bj?CVhC&4GI>_lJ#ve9c;PaKV?u z>CZgfe>(-a3k?#8!yd!=ZXfBv3z^SKzNrA)NLVPaDkAD_(aflQe@Et7zf~CjqpuWe zrTr|rfiHIiBmLl74PoYY?^)-VKpff$*C0B;RsGGqu{A;lkz0W1Dr^BkzYZLaJ>-^` zw8cr$)%jdQee+awE}_iq|fMlltBL7pWf&Y&Ef}Dvy(DNkjrP= z&A;{&u(n);4~8r72ETEYiZ-oXz)y<${pYw0CqjvOOP_rIH?c*_-zg%AK9%DEr4xOG z!FkBkOG=m(2SYa`hnYMNhr8n6BX?~Efc_e<6U|0yTB_DdJR}kRAh4x!+D?fiVv*1=NJ^XeWhnDgfBM!U2 zMKRs?gQBVs`Oi;xDNaa(KaWRR{8ijw2Th*mOH%=ylEi-|DG7o)Qb16c*^EemYb-+k znH&xkG<(!S>gPv??@{VH&tUK z@IkV$>nTNuJP2}t8=m<)=TP-*vRg$Q8j5DYpo#fik;iu#D3rpg^Aa;PS8oqNCm;%b zs26})P58L-ehR_t75ULDv5P~)&IAA(ja(~pMEAL*SvmVf0T-}H2p<0Qdcwq&0+KCs zzx7!^2{l2Gfe-3#VOT<75e5hFdC+L57fRHI zapk}R@+fl#!prwd$XuZoDI2r%rOn4=adLe$MmH`+;z6cWU}FKTzT~?y0Y!F#E=6nJ6krg3%=FbO2nD`O!R|OpU-6X7Nlh%%d-fIrZ$zwfc@jLt_C9%hpxc6L=PIlHrT< zF4afQfFZ*-wmk5d1!BfHxvFc@m|0g*Z-UC@7dEho6qA0(=?;+pMg*D=ccKPi;D1hH z;li39=!?|j=X^$ZM;cbzq#k-Zd_Q}z``M}K0%-XFPqN+R4#tu2B(`Xize^)Cn6gj! zvySOD@3%%nY!%@qfmQ4NMx-Rc$I-WkP^_<>*|$ZWzG8R472hJVfW5)^^D0A#gXoUF z!Llwkh51dGG&CBQ*ymAB5OA!F1DUxE^OL|S=`zuvfp8$|gGZg}nfJ*?&vT-uxT4@H<-@(Qo`t8gtlKxym1^1cckIn3i!UgLJ#=Q$-OFX4 zx%?3}p%MOD2ZiH8Ybo#it?`-94j^I~v+OEAueHiqrce^utSVfqmY+000CKj+$ec^k zESq}+Q(4HK7>1L*JU{Q1n!*ACMq>7$C{i47F$A`8n8dndFAE%3b9t?P+N%kC zT?FwiKPDid$hX!Mmt1z(E~MzwTd&bu({!-X3S0lGPC>AU!Vs}J97CReV=5F$IK19} zYA%Y7yXHGBK*swbW%S@hH#_XE_^vV8N;?w1)WT}NXo_`YkO7s$@}yr+quSwmOJ)Q@ zUgZh`yw$PP*GxX$uR{3ZYMl+R7y8aHC-(=F;C$0>A7*kLIq_o&F8%ns5Xl5J|1({foOUQRI=K^Fz571YzPF{gkg73kP_>nkLy6fQa5 z{7q_7!MioeMszQva9|O5kLRp*`O}s4?w56pmxju?3QP+~AK?)J`Ag0Lr9w^=OITa) z3beESZTkMS-bW>8rdr3lV52v02=IX)@NiHN2P}=%o))j)NN?I74VLv^FP$QO?Y^w~ z2f*oJWZpYccDI%LIsVW)^_e^@HwST?`RHJa(dlIeeil>A{wH~&BWo7b%^&{bO6|sD zfq{1vcz6IU9S*pK1FM#qJeYCW&uqe4>{Hv1bBdq^=EUcw=EKuMYM9BQ;?qY7k_1=1 z5@KRMMfOXr*93MV(24*kEq@m~u~U53^# zxu3t(Y*;PTbdOT0JKwA-QBF~w7$y|mD!e}xN9_rWWtHI$pj3Ek8&cw&I>_{o@u( zZ?omDS!T-Rn%DOy_xIg}g+L&Wb5#lJ1-)-!_`kuShV5R1yqTZ!(bCfjU*s7Z72w~m}k-_Q{xV( zn~va`Zry?VlF_bwdBFLBbJml%hCDGO3H17T>C>odp*RFVmtg`sNS34V>%x$tYQ5}5 z(b~FC%5tVtg#jUCYuyF^@x@ZtTwjoefHD(I+*Uo5Z zI3bhv?K)IDpm|5{kj!;;Cw%G+oUFU_$0u)@!i1h}wQ(nJ0eEta-N>jYaR42~!CqKh z2XC)LQm$tCk06Z8%&M!ez(3hsR7!zGV#0bMKIH3V)KPK;Ke$`4Ji|d}%mZ0P+uU?n zwua|??dl!l&6SeZ3$e$T$ATBtR%?;|2>EC$G~GleR7v>ga>aAIMDT zE#FN;j2R#@R^Z{pcf=k$Lrz5AxNby!l5l_{KkQ4)IRqsAcc037eB79=A8x3`6HSF|E$Rx`U;kdAV82uStzs1 z>2Rpb2_|U?*W9|mPw*j>xQdk8;s$QuIxZr^$Mtw1+RF+FH5BD1Dv3gKrsJu3Veus!%MP*XplrU1&^)XpnhYGHpi`{g_ zckCu6s$m0GeWI1f-UQqZl9@&27rAJ;b4JOs2f z2HjVBzhpOF?xSg|#9>u^kkDgd-BBxaR13MUrB#!QIGE$-ya;)hdt!Qnj~E9uX@wT7 z|9n#`88yOj8C1b52P0H_&&}==!J|7jKF4<_&^L-$YFy>NcO9spuv1&9R&yLnLTUs` zV#4ME^Kb5&$Gd_^WcK$(2Tsn@M^G494@D_NW7s_N$q~XHyIB~wZTxB;{Yk+bs+k~bPeJRqK@813#e;6xJ(O%W75em+fzU8=_f5bK;S`w1|~anLv`o`+Rm9lZKF@d{zRT{T`WE@jJHpF zc;cz%%VE6<{l$vztjOoddV-#dqRw7g9tnu{D5bW~&pRt9^)SB&O&lEfX4vN*xz~=~ zLtmcWom|s*k=El3t2Rb)+WWx!4U!C436?0JMoRmYyLBK0u`bqrhM;4ND9P7{=^5b33Ut90K zrDY%mO>@E>f;3?s?Hba8Wx_LVN1^&Z9{JxD?6dy81K*WY`tof%K$wam@P+~p*vvCW zr)q2ar$!aU#wPS*FBv6X6|61wFhC4ko9zC3rssUeHo( z{N?epfJW%-d(~R6OO0FW7ksV0r_nV!Ca?_Pnw}dK@K6_Nx&G`>O|%fKxpWpLs|!%B z@);)Cd-GyLL6qo%q70^XCm+o}W*D-*w3E!2T$AtSu_@hg8iF+Y=hoE&Un>v2r%|$x z51P&0nuwduu~!@})0(1g-YzTh3JdXSs^zwSCfi9mj2v$Ouo<#E(%$XEuyv55{#70qjewud!I}`eq-l# z4~4gxjQf|VpN#J_apmt1d5eYaEGz{!)9#3<>Z}*RJ5acEh7+9b34h4Wza61!`RZ0B zq6>(iB*oHhD2DC)>DLdd(A18a;zR%wr*=W#AJH{_OTR*wbX^qJ`L3IdQGv|?TCm^YXdK$f`n&jwi z2v76>;#OPbwRgJf`;+*MxpR$;dd@%B{|JI! + dev.struchkov.godfather.telegram + telegram-bot-spring-boot-starter + 0.0.50-SNAPSHOT + + ``` + +=== ":simple-gradle: Gradle" + + ``` c++ + #include + + int main(void) { + std::cout << "Hello world!" << std::endl; + return 0; + } + ``` + +## Quarkus Extension + +На данный момент раздел находится в разработке. + +=== ":simple-apachemaven: Maven" + + ``` + + ``` + +=== ":simple-gradle: Gradle" + + ``` + + ``` + +### Reactive + +На данный момент раздел находится в разработке. + +## Основные зависимости проекта +Вы можете добавить основные зависимости в свой проект и сконфигурировать его более тонко под ваши нужды. Однако для этого потребуется хорошее знание архитектуры проекта. + +Этот вариант подойдет вам, если у вас используется микросервисная архитектура. Так как логично разделить стадии получения, обработки и отправки сообщений на разные сервисы. + +Также этот вариант подойдет вам, если вы используете менее популярный фреймворк, так как основные зависимости написаны без привязки к какому-то конкретному фреймворку. + +Всего основных зависимостей три: + +=== ":simple-spring: Spring" + Эти зависимости подойдут вам, если вы используете SpringBoot 3.0.0+ + + === ":simple-apachemaven: Maven" + + ``` xml title="Позволяет получать сообщения" + + ``` + + ``` xml title="Содержит всю логику работы" + + ``` + + ``` xml title="Позволяет отправлять сообщения" + + ``` + + === ":simple-gradle: Gradle" + + ``` xml title="Позволяет получать сообщения" + + ``` + + ``` xml title="Содержит всю логику работы" + + ``` + + ``` xml title="Позволяет отправлять сообщения" + + ``` + +=== ":simple-quarkus: Quarkus" + + Эти зависимости подойдут вам, если вы используете Quarkus 2.16.0+ + + === ":simple-apachemaven: Maven" + + ``` xml title="Позволяет получать сообщения" + + ``` + + ``` xml title="Содержит всю логику работы" + + ``` + + ``` xml title="Позволяет отправлять сообщения" + + ``` + + === ":simple-gradle: Gradle" + + ``` xml title="Позволяет получать сообщения" + + ``` + + ``` xml title="Содержит всю логику работы" + + ``` + + ``` xml title="Позволяет отправлять сообщения" + + ``` \ No newline at end of file diff --git a/documentation/docs/guides/index.md b/documentation/docs/guides/index.md new file mode 100644 index 0000000..f5adf54 --- /dev/null +++ b/documentation/docs/guides/index.md @@ -0,0 +1,10 @@ +# Hello Mutiny! + +Once you made Mutiny available to your classpath, you can start writing code. +Let's start with this simple program: + +## Test + +### Test 2 + +## Test 3 \ No newline at end of file diff --git a/documentation/docs/index.md b/documentation/docs/index.md new file mode 100644 index 0000000..ecd36ca --- /dev/null +++ b/documentation/docs/index.md @@ -0,0 +1,9 @@ +--- +hide: + - navigation + - comments +title: Home + +--- + +# Godfather Telegram – Фреймворк для создания Telegram ботов \ No newline at end of file diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml new file mode 100644 index 0000000..82fe0b0 --- /dev/null +++ b/documentation/mkdocs.yml @@ -0,0 +1,91 @@ +site_name: GitLab Notification Bot +site_url: https://docs.struchkov.dev/godfather-telegram/ + +repo_url: https://github.com/uPagge/gitlab-notification +repo_name: uPagge/gitlab-notification + +#edit_uri: edit/master/documentation/docs + +nav: + - 'index.md' + - 'Быстрый старт': + - 'getting-started/installing-dependencies.md' + - 'getting-started/configuration.md' +# - 'Гайды': + - 'Архитектура': + - 'architecture/concept.md' +# - 'ChangeLog': + +theme: + name: material + custom_dir: overrides + language: ru +# favicon: assets/favicon.ico + icon: + logo: simple/gitlab + repo: fontawesome/brands/github + palette: + - scheme: default + primary: light blue + accent: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode + + features: + - navigation.instant + - navigation.indexes + - navigation.sections + - navigation.tracking + - navigation.tabs + - navigation.tabs.sticky + - navigation.footer + - search + - search.suggest + - search.highlight + - content.action.edit + - content.code.copy + - toc.follow + plugins: + - social + - meta + - tags + - search: + lang: ru + - git-revision-date-localized: + enable_creation_date: true +markdown_extensions: + - toc: + permalink: true + toc_depth: 3 + title: Содержание + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.snippets + - pymdownx.inlinehilite + - pymdownx.details + - pymdownx.smartsymbols + - pymdownx.betterem + - pymdownx.tabbed: + alternate_style: true + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + +extra: + generator: false + version: + provider: mike +# alternate: +# - name: Русский +# link: /ru/ +# lang: ru \ No newline at end of file