From 07d91cde19229d9709e254a0431a34dffd61a711 Mon Sep 17 00:00:00 2001 From: lilimelgar Date: Mon, 14 Oct 2024 11:50:46 +0200 Subject: [PATCH 1/6] added files with architecture diagram provided by Kerim. --- documentation/cac.drawio | 103 +++++++++++++++++++++++++++++++++++++++ documentation/cac.png | Bin 0 -> 17647 bytes 2 files changed, 103 insertions(+) create mode 100644 documentation/cac.drawio create mode 100644 documentation/cac.png diff --git a/documentation/cac.drawio b/documentation/cac.drawio new file mode 100644 index 0000000..5393e1f --- /dev/null +++ b/documentation/cac.drawio @@ -0,0 +1,103 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/cac.png b/documentation/cac.png new file mode 100644 index 0000000000000000000000000000000000000000..429a460c526d799d60fe7f038517d321119af3e2 GIT binary patch literal 17647 zcmeIaS5VZ!_a~|($-;nufC|HqbB>Z6V1_7&AX$(gl0iU_AW;TH7;;7lk|gIWNis-~ zEICM)oN;^n?QYer+J~)sAMS3||A7}~zD@V({+>Rca6mm)S0W*#CA@Lt1_=@Y*Sc}z zCK~+U;^TqeK*y%AZrotFfrQIxzcJoUC1}tYIr&SCM0pL(7d$r4%?f;sK&zr)7OECH zQI8piKM^xCK0zY1gL|YbUS<$mu-z5pG*|w7=-YU5;=8lE?w0;GeN7eoe7*8K%HMft zwcR*wwS6>cv+aF6i-3=z;{3PzO_vh3=@MO4gV%Y+pkndOKTjbj<3Sx8{I_K9xd-!|EA~l*$V8e< zd!Ka848MyCF?a(XPAa+OG_em|uOK`s^efpTF-Y6}xE_XnDT{mz~F}=V63>R z3SmqPq!hZi!6!9AO0Yr#%#gfM>IIMIXz?-2INM2RqCw%sz@eH22J&t9+f932R1Bt) z{;eOn90xv`X=REU3&adbjm&wP>p=2v8D8$HCLiF~%20IfPwvmAw--xRYO}fR)G+JU zAa_;)pV%*uBW+qSLxyFIaEw;t{aZ$p6<&LBp)MmWs*K^sYMTUC% z6)zc?ls?9!y3bC=^O$(;DTp79K3RGHz^Ci{dN^BUrC)R|hV-7qX?|OF{J(fV(iOBC zhzYnY{pMk%UGvqk^HynRPq^qTTe3q_tqMnY7WZ!R-=?kFwX`z(Uv-G(H4Y&V{-~3m zx+ciEChwKc@9zs3P1;re$^x?(&e3>q@VE1UuOY37Et~7cD0^i=;vfkPpKR0VB2n#b z(}lCv?PWhT9>bc)tNqEWuA5`AzSn0;_B9K5dKE9xQh&Z-i+8hUy@$v_qggfLz<1~x z{~nHL41ZCh%QLF4YB(HLX)5_fCVl>!Nqqhtc3G2*_xbDE)5Wlr5e=E6r|(sGgM>pG zrGvP6qu~s@AWpPO=d*8jyBFR+;CU2GjOHw=X=RR89HwGM5C8NW5MS#mZocNoR16mo zX{C91bvUw;XqAR$ijdNx6@CTNHFABLNYUK4CjIx)$6`RShp7Ob0xo%i3WGEiDF z-Ilp5(Js_~8cagRLP9GPsZ*%mZI$lLvOQfL&sp3sELL`PGG}t%>yO+EM;g0$9;48W z_dg6%g95h?+v4JpP~w4pk?F7aHY~S)U+mQHiijO=O+GR9Sh=&rSJZs%X+2X@>fzQC z!;Y6@;&Y}T;kNbCGFU9hdgKeT+2`s*A-(7C&(70!)db`NM()3uRpPkNE4}f(AMOe+ zXGN<=eNjuMy&FT$q}avZNgsXSGPxCbNa-zhGUF27_p?AZ`8dUOOiy9^zQpU?7*5@R ziU?^BGy>@szGJ<1wwBH-`s;PH)LuJ9*=A9F@J0-H@wq&v?duB--z)?QzK|CR}8-^CG+wJ!=yz# zh{5^sv_pRuUYXcNZsrHO$e}l9EAb@u_favHIf=65YnjYo0xzL$I7MXG0x590*yLvGyyp5x(aS>vR_)8B8wDZhfV>|gA^oxF18h-zY znH=UH@b2oaVHh>92sW8k%e%)@LrM?qzUAr`r#WqbU8>?2qVESsklSv$N?6@uXQq~A z`SN_TIBZyt7>*!xO!Ge06O3k@^8_286mxf9x5&_%{^r5~SON>p{g3Y{iG${b(rk)q zS=jEQ8y<`?9Me))HK;<)_Ir6rP?69#OW~qfM)hvN^G^Gbr#c39%<(2ZwJ3Q;FP5A0 zNRYa}eU=weg?;mhczDc5&Ky9JbECWA`h4?yBH!H>bw{Z_=K|eg9uR=AhCi)D!MP#w zEkf~YWs{89iQ4p4E+EbHWFe!?wf#+@-vdY`a@n%O%iC|i-kH(kshP(*1BZ|p&3E>E z+rL8SMV-&p`R2o0EMia73Z53kbvvhctR@CKmb~YG@ttx#j^Ktm^|a^p*;=?EZ|Vvf z|D#lLs#(49*OFj<8g=%_fQ{RrO2{{%wSjjC#B70BwmcrW-g>B-Tq#Jg#%N-@&oq#DMClUx^rI~*B!%Af2 zepd2r`GpaeDaoQ3BCF>5+n?>~IV!D(;GHYJ`$x=}o*O#|g~N{P_#*Og0;R0t1irb9 z)d2m03k!p)Py)_;SIa~){yWBjTf@&S5k|g$uc{L(SNG}3ZIEsug|g5-ox3H?f3NEk z?aba+grNwl9+|TAe9Li|+@j67iQ>y_pH$E^tfWp6t3k`jrc*)#P!z05dTy3UgjWJB z&-(EPl;V zm3fkpf&|f?{O$+opEoDJ+|?vPC-cVbp}b@33}{=o@V0Lsk*TsFnv~SrL24o&WE_+z ztq1d-Sf+;A3-u0C=tx6AvJAR))>Mhl9K^VDX`_%^}cN>o8Gy37t zl$S*8tXt6O3sq;qs~=#$Y(heE2@EVC{>?9-t<7Q7TePV`jc(ES5cVdPR#K7_Qs1uI zkNAw!VkU24$Lq0u@A&H^%jXbID=fl5ZdoI_T@kHUqSTT_^;lpxUJ(k?U?B>@K%N1S zhwFxgsei61lERE6pY&c&T#Uj$pm2@y8%hobO;%VUEo(YX9F1+cO{_fpnKFVtVW^Bn z(Re~dcfJDk+zG1#3E~nWpj`Hd{voXOoYpN439X=}+n-Y7p&Jf_mrV+P98M-)siR3L zHmZBcJ8PRn`C_$5RckuyMk1wo6n?av0CARlDLK8Mx)>cQ63@z6nKrf(YfR?8_o3!e zq@ao(OkSBIIW?+jpYR%QuDuSA9Cv$hF1t}9M$=0`#WNa7N=N!E#{#Qw`52TJg6w*P z-mQbe*2C>&AEQD-x(%YMpd{~FyEvu6wfwy{Qq+P)7@pTZfM1nw|d=^MGn^grgUZ||HHU}ErZ7xa3jO&m;a@3 zK!6?%={vsrol|wLHiD-uvD@<#cxNu=vRq>Hcy>I?vaqOL7kDN(G3x=gu-5r6zf_H% zjWCXDG-FOmf1gA+%)jVay;*92ld5v0Q>WXs;DA`$e0N~Lp2ll`JJ~6?#|NvecSy!f zgTz6PbuJbP+pnfjKPJ{!Ek&UYSKMLnKWdX(l#qkaaTai{GU64pn{0O}f~Za&8Na$$ zJHbw2F@|6$(>3v~3=!+<`*YDpa>MkL%0a6FjqhgT?%;{Mx8Fp;$lCw>fG|wgcAF_4 zDe=xQGoC5PF41GBX6d6Pl|RMvYFt5bJaKZoU5`1`bIPt`%WA3ja&pkEOF8L}@4T!n zCBmxs-dbozA5q1tL?HtGdW$%U`9{puLiK1)(VmBdLpbfS&*lmZsxxjzyjYkdyu(4$ z`QhF>-e{uXn2YUd6BMi!YuTyuo~~uP*04)OJxsElKNb#EeK&y{(#XG*{a7@x^_e-g zEOOrw5{ZBQ?K*?4Xo?7pyA+o@Kv(=b1lOg+QfJ`Jt+(Hq!+I!F1eW3{Z>wLRmF}~9 zenf`E7nu*;hh)qvIsX3IZ9!#ua(aK*BGCq#IEP|rhDmaNyfYD<&w3{;-88j8uiWyB zH*=##MOy!DxddC{eL~ppY$vpaGL1}U0>Q;ws+RMZ~ zMQJ!@pg;ZPI7(;v>ZtxX633PA1*5kdVb~~TSe$7e92r3_5yio%vFWLqGcO@;U#YR( z!7XLzpe7d`ve^?+;Jrb)IQ-glH1k-CM(q1fB4%`rkX`A0S3;`T^l$k;jUo6+9W0!v zXWBl7PYa%esEh<@Mog)g&eQ1f#=sYcD>^(!*};cc1v+n$3@@pYzrxHk&zznXsx$Ja zQ7b-t#T(@J!mtrwR+SN|P0gI=nr8%G^|zV*KIz$(MTID=bUv+=2&xe>qB+WKq{RE^ zbR>_2@u(SmRZ8_&SYa)BRT+=tZ&}){45f;Fp!@T`Cj0*(vKb-p#r(&crI~&JgazsF zD`sYw2!A@(0-*d?efU_AHNR;!kGTh?;CQ`0tnfXYjy0B3msHPleKC&5h~sE;JigLq zTzTY+S~e&?oqvCRuN;6!VrKVVN2dx86agf6rM+sT0QeMe-O#rFng4W>cb!5b3j!r}ZFn~0hx1_M*SM?ByKXe{#*0I2p*zy?3Q{*dO{rrGlsEOw_x&KzE^=p;O+Q2@5g+=dO&-PdP z|2jRJZMLI%M7xP8@K-=8LnqtUA$5w4xtlNdRnW8{^fIUO0Ydp5XVL(BjN$P@*gseo z^Hn*09XE6dKk&w%l06rHHOh7dreFaeMm(4sQ!c_}HzyeW_%wu^sn0fuZ9YncrxX&d zU2Ob|j0U&$o2HT1UPrLu>&BLNl3Sjr-w{Ii*53iDwtA=s{~8%abt2^0aYwf+McidM zR@az6T0R1S*z8LYFQ0#+=Y4S;Yv9oMlMFxGtRu8FFjqO2qck9v5YqiYUcib=Bm?b- zeXA#u@ey(2cEiB{3$X=D0|@bV(k7i#8IrzKNnOkSBxd(tuJK-Ax|YxFYgghdx3>Z* z)E^6rfAwR3@}&#OnrhAxOx6tmFD%{rII)eJbhcs<#~(iS#^lWc?j)#l19T&E0<|L% zmXwR@ojO9TSQqy7+m@CZx268PYXH@=fb}rU<81XDJ~KWf*Hn`WiFSHtcxnJaOs>_=_YY4LmAXn`$$kxB0S+k%adgN}}!=(X~AKM1#a+$O6Ij z2Es_l*v_e2l%k!ljr0M*I`Fkjwi)}1PWL%yKdwYGeH3f$qkTr#LZcXQ-_E&)7|+et z8l{VE;(ZiL|N4g#2L5^mh=y2VIuTXR<1Op4 zd(S@9uf!PymN@>IZ?UY_NePOfg0*gqa~eOBc3On5Pn5n$=|_4Sy{C5$VIR8-DUYQFvdAQ2XKu~;VG%uR|&Ai|KlufaMwt-tI zt_HND{{As_tts?)qo9};%TyL%Z6?(r4$d&V0jUGkXpLqN|FE21uo`b}A>Hr=*ZmK|8yY!xEj%Bxz%!p;1oPL!#*_09L|y*?n?Gngev$gU4G zr@)DRV8qNJE=0oScbU$ir{N7YN>!rQO%qZYE=zE9us}&pK=j9b#_4?kx2jL{Y1vub zW|1Jff{~Q_0}bZLBYv}S29x{)>v!83Ff%$otqs<}?rI{g8i%rO7Sd`VJ+&8wnIM$~ z%i7waRO70)s&xp=y@^9}%50gkFb@c9Gy{^QPvm*kjqzN~w!N{sxdz^*Q+ZP9)8_}| zpY5MJKHz1JB;j{vk5$+NROSOE0l*}<)X=(_}Ox@q>iI8CTp76unIg^RHi$1}@teg>o?K}v=ZQc;`eVAjUQw=>_ULrVx zwKAsAuk^(~YVIZJY5_pLlf1tv#)NM8McM-}$J!tNTYqf)olPDWGdfV8t@EBNEQPLJ zNm0MdW4~R*9>Ul-mDG9!-pLAB~s<)fHev-1< zllW|=))8dsFL|4&%>oEwGO{)SER>y2bS-^;RGl>1yd`x>vf@$$8?2+4k*w*md8@2f zn;SDWO!PlvF9)X{XgKBlZ16ZBM%w~raiCiCBVO6wyQNY9!jHxBMui5wS0{p|m!#e0y(GNVwfM#N52*U{ ziH!iM8j8SOxr&;+o6KasHE;5`zB{k<#9k4gP76mPL#V?`48nvoJ`WBEZU+b4;+J=` zcM7s(jBWD1=mE?y8@R(cv+VC^o5aXowyk?|a6Vnjy+J z{UaDa^Dnf2wsV{eNbbfAWh#Lc?<9^brs2iN`kO9#a`bYbDr_gUYD{@{v_OhHxT#Nj z+nr9tHUViI|Eo zh!A9v9i{|o$32BizRV0a|5fMeAsO+B_c1SXVNPJ#QT#mvI85oDt9IVTaxyI`pVxNf zxGLoVSPaek@TED|aU)#$U@`{0rbb5Ed4rVwm0luG<9fG3St)Q^2$@VlcL7Zs4@hJE z8dJyaDCV-4L(qSGR^C0wZ#Rb)aNmzwc=F-u6C?iP7W=u6n z$QlZ^ljxUKxp7-5x2+nBL{P;?>GPN6OhEw@f=`|T0#5{|RYC(2(OSJevsm_a8pkXd z-a708(bCIfM$h?NsHMH#snw?Fo~d=|kDI{IVIU`P2wL{>Al6 zWGBIYdrhGNGl$PUnuCq9{I!_kGQdxF+i*%5L1=qdx;!_96iug!Ib{&j3L!Sei+QnckqY^; z7J_FqCmL07770-}LoQlcddkqhbJ*G3&{|Lv1W9(DNuoM4e(V5ZTubpIJ^QbEcMZyj z8hNN3y`fW3y&?k-I^@AaR`%FzSQJ0)uq3CFTr%h#Enm#}{`HRb zvH9^yF2mmKH41(yRs$mov4KSur$u8@KD!8%FcC3fISuaBXso)UF#`&f`yF%xJlr3T z(giG(q36rAsO8Ohf!HlGoW)AsZclYB4i#h;PW6*qc?Lho&pG(bj4vTU_bg zhJ%!yi~?BHZFG$~15Y$U&r==qP!^^86E=8jDJ*5N*P9M$jLjZ)ch>7b4KVuQULYlE zm6~;w-LF1=8;{K5y4ATGEz3|8jj;aj4-@NZ;ll;YyU1Lc?yLpf@ia}|_q%nUjoSFl z=W-+0RJgK>Ba$%^7KuQ5s+(b^cuP0>HI%Wx?Svsk>FMvF*Z1lN#8QTSM&Ur%yIYu1 zvQhHTj-$RJytN?YlX zy8_lM{k6=(5Z#As3lmt<`LL)QtY}3T@fT_nFaA3=&>8RH{HL7EXoxMX8jvX#H3n!x@=IDWL8CIv@EmtliJi~LK zoBojp0@QLlR`Iqv`1ErzlA|=@DbB^Wma?g_;yB&o@ z3D^9}`brn!Y^BCX4jX47}|1 zSbn8gHASr>!C9Wpqwz_5uvXvv&sq%JfAa^z(N)%h^ox9*MxZd6bf1|D@A#Td?&FsE z=l|m=TokNh$EAbi!`ko{D>bViQ{lS;hOnrp6rEuQk%qI?t&y=EJpD=$7;m1gwU1JbIoMZBC~;dvCMv_r>vca){*E1JB=# zcfl1R9-hFPODAgIaMQCYMXAWryue#CDkKaO-=EL`nH(6z@I4*E5rycXRUOIE5Ot6J z`={;pYTYD{Q5^!LP^KTDGUyar3Huo_7u=nyX?sqv$))sfw@USbVt<|$u62YT( zpX)by)k^JmF|AUy0~+g}PRXrb5eZ-wGMYs#%dpn@vyCl4r2-DKQi%`WRyFMRaPGGf z@g}^LJ3Y>P(fLuUP`@%|v#+{YoQQN?4$M9bZpa8`kHAX~pkYSS$51YlPs1VRe4r@R zX!X!8ZahxvOB7Ukrer;uiyke|9rU_q3@++Cz49+e!BUl1z1-C?00trfq78FHUV*}W zAKc4HF3Do}Q5BP-b6!j;@jSvNL%jMG2r8~;&&Nc?2_Kb!uJef!6a!eCLY=7TcR<+5-77!adsu}1dAr-lic!xVoXFwKBz0Zg zBg5IGCc|r&Qx4Up3B)Qb8NeC>VAtr?Xs#*#%XlL{cXh~45#f1 zykDKvLMgXuE7tGYWq*YGCx-m3wiCZ?aO8Z5@7if(dn7vUQ#adWc!Az@sXDhQm^D0t z9J`2I6u=-NNqWnZSd%)9{CTbcuMBsKH@AuCL=CPgpE^vO_dZSQzve(KhiZLWv-Ptr zn0>dge^s}6<=W`obf-8vr{rmTyi~FqxJ;FrG7oChB9pjE%2Rlq} z6c>87jhPhf+aBv8VY)F`(pE&~21j_>@w?+jn7?*V_$D0Qs$*olZ#xwmg)n}6<~u>v zRkd+cocG+JZq{Ucnp*XO78O|7Y`8L60dkR{CgEuccck4RMb(4Vi^32B z16Pmka%){>sE6FjUsD5y>HP8LFaC||p1wv7CVbmAFi6$4bF9@!5kvzztNR0^bz%sY z+6}4W|EzA}&gEau*Nx3`)6{W|2lsAw_S*t{g_gfl(dzzb!V(9s>E8hd zD!zKorylW_+UPZU=Jkl$DyQ|w`FWxZ6W^W*14g}bEE|l;zWAo~0x~XjIp-E*U5cgNxSBsm@ zIp%Z^JZBwz5Aw4D-?!z8QqPf9q?$H9Q1rd3Vn)OEL9w1B$;^NTLh^uN*f~(zdjJJv z{gDtT@XyInppNQJ!P>kt;GK>p)@}x?-i{!KyVJ-w|{1$rGQBCJL z?~^;|u6H-Fvka>3eU9ii_L$CuTE950j0}{dxi&WYOvQ&at`*3D{2&|`=D=p4ETwT; zT2P`Nhkz_7O76tZ%QN%p%Q8O6Q5V)!04x?UiZ7ZW^c{jN<)ppEkAzM{$ldAw#^O zkVOwAh2CEv0)7jU^Sq`MI=cIY&C(=9wE{avv^7@@RmE<CI_SxZ1$0tAUexn z^yurWiwkA%vvmg^Pp-{GzKtMw&prvbS_Q9zLw0^Vx-A?%0?KjYv9Eee0k>|)VZ^(9 zok9+f0-9d$&i+!>-eWd&`Zic=URZJA)U%Oua=~|=Y-7}st^z~xk%^5)^oEw*K?F|k z@-!Z5x%hM4x`_8GQ9Ve z&c(#LKz15hy{B%=vK=&2P~0RD&r@{rA^m#Q2uZ*jsOf-&MXl3`!DCPylec%~{k9li zg`^;NFe*C*tGZCT+*lxz-F=x1m-Max9HYtCZsZr>B;MiB#vk40JKwCniGrcW3JvI% zngBPW%uKHJBoe<*L)ivkS;24n#?~kIq4VZ6bjgQ%n&W58ir$EfX%Z2oTm^>K1)u5X7SzE1jkCd=`lEqp_XDTKuAHA z?ci2ni|3&dLYbfA?R@ilUCZLvx;}QwtX?e*JQLY~kx*!V3!DSWSLa7+bzZ<-AmDTP z=8^34a`1dI(kXJWv&erm{>&bV4EzyE^r7ZGv^=tBQHzPH4+X#RfiGQ{Y}el2k`Pc< zs(CPZ(xkA+I4(UiO9y4BX`;cQvn}ZtL(jDw@7jrr-$R)srjA@Pn?Ze^jO1e%41s_- zbZuOfW63J7nG2Hl3_GN*uS)QHagi8=xbNRxeY)<@e72xG>r zS&(AX?8lkN@!vV7-NdU|=DRKN`;!(j@Fp@ptbs-Jj2(3Sd&Nc?vsFfrjVnFNH>6Xu{v!H>jRT{Ee%NT?y{_eL7y^U&ACFYEwG*_|D> z`EV(x*+W;WmB@6|00O2T{Q1%Qp8DM;o3RwOnaVa#&UN+-siFiHZvBcn*PGWe}e*Fic@@CDzc@y#HK4~bf$?($;ceP$zrgh8#88e9>S@Ri1 zpzTCpD=p*Ml~)*eHw=`JgYPwYeKLjSZittY2BrOB=PD`3>ww1!f4TL*>&I8WcaH$A zPh1!24U-7UrDkbHu|vuGEkTtN-nP{i~R>! zKeF3*;iO{oH=^k*OZzy3l%ZKd33<*r;z4iw&w_&ui>Q;VXsPObo;_cQ(0%4&)`lf$ z=wNlbxlPZ*xzWla{T>_?HUcux2fjPCYdw!{Kh%arkfq-hrqN`eS}uRY7H{Ulr!d(x zyp>8xDe0BwxxqeyV@sWyVdZ9AirqV1G~hypgH{rOFs}4+ov*~3i0pq0pA->X_X^{d zYR#=ab%%C%V|#W+@c9MVGES|J4u`5fXT-#<#)pmG#zbx4r>K`>q$; zp&}(=q-(gSKR4OQ&3QWF(p;6_ru}>(s)Z*88&I}aC#%Nx--)*QX;!B`Vz3wxE#eCbeTLpZ|DOcRHv+!sH zO;3bMFn476&rNT^Hrr?gSwhl#tm?1dmA8CLEQNf2Jb~3S*p2&$B@6Knr5d4k$rxTo zbTN`6{MmkR+IoKC!TSLu6x;ppmuk{;oMODQOy^AA88AqEkm8dF8@C5)yxS_3*;a!5 z`klFzk8Rzigl7`;Vk{V^< zT00@b_HdzUX{;n`(tKVT7x7gJvgf>!sLWLNJdDYjXTL40FqC@u6&#*r6$AH5PNCqf zdwHVH#RvJ>5;X zt4=hpVnx-;zExyaN@ix}H)KGu2PGfVdlt#MqHx$!BvB>0f3PT7hCy*%sN2gia5JG{ z{CwyB9j4zI6i~Z$JtR!=)Xp!Z&{#UKZZVWIR9fUfyG0*IJ*DF5o-kU~6@6~j68npt z5+8N&9pP~g_}T#TSd1!p+ckaGVbA0v8Z~QsYQWu)3f5DL}LtN^u*gX=b8A+P}?u*?v(JY+3%L#m$7Or*Ri9;BMt%^n!?Ipy^ak*(>^+ zQu53~YvKzyC%ymrod~Z9-N9Fm^NY*u0yf{3^4gGmX2`_QC4g2X2mgz9B4gS~|W5 zvDC*0Mb*WR&kHAJV}g&-*8c-4og{}*T>eMRAa3sit2ePcfg6zMVWegB@nZB?>W zPm6ukaNmv`T>}X7d}{8G-T&4=Xv9Q*uS%L)y%waKh~w|=X$;7@7QVBkHh!_`dEswu z!h|k4iZA#Ne&JNUnO=^;FWC9LC!7E9%b8AtBGj~ihu1@7TNw%C&ApVdB{Jt(>baaB z^t~Om_hs{{(&ARtkMf@;21j4i1`h$gVHvf%EBxTkUiOz#9oRht!GXcl@uvH73UsxcKp-JTLwH zvrI)2m)?wmj<|ah!|w~Pr}9PZJOMRA?qr}y;^){PIsU`b-M4*Wdm?}FvKTm4e;S(O zqHFYRC;hm+Coo`aKCBL93w0cp>rri3L zhlp@Yr`^%GPUB~`{`X|bS3iSXAG|yB=wRuph`$hXo3xN`Ce#JES-D>ItmC}lNm-jfCQ}!D8p>vcwBuoCC~oQ^N@^ZB1yz<3eUZ@ zenM&5jjUST7W3zvHg%Eaza$JKA{vdUKb!-;IcgwPGP(ED4v=Bt#pn_|XHXk-gG!od zsWT!Tm~+}c=A{!Fm0-(kA76aLL}k1<&A-X2yqOk-qrlsFV&`wzfSOUAX!iA8*acPA z$^^Fi{rdmT&tRmk1NW#<6*sc?v;UdE?}{vme}ENisK22W^_<7ry@M-!!E=mkz@C!= ziDtRfZ8O?x3nmdHr<@BAvY(k~=2LN~v%IBQ(1O`yx=QKt?rKa9PIz2R;B0M_BJExG zfnHq8=XBwgOO6LHDrW(mg5NrO>s5_}JFxXS17BY9#hBg*n3luxe8BCvU+!~8HPNXg z*hu!GDLL))e-bj~5wPv<4FFgHkN{i0s<9 z@>T5USG^}yb3Si@|L@}rsH{F$v8tLDP0J;CE5!Xfakf`09D|m=v2bSv_IVc(xq+PZ z-gw@4rTZT3UQYyU#<;`*6_l+IMm79ZPtbZe3k9stJP(}2AJ)5V>nDmjr1hmeG{9J} zJpcw>28K$?rmNo*rJ33QAs_|-!IAaqXTGJ2tR=fiQv<_V7gIzG0CyZYo_10(l#=)= zqW?IIlEb)Sdd&Iirshr`oW_~7ieAY{_kj##dIDL)d>}=vLk9JrY|BhUj*&^b0;$(oGoc|*Zbs`70Z(> zbJW;~ww3}E04l*wpGd;H60ct-Ir4Nh?Np8%D`=93ZNRI%S_V7`&E;b<6yV#^hMdm; zpO9Gd2fYdEmzN^$WZB?EP0##_u8N|Cn2LPI;(mVMDoE5t8xEVEnQZLX+r`KWno5XF zIT%?FfVEmq5z5wV`M=)VEE(=pc^t|kdlUDdnq@-$zc7a$$>KAR;RGqLl>;ki;efT#41~0T|VyBlOOKZUPw!V{ULNIkT{mx6PPOMhP--Sc83$n>~C6 zdH3q1rLPW#MZi+(II9C;r{}6<^?3R2b%Z-7RI?kv&GgRc?zh^=b{R`$hU`ssWP7vS zdNS@Oi~>(9uwZ|OYL2Lq4R!iRhak(gksTFN2rA!i!X@V2kVmksGDeOC!(w?(W#}1G zK2B8fKn&b@Bw9Kai-Z_(3z)j~5e&Sgo^nUekT4lB#z>I=yP`Fut=&wmyNf_mQzhw7 z*5O+ zTqF=l0HYsy3L#L6;9$0(eY2WqrK;VEo}by?@zjLqJz!*x{KHi>kA!Ook_ChbS@(C7N*{vfc<~oD?Wo zJ?79eU+qg|;g|&d9>j^ZRg;!uKcg%mnpmi@ORY!H#3B6m8{8&MhCsd_tJ304-AtJ5 z=*W1xIaXM>!BhwXlWLp)Y)^q_xbs@ z3R4r*%t)O=9?Q&DO=n+T|Ng;Pvm(ZYIRXG758N1q2oG*od-s1kVJg7)}m|FUD5fLw5VX)WU7y>m15X_>z1ZVf?-L`? z&gQ!eTx%3~o}i3d2F{e|w(no`x1mdV{yl{VS#yR*)~#Az$bQncuFbu``!>S8;V zrxm_HHWxv6(K$4jLfv@v6M0F|Z;tiT@aOR&+EuLN2rs>syU_c<&xQbZu?42@ z3{4O$1@0K&Jup!vBp$|a>&qcbA0t6xPMCZarA!+>#UefN6w^=&Y9ryi0#L9PDuKoF zgUVp3A)ed7lEnlFh1D4Q0*eHu`D+F2cqFLV#xHk(akpQ>I3cAG7%^FB>p_ob{~IX8 z6st3E8w7%nLhLn;pR6&cb8{F|08YTq+W^OxZhz%!L|wA~!x|7;@0taqc!*5n46_`M zZgVtgZZMa^_Az!Y1Y>z*=PwNH+(lxF>A?i3>z*J3hU!H3y`~aWBz^;`Y{i+yj<9Sn zXUkv9z$?L5{t2|Ys*3;{G+Sv1+>JI|0-~_W7=!8qEu*%x-|h=`2i`pdmGgci)nKM^ z)*cYjdI8YzmD6EtoWrg)6~9sSz?gK%VyLv;I{o1}8BJoR)|8JC^lSXgdwe zkT3%Yq8E(|!E}97w}Sp82x(ixhD%>4VFY0Q=Y)#--~~$reov{3t@3@)H=9Hzg~H7o zGc&;!Q-oU4=Y_%igE8(S45~>~1t#!;te6m*5GkLFZBcMu?LG+d+BF#ZoUO2&{~6 zS!)mx1{2D&Mc7hJ5Ulg>Gd>DtLrwUJqbti;{IAGvvRbR*SPUkM4t^-u_*syAcxMGb z3brZwKOk`?<2oT&rr-EchDPJtK!JrVW(&CUF>W}34yDY-Ob~BNHG{eWg*$=7m&~7t zgc=)tn8S2}N8%H0X-J=CMIVFG55`3&!ZGa*omJuLaw;9Im&3F0na^n?zZ zC|Vr5e+qD#kt_p$DjN6$Cx~g>CQ2+@-}!$?xPxw1Gec%-PPen?)tCRc`(S198%nC7 zu<0^o`w)(!`jrh{HTj(g*18+HpzyC*?Myw8gy+LAAoy#79(GHuCvXz(xFLGH1TrMw+KL@-+=v Date: Mon, 14 Oct 2024 14:06:25 +0200 Subject: [PATCH 2/6] Update README.md first basic version of the read.me file. --- README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 87 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d501438..bd3e963 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,87 @@ -# vocab-registry - FAIR vocabulary registry +# FAIR vocabularies registry + +This repository contains code and documentation of the CLARIAH (1) (continued by SHHOCK.nl (2)) FAIR vocabulary registry project. Here we include all the documentation and references to the different components (sub-projects). + +# 1. About the FAIR vocabularies project + +## Introduction +The FAIR vocabularies project pursues the goal of gathering vocabularies that are relevant to researchers, developers, or curators in the humanities and social sciences who are connected to both the CLARIN (3), CLARIAH (2) and SSHOC.nl (2) communities. The results of this project convey in a "vocabulary registry", which is a one-stop reference service for vocabularies useful to these communities or created during any of their projects. + +The project aligns to other international initiatives that aim to increase the FAIR-ness (Findability, Accessibility, Reproducibility and Interoperability) of research data or cultural heritage metadata, in this case with a focus on semantic artefacts (controlled vocabularies or any other knowledge organization system, such as authority lists, taxonomies, thesauri, classification schemes, or schemas and abstract models such as ontologies. + +What distinguishes this FAIR vocabulary registry from similar international initiatives is that it aims to: +- (1) do semi-automatic curation work, which include automatic processes in the selection and processing, but also involves the community of experts in the selection and curation of the vocabularies, +- (2) serve a clear user group, which gives advantages when selecting vocabularies to include and datasets to link to; also to have a closer relation with users during the development and evaluation of the registry; +- (3) formalize the characteristics that make a vocabulary FAIR, +- (4) widen the scope to make room for vocabularies that are not only RDF-based; +- (5) it will find relations between the vocabularies and the dataset registries used by these communities to see which vocabularies were used in those datasets (to get statistics about vocabulary use), it will collect user reviews, and provide recommendations to encourage vocabulary reuse. + +## Development roadmap +The project started during the CLARIAH Plus project. It continues during SSHOC.nl (2). +Previous CLARIAH development roadmap: https://github.com/orgs/CLARIAH/projects/3 (to be updated) +Current development roadmap: (forthcoming) + +# 2. How-to guides +## Using the prototype: + +### Searching/browsing +If you want to use the registry for searching and browsing you can make use of the vocabulary registry right away in the resulting web portal for the registry, here: https://registry.vocabs.dev.clariah.nl/ (this is a development version). This registry is a search and browsing interface for the selected vocabularies. You can use the search query to find vocabularies relevant to your search per keywords in the title or descriptions. You can use the different facets to filter the results per type of vocabulary, and other characteristics. + +### Rating a vocabulary +(forthcoming) + +### Getting recommendations +(forthcoming) + +## Publishing a vocabulary +- If your vocabulary is already available on the Web, you can suggest it using the button "Register a new vocabulary". This form will be received by the curators of the project, and you will be notified when the vocabulary is made available or, if not, why. +- If your vocabulary doesn't exist on the Web (e.g., you or your institution has created a vocabulary and you don't know how to publish it): you can get advise: (forthcoming) + +## Installing and contributing to the registry's code base +- If you are interested in installing it and/or understanding the code, see the section below ("Development set Up") + +# 3. Development set up + +## 1. Intro +The vocabulary registry has different components: + +![alt text](https://github.com/CLARIAH/vocab-registry/blob/main/documentation/cac.png?raw=true) +(Source: Meijer & Windhower, 2024) + +A complete description of the architecture can be found in the paper by Meijer & Windower (2024) (see References below). This is a summary of the different components: + +- The Editor: it's built based on a CMDI (Clarin metadata infrastructure) profile, it serves the purpose to add descriptive metadata to the vocabularies + - See the code at this Github repository: (forthcoming) + - The CMDI profile can also be accessed as a FAIR vocabulary via the registry: (forthcoming; temporarily you can see the data model here: https://github.com/CLARIAH/vocab-registry/blob/ec430d55d5c76345e4f25b5726ea84600c96d522/documentation/model.plantuml) + - The editing process is done semi-automatically. + +- The Workers: see the code at this Github repository: https://github.com/CLARIAH/vocab-workers). These are python-based applications that perform each of the tasks that build the registry, i.e.,: downloading/caching the vocabulary, summarizing, storing in a SPARQL store, converting to RDF, uploading to Skosmos (if it is a SKOS vocabulary), documenting, or finding if the vocabulary is also registered in other vocabulary registries. + +- The interface (see the code at this Github repository: https://github.com/CLARIAH/vocab-registry). There are two components: + - a) A python layer for the API + - b) A public interface built in ReactJs' Java Script library + +- A vocabulary recommender (see the code at this Github repository: (currently in private repo)) + +- The data (vocabulary records, cache) is temporarily stored in a private Gitlab repository: https://code.huc.knaw.nl/tsd/clariah/vocab-registry-data during the development phase. In the initial phase, vocabularies were uploaded automatically from two sources: YALC and Awsome humanities (more details forthcoming). + +- The mappings for customizing the indexes in Elastic Search are available in this repository: (forthcoming) + +## 2. Set up the vocabulary workers +(forthcoming) + +## 3. Set up the vocabulary registry's API and public interfaces +(forthcoming) + + +# REFERENCES +- Meijer, K. and Windhouer, M. (2024). The CLARIAH FAIR Vocabulary Registry. CLARIN Annual Conference 2024 (forthcoming proceedings). +- Zeng, M.L. (2008). Knowledge Organization Systems (KOS). Knowledge Organization, 35, 160-182. https://doi.org/10.5771/0943-7444-2008-2-3-160 + +# CREDITS +- Ideation and project management: Menzo Windhouwer (lead software engineer at the KNAW Humanities Cluster) +- Ideation and development: Kerim Meijer (senior software engineer at the KNAW Humanities Cluster) +- Associate developer: Meindert Kroese (KNAW Humanities Cluster) +- Associate developer trainee and user researcher: Liliana Melgar (KNAW Humanities Cluster) +- Other project members: (forthcoming) +- This project is part of the CLARIAH infrastructure, it's funded by CLARIAH Plus and SSHOC.nl and gets collaboration from DANS (forthcoming) \ No newline at end of file From 036a841c55fd9562a4385c90654aaa7ac6b8be31 Mon Sep 17 00:00:00 2001 From: lilimelgar Date: Mon, 14 Oct 2024 14:08:45 +0200 Subject: [PATCH 3/6] Update README.md updated link to graphic, added a reference. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bd3e963..e203558 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This repository contains code and documentation of the CLARIAH (1) (continued by ## Introduction The FAIR vocabularies project pursues the goal of gathering vocabularies that are relevant to researchers, developers, or curators in the humanities and social sciences who are connected to both the CLARIN (3), CLARIAH (2) and SSHOC.nl (2) communities. The results of this project convey in a "vocabulary registry", which is a one-stop reference service for vocabularies useful to these communities or created during any of their projects. -The project aligns to other international initiatives that aim to increase the FAIR-ness (Findability, Accessibility, Reproducibility and Interoperability) of research data or cultural heritage metadata, in this case with a focus on semantic artefacts (controlled vocabularies or any other knowledge organization system, such as authority lists, taxonomies, thesauri, classification schemes, or schemas and abstract models such as ontologies. +The project aligns to other international initiatives that aim to increase the FAIR-ness (Findability, Accessibility, Reproducibility and Interoperability) of research data or cultural heritage metadata, in this case with a focus on semantic artefacts (controlled vocabularies or any other knowledge organization system, such as authority lists, taxonomies, thesauri, classification schemes, or schemas and abstract models such as ontologies (see for example Zeng, 2008). What distinguishes this FAIR vocabulary registry from similar international initiatives is that it aims to: - (1) do semi-automatic curation work, which include automatic processes in the selection and processing, but also involves the community of experts in the selection and curation of the vocabularies, @@ -45,17 +45,17 @@ If you want to use the registry for searching and browsing you can make use of t ## 1. Intro The vocabulary registry has different components: -![alt text](https://github.com/CLARIAH/vocab-registry/blob/main/documentation/cac.png?raw=true) +![FAIR vocabulary registry architecture](https://github.com/CLARIAH/vocab-registry/blob/6-update-readme-file/documentation/cac.png?raw=true) (Source: Meijer & Windhower, 2024) -A complete description of the architecture can be found in the paper by Meijer & Windower (2024) (see References below). This is a summary of the different components: +A complete description of the architecture can be found in the paper by Meijer & Windower (2024). This is a summary of the different components: - The Editor: it's built based on a CMDI (Clarin metadata infrastructure) profile, it serves the purpose to add descriptive metadata to the vocabularies - See the code at this Github repository: (forthcoming) - The CMDI profile can also be accessed as a FAIR vocabulary via the registry: (forthcoming; temporarily you can see the data model here: https://github.com/CLARIAH/vocab-registry/blob/ec430d55d5c76345e4f25b5726ea84600c96d522/documentation/model.plantuml) - The editing process is done semi-automatically. -- The Workers: see the code at this Github repository: https://github.com/CLARIAH/vocab-workers). These are python-based applications that perform each of the tasks that build the registry, i.e.,: downloading/caching the vocabulary, summarizing, storing in a SPARQL store, converting to RDF, uploading to Skosmos (if it is a SKOS vocabulary), documenting, or finding if the vocabulary is also registered in other vocabulary registries. +- The Workers: see the code at this Github repository: https://github.com/CLARIAH/vocab-workers). These are python-based applications that perform each of the tasks that build the registry, i.e.,: downloading/caching the vocabulary, summarizing, storing in a SPARQL store, converting to RDF, uploading to SKOSMOS (if it is a SKOS vocabulary), documenting, or finding if the vocabulary is also registered in other vocabulary registries. - The interface (see the code at this Github repository: https://github.com/CLARIAH/vocab-registry). There are two components: - a) A python layer for the API From 9dabb43df520d196a16468c4ddc049ede700164f Mon Sep 17 00:00:00 2001 From: lilimelgar Date: Mon, 14 Oct 2024 14:16:03 +0200 Subject: [PATCH 4/6] Update README.md added footnotes --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e203558..f05cd6a 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,11 @@ A complete description of the architecture can be found in the paper by Meijer & - Meijer, K. and Windhouer, M. (2024). The CLARIAH FAIR Vocabulary Registry. CLARIN Annual Conference 2024 (forthcoming proceedings). - Zeng, M.L. (2008). Knowledge Organization Systems (KOS). Knowledge Organization, 35, 160-182. https://doi.org/10.5771/0943-7444-2008-2-3-160 +# FOOTNOTES +(1) CLARIAH: Common Lab Research Infrastructure for the Arts and Humanities (https://www.clariah.nl/) +(2) CLARIN: Common Language Resources and Technology Infrastructure (https://www.clarin.eu/) +(3) SSHOC.nl: Digital Infrastructure for Social Sciences and Humanities (https://sshoc.nl/) + # CREDITS - Ideation and project management: Menzo Windhouwer (lead software engineer at the KNAW Humanities Cluster) - Ideation and development: Kerim Meijer (senior software engineer at the KNAW Humanities Cluster) From ba9c6dc5a24644081c97ae9ef1049c0a72259a2f Mon Sep 17 00:00:00 2001 From: lilimelgar Date: Mon, 14 Oct 2024 14:17:17 +0200 Subject: [PATCH 5/6] Update README.md small edit numbered to unnumbered list --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f05cd6a..5efc1d8 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,11 @@ The FAIR vocabularies project pursues the goal of gathering vocabularies that ar The project aligns to other international initiatives that aim to increase the FAIR-ness (Findability, Accessibility, Reproducibility and Interoperability) of research data or cultural heritage metadata, in this case with a focus on semantic artefacts (controlled vocabularies or any other knowledge organization system, such as authority lists, taxonomies, thesauri, classification schemes, or schemas and abstract models such as ontologies (see for example Zeng, 2008). What distinguishes this FAIR vocabulary registry from similar international initiatives is that it aims to: -- (1) do semi-automatic curation work, which include automatic processes in the selection and processing, but also involves the community of experts in the selection and curation of the vocabularies, -- (2) serve a clear user group, which gives advantages when selecting vocabularies to include and datasets to link to; also to have a closer relation with users during the development and evaluation of the registry; -- (3) formalize the characteristics that make a vocabulary FAIR, -- (4) widen the scope to make room for vocabularies that are not only RDF-based; -- (5) it will find relations between the vocabularies and the dataset registries used by these communities to see which vocabularies were used in those datasets (to get statistics about vocabulary use), it will collect user reviews, and provide recommendations to encourage vocabulary reuse. +- do semi-automatic curation work, which include automatic processes in the selection and processing, but also involves the community of experts in the selection and curation of the vocabularies, +- serve a clear user group, which gives advantages when selecting vocabularies to include and datasets to link to; also to have a closer relation with users during the development and evaluation of the registry; +- formalize the characteristics that make a vocabulary FAIR, +- widen the scope to make room for vocabularies that are not only RDF-based; +- it will find relations between the vocabularies and the dataset registries used by these communities to see which vocabularies were used in those datasets (to get statistics about vocabulary use), it will collect user reviews, and provide recommendations to encourage vocabulary reuse. ## Development roadmap The project started during the CLARIAH Plus project. It continues during SSHOC.nl (2). From 638efe399658b86dc4c4829ec426e60e8e85dfa0 Mon Sep 17 00:00:00 2001 From: lilimelgar Date: Mon, 14 Oct 2024 14:18:03 +0200 Subject: [PATCH 6/6] Update README.md small fix in list --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5efc1d8..2cbf3ab 100644 --- a/README.md +++ b/README.md @@ -79,9 +79,9 @@ A complete description of the architecture can be found in the paper by Meijer & - Zeng, M.L. (2008). Knowledge Organization Systems (KOS). Knowledge Organization, 35, 160-182. https://doi.org/10.5771/0943-7444-2008-2-3-160 # FOOTNOTES -(1) CLARIAH: Common Lab Research Infrastructure for the Arts and Humanities (https://www.clariah.nl/) -(2) CLARIN: Common Language Resources and Technology Infrastructure (https://www.clarin.eu/) -(3) SSHOC.nl: Digital Infrastructure for Social Sciences and Humanities (https://sshoc.nl/) +- (1) CLARIAH: Common Lab Research Infrastructure for the Arts and Humanities (https://www.clariah.nl/) +- (2) CLARIN: Common Language Resources and Technology Infrastructure (https://www.clarin.eu/) +- (3) SSHOC.nl: Digital Infrastructure for Social Sciences and Humanities (https://sshoc.nl/) # CREDITS - Ideation and project management: Menzo Windhouwer (lead software engineer at the KNAW Humanities Cluster)