From 0a79b1511a813f9e4d8ea946be39dd454665fdc2 Mon Sep 17 00:00:00 2001 From: jpampus Date: Wed, 30 Mar 2022 09:13:54 +0200 Subject: [PATCH 1/5] feat: add docsify framework --- docs/.nojekyll | 0 docs/README.md | 2 +- docs/_coverpage.md | 16 +++++ docs/_media/favicon.ico | Bin 0 -> 15406 bytes docs/_media/icon.png | Bin 0 -> 9259 bytes docs/_navbar.md | 4 ++ docs/_sidebar.md | 45 ++++++++++++ .../jacoco_github_action.md | 2 +- docs/index.html | 67 ++++++++++++++++++ docs/samples.md | 13 ++++ 10 files changed, 147 insertions(+), 2 deletions(-) create mode 100644 docs/.nojekyll create mode 100644 docs/_coverpage.md create mode 100644 docs/_media/favicon.ico create mode 100644 docs/_media/icon.png create mode 100644 docs/_navbar.md create mode 100644 docs/_sidebar.md create mode 100644 docs/index.html create mode 100644 docs/samples.md diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/README.md b/docs/README.md index bc72088367a..e392dd5f9ee 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ **Please note** -### Work in progress +### Work in progress All content reflects the current state of discussion, not final decisions. diff --git a/docs/_coverpage.md b/docs/_coverpage.md new file mode 100644 index 00000000000..9e4fd71fb6d --- /dev/null +++ b/docs/_coverpage.md @@ -0,0 +1,16 @@ +![logo](_media/icon.png) + +# Eclipse Dataspace Connector + +[comment]: <> (1.0.0) + +> A scalable cloud data connector. + +- Modular and extensible +- Asynchronous and highly available +- Secure and sovereign data transfer + +[GitHub](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector) +[Getting Started](README.md) + +![color](#f0f0f0) diff --git a/docs/_media/favicon.ico b/docs/_media/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..d0506f128e3b90cbf83d150d47a4994e8ccd6f51 GIT binary patch literal 15406 zcmeI33y>UT5rFps0epaf0-~U2a=F``nLRF?A|axQ@+zwkP!S?j5h#sl6~y9cIKbtR zd+g569tTK46=HZ3ArOL8gb*GoMPVd@C`m3M2@ew!gd}%6GkcfZ`1S0~F}vBv-0t0R zQrW7%X6Ao%_uqg2-Tim}8w%Bg_6i+%V2EdJ=)%22p<_a!P;G7YJA6)Rnc`@=xh-l~-wHb3 z>sNc1v!9mC%&Sd(Akzu>b84hxL&w(rLm{U|)vc>1wL70FJJ@k*BFVmELosK9k}!V^ z-CLBTeObMp39E*AcDeCt()ww%ZQDT+-TE@`8`Y$_MAPjP!$xmZOIR~XjTe5YdisX^ zK2gC? zTQ90f`;~C(j?enX_}`)LZ2H~nuakGi9{_DDS&O$=$LsRjz3=ARoli=isF8_!b>5Tl zCqw&UEom?E>Iyw0dir#5td{jF)E=Zx(KA1Uj&9~ZH{9wB&9^T0-vjC{>fSd9jHZ-x zAZz(E_;&|u(5@KP`3)U*Ly)m!-AD9HEoBBp^wY=XCwoTG)ANz*&T<8r`N?R^8#y|c zvXkNzExNU;k^MOu_ys0*-~{+^A@ckXH1zxFKt5lPeK%UT^Wln3g4Zu;M&=APWll#= zWBJDRhfTXlP4!P7TdW^qYeWyQ27jQY=EK?%d|T-3<%d=qTfd*^{^mI=CQ5xIX&wvy zb&Am+*cb4_EBek_YI^U9VlTWt?7MFuW9vocRKt1}J$Nm8@sda)qfx)W>sRd)8J-A^ zR=>WECd_Hn^$2dtUy-{uv1=|ac!V50S1n#|Jhtf;CE5EO@4H^#@i}n5g}vIQ8ulaD z#XI@lsKlIoq>r>SW{KConx~d9&%ib>_QL?@FW~QL=DY^JuL1Xi;r8CFU5!1?b=)lLA7qSXShvX- zcz;C$eh{>zSevUNsr2DN#^?6|_ab=zSblw>@2nqWEt59!4_KQA;9b@>;9JAP3&htg zG`3)!>^FRK{Kj~}_Pk2u;5=-=qh2-s+LcPe`i=OAz}ZL{i0XES*Iw?~m~akd9S5L$ zUa`LL=Q#NLl&m*ApT+w_wJ~Qu=|8p0IRtucg|264dq8CND8u|>FgMPa{deZ9Se6k{cjMimOMlW0p|1T52+&g;- z?={1`Tr=!6_#J53r6$s+=8q5d&ABXTy$+ndp#ICC-rtJs-@rJ}7kSNHk6=i1dZAwv zG7m~iPD7CoIZx7e3*{YIH^!UD#z14L@8}{!N>+1LP=F=#*y6W6r3R^Sb2@mt86$gN zXmJ$7zO>YsQf-XCS70DxcL&uUbzR;2%DO|xO^khBY-1@LrP@Sy0%H?p0DE8YJWAmx z*A^x&0e;!*yLh%#Do^F`lxi0n$QsDL7GLK{*0iov|Iuih(q>Nr|5A$RC5z{RNWwm$ zIkvlxFTO}5o<6$%#^5?P7|pI;mR2O~**V6S*LMbPDwUg*AB$o8G1v=B1M3_br*!cpS= za>jkGei-NGv81mYF2&e>a8%+Cx_x1}zT>f7VypPIU93TO&@=F8&O>soh2YO1?jXLt zX7rwv&8cR4DedN$(5v_0r@z4*T7#Y+3*o4yu9@7f+F{MC>*^u%?fYSa8#;D0z~e`u zFC)4io4S%1&PDk0H%jbEH8N+rxyPjauZE8F7ks0~8x~ z_w+om0&@{{7fXC9l5!50IFuVN(yg_`sk52KGR4TKLqjB&L9SZXDl)&aIQ9^%fG=vY_bBLC4?V=JbAR=^L+&Hp3h$qW zry@VEQC_Cp%Uy_bl(_Txq1Y=jCpmlQe^c`AL-n~JNAzokoBxp5yA56Dk!67wi4)5@ ziM+EH)+>}iPyO=^Fi zyEfIu#|xkh$v%Z=_ah6v;s;lXgLOL&`RisMoF={x?+dh!o(M6XIKIRx)^-IrT1wql zDM(+LN{RUc_f5*CXv&;crhDOL_N(MUxzqA{Z~o*`G|mL%L989X&e{q$Zf3rrcG@S) zIl3^g;nha;%<1sv18}UX)Mu1D7H3=0yI1WU`C$xWK1~o*iIL@3B7DG{uH< z|H}_~@LlXFc{^bCai)Ex(%8UYPI?2da$??U!afx`<*dJy=Uwngd=6P_Sr7J`tyiO; zWN)$OItSrBFTP`eS>{$DD^rYZ64PyA&bMIGh+|r}LCaj8Py6$p!Vm6M%%`u={2$6D z<{@@(8EY~(-_GPBD*uIyehS|F4!FXP=fsAU9Oc@j{u9Bya&U}I?&%>V(f4(&(>aW@ zF84s}ll(AbK1U_(db!6Y_xL1MTNaNWK#6zBmqEYeT*-TxFN3S(y%)K!MPIR9#M12@ z(Nv~`XA0eOmdF9`zZBj!5#MT_<4hEtS^|C5O>XXr`*kk;hP_(yr^SHETEXil=u3_X zJ4gN#d3g%jH*1MZql|Oq1wF|e{z*TPmDN0B!^y!G!(XUg&L+tJZ7%(~`7S=r)I$BF zj=edHe%w1XKY*?cyst%89>>m}>EDAtg?geC)~O&smqdk)xY|**8eP%mIJfyl153-bZ2$ zXQtV}7u&m&yIAc??DdM{9-7gAlEA`;5ZS`l%ZX=gQBos+meGv#SMj&r1(yTw{#@z3 z4dF>P4=XgA@5s8M6BYw^a2@P^>e~Eg93LMmes%XH`Bs;H&Qpc%`vwK>-lZ|PODDV_ zZkW|=uFdl1u)LIx2#P1apO&&N0H+(f1m{Z)SI8ah%6@X!7g>}!WL%iKYrDMtyh-kD zR|dKGDDiDsbMX&lukFJ3ZSn5L6(3ck#XY;rIoX;=Sq?uW|LgLGJ<%_BFN=(m^V{3;Lho*L;1ehv?i?0j(>y=GMn^4?z1W!OIdr!%Wh&%< z3jVV}neHRdoQ+|k@8&@FM&>c#7V(n|`&G#gse0envhj+-aRv7-X-6i44m~fb_cf2U zKV5jzPEEMYszsg>=x^c(fUCbFXNs2j8+?Mt@P=l?moHKBH!a74mRg<-dYabau@e{axiB$G4JuXUqlY%>@&5s=MahS3xDM~ cm0W?G={_1cDJ(sEYWHwp4+r*epc)SR4{6aqng9R* literal 0 HcmV?d00001 diff --git a/docs/_media/icon.png b/docs/_media/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..2335a09122ceff35fa70d415ee04472d539545fc GIT binary patch literal 9259 zcmb7~Wl&u|u)uNGi~B87+@V16Kkmidp}6$o4wvHY?(Xj1;!bgg;_hzm_I-aJUS@JK zb8^lkncZymx0|qUic;t(#3)cuQ0Ow!;wq4K7*dCj5Fk%I3{p8LDCnP7Vq)K9#KeG( zAcyZ(w&qY!ba6g$g3`Z5NCym6izFDpu2@I0d0(}$@O~sR;P?G!#n^ak1Ue$%vXWNO zBZXfC2U0|+BNABXlj*^WUc&ZIOvubg$i5n?SYq$={Se+*_gd?M{rNqq?E4g4u61&p zV*h}iuR2;MWvD0|R)CU8arQXV_ieuJ^X;7z{YVRsoEN8CM)(A1p*Z*GqhN_nQGo`l zqs)h}-<3@C{RjO!2>P*)aVPa-4w-Tor~;g}X0tc_#wK-h10aHi`aFOVjuf7Hf%m6_ z`d=Oq4LVf~_kvHTV(@k}zg^O?scU~yt6+U9h(;-|#VSyz8W2yv-ywg;9?GFik*`J} zn{ke7(gG71uidq@C8GJaG%izg^3Ae4-_sG9rAS(b-)ruzI)&p{gXjrXXXwBiCV5S5qLZg_-%9LaDNnVJ%b!JebES7065$~ zu}C_jIL(5C^P$sEUT5VrVVrAZ{LN=8Mlt)KZOZBVZQW_I>md^s|NmQXkWD1mT&Lkx ztvfnkSIxzFoJh;Kh#Ja}lJcWF?umB}Wu=N#gSdsb8C9b_YC!5Q9e+aW0F7{ImyfmP z`^ENO1yz66Vy`PW7W*qgHzUGOdD|kmV?Od6jseHiJS66{0jaaktc)&lu~%i-#6Q|A zij`CizYD8d7)~p}cG&J>ynRa=$ejWTY|EZCsPxbodkq21Q$tCSNfB(> zCk@z<1qz1WqEk0J?yeSXYqY_*xQsO@O4pi)?7f=)fl!-po^P(=zRXr#>scf(A!iD5 zv7Kp3BP-LN=q%_+;nn1Cm0iJSp31baNc zWPj?C-o4F5G3kHzS_ha(J9CG)Iw#(!J>q}sxOzkIP?$Cc)_^_4=C$d|8P%PW3c8bs zevjH0*g%cK=qMMfz;6+%Ca9E*hu9ZWu2RWME<>~P=T4eUkBCe_oe^WV(Nclb)%8zM zU2(O*x1tC0eRiZddQ6T8TboF;4~PucT!#tK)8#}5>TU`rJ*Z7ndEwLroUYs^LPw=( zMZ>fKf-musgaY6%%V*Hq}J8=L8&$g&w#o#2bvy&_mJ&>ZOT6{N)ex~yRT{I zK|ZS{!cg9h=zSMV2!wG9J1i<{e^$SSn~@}~`QlAnt_ib>TbjlL|5Wv3d_6$@N@B-{ zK(7W4I^a7LYXD=k>tD5+WYi6dwcJ(( z`0M;zN5?zgK3ha?s0s4CN7G2xSw%g~iVd>6L2U~NEr_*o?##l^yIc{-iAIM#&APcR z+TIs)3B@(T(FZRp#hJ-HlB#E6wt9Hl(pt*3cmAd2K49_KWO2~~%gck9QdKgfpB(UZ z4+R7{ibkV~BPrB!D7+RisN`aiQ7?|mI?AWqDA<@;%>rMt#DfAl4`LnswuyNlgNqZp(s z)7h^7%KWhhJ3-7{j)T-}#F(8_zSRe-=JT!K)-?7;x85}DdfSf-wu$^l`O5xRE5vPH z%$RRCRo8hhx;ek|=@gjs*^2Oo+B|+kVshT^O z!{dPls*gxpBvcKb?v6*FoB3@ub#aRls(HrCZ@(ri#$4VDKWh%LHm~dX`&yxCQ1jfK zRi=%*mY(KPuJWbI*i-xF(F_mHk!OuW1Y}9&e%+8wJD-JVR$DIh=@B2Ka8>(NE{|9Y zr7DmrKlmu(`L2qa44n)li6UK;-_++UHil~{R=;IzLLbvu`jj1^(R);l5;V8nfbs(6 ziVPMyJ^C7yCXb>p%*2`L&{ew??2X?j{wnfL_v6w7-UMJu?3D%pmi2m&AlQ zp_8~McS0!5up~RQ8Vhm2sK@-7mf+@}Z7S-0rA=*b&n99)U#d)oXNO$-qt!Xcc3gXa zYA~F9Wdmh%b)ReN+?u&rVfe`na8*R}8hqA#^~q0mPcCLWE01~>UPjclfuGwG2}ly0cqxgB3!o8$Sg$8$!QO`O8? zTHTXqq@m*~w;hctNF6%L>V1#=WV3(<6Nm(HRq`2(8+bFUZFhFG?(6$LHJ@Lhrc+N^ zvE1{u%=zu*nbi6ChLVPH6_@9W6r;t*#)tXgV zUG)RPNe}gKolVRKZ94d++>v5yzhraQ;h$M&7DeHMWl8-j_2i7v;*3!K`k?#0Qh#l$ z3)%(IQ!+R2tOm+J&YeK~9Gc;VrzVXeX^@mFSi10y(_aLm3sjTY);gwQnkDeQ-ZL+& z3Iz1v8SSZW%cRc;bA)T%_ zQa#KxiIEPr527IDx39iRk=8rV<`u6Lb5OSR+7btnljR^-N2W{E7NK`6k$QUGiQcK3 zO?{BQi~gyEERv~YZ1l_;sE)5ejmSH3IbG?aMvhK1J-r+ z!U4s*^TUIzf?N!d=x97%2Zy(U;P>|sWkHpn4Z^bB^n%`GxGY=ww$P{L!^TLwgIf|} zV>lBa;Z%OuxW^q2$2oOw-%*`E9^LY|NmftUw2?dG$*2a}`qpqn{1oDx{JV}WFIrC& z>-2572x|_6$j$I?_`{}Q`_q&VMbi?Jh7mNURO?Q9;DhPbP+xrhkN(-iR1!#G8Fp-yI<9yL;N!|$Y5alKOWPEXq%IFR>B~5zh=YwL|sY1i; zGk(vTrq@kXIds6&nQ@$Q3hKYrZm`+(^RMGE+|;koJ4gp+AARYU{d)c#O@YbcX4~*M z(n`e)Tg`it$G^|@O0xijns2CT%yQX-BG&+Gr}b!?KTD!aQ(2w7WkF;NUk!apes};` zdsHItU@TCF)7y^op3iXoM%NH~hA&W0CGgOybleF|SG8EUGP3`Bd$pp(*o_3=kyZT80vO%a2!5ycD);$`9Xu&-G$l zs{i5OpCL^@NcPek;k!~a^3`-6B(vN{MU#m&v$)Ra8ip>vd3CwE&-Qz3 zKJbe`J_tnHWFU8&3A7hm4Gh)GKC$b4=(2aS%BSz75HWxI^8t5kYN*nPq4nWD8mo=o zbmh+xv@teS(}p*~cvj1T0Y-ah9cV?Xap7O7j*T0i{B<5Glx>OeE^_g;j~1*U`FAlC zL_Hms6vsJ!hqQ&J?X=272?8N(D(m`>XiWnc%SVoKiW@TNS2(cM$;k z_8vF@#WvMF!35J)`Y$Q7w~PgX$iwZyl0fp4OPyaKbnV8qY3wP9vRJAzka5XH)rb~} zSarORm(+aP9j`KuDcVI6zNxJT}DSskrAiM59p45g!NHY>z zq7s~_##B^K!A;3UiX%r0D(E)U4Cdgo&3~&lrU&$}^SX%~f?4P(!yoE1Gxs52#qVxe zTQ?h_XTWZb96EI?v7mx$!$r-z=s8wdEikV5@%N|NdwPjc+Hkgi>}9vRB(C5dotu)N z3;u%Xh!=fhUH)Z$FspkhgL)-&$GE#YU`^a%)D5Zf3j$+2H)-|o3=C%{4@Bfs>IHOL zNWk!t3K_1Dul_CYE9xEw(*x^;_ylA2uS-@~W>1a+vdRpf<3$<*o9qlg@3)ANrqzhS zFls$wYIqAt5at+80~{kM6IDg?`EHdGg(EKgdsaRm>saJ+t)fL|J8 zm>0!spm1nsbmB6FOU!U$I#J-$Qf>K2t=vWQCA@hODyH<98M@@Y`|AAnu+|sI&gkmH z8e$M{9H@#}O!+e^PXLHtW8^+~Dx9ZzEv11=C7{UYZ0cVwSQ z=r399F1djxb#wjI{HrAbQ!jiuA`UFs`Q>1Mm;`mVS|aM=ecX>$1#wR$z(-XmTF7Q>#yxx0$0|H6C98bHZ+a zn>OAjjcp;@cJ$NN?Vypq$ctf#`&1=BF9RMv4NBvln4NTX%s#2fQ6o&Un#Yj?X{swD}|8`DmcNtp3ZGY5YFI>A$Jt$w5grevyM zUX^C85j2Bfd-nN`JrfJVnx;?YG~8{EYO%nFuo7Kkcw<5|rxi?tr0Im7X52xr#V)9_ofTV;L$tT($H{={D z76BfIv1e2VhaSIlAy)IAvacL?YK90^V+c=?JJ8b^xT-}Hon=p?YPFia!7QJWJwI=K zu1J$WrrJqJd5)Kqq`_e&7SQ!+w1)$|{^6darKRK>gcq%cb0jA;!B}@HKP2TA8{kxP z(+qKAG-u8qh4o=l8sg(Fu~=iP5Kv}(fZEhM7&VJoK3Jsw8D!;BtS-5Nujt$sg9?7+ zZ}Cq2B#TB!XT>Qu-F>$mm05G+N}++G38Cw+2_K6Ig791VKX%#huC;LwawPW%c>oz* z@5iY$!m`ZE0LxHen$d_Zt%f#D1J|os@95)8y{$394{tH?2bYr- za%5-Q8JI{0%$i@aL45XYJXPg+RizBrF;pD}=cKna^~R*GGG9+_6Dk#p@)(I<=Zqd) zCUWkr#Ql~`-@WP5#y{Enyf!r@sJ0wl^)^ts7r6yQBq%OVCdFx~vhVN4UtLp{hZ3N7 zqjBWcZ1c+BEDo&5B>}aGg0gd!67##WS!y2DCfejSD7LbDpuO%=t)*&u5bMv|4>tk| zwSC%94%prGq)}$1{5M<4Y_Klw?XZsJF-t zJdj8ow%W%`j3t;m#7&s4Qb>@ai~kMz_V+Lhsa-p@-h$%TWGiq^xm=|eoX2cjF(<=kN4C%x*pr znbgY!xn+8CNN<{Cj8@-P>Y1-6jDr~KC_hP?7v5>Bzq4)eTV&QOSDz3)HV}MYdv4}b ze(M7k)Bn9`)6f~n7lq29N@4rr@Sgn~9}T^A5K zt@rH9)~)Vj5RfVGLL3|vh!UjA_oC`tiNWV%#YShT{VjxeCa_`1HbdHubU0g9Wb1eLdZhd0otE|Oz%=yyr!g(ID_}`yhS;%OwBo2F^JYZ}>k>B^l}XG4Zz#^pX_@dvWdJ9S&%?glS zl?k$3v_bLF45CmS&ZRuW+QwG*q0=|`Vd!U3CP~wA5;&htiwT``_C~87U1J-%Zc5MA zhYT}4FYv|*_6YB8n&0lRD-RcOvm={;Q1VMP6 z$#8SK_%$Su<>anJhkk6l0hbO2y?#IIr{W`q3NvwSggTyyZY(c)!cs( zTVCl$hBpn^ca%46nZ)cXDg0MmFsF}Xw)yXJ&112LMvKPJtq9QnFcd)%rrqnUOdeem zw|qU)tb11JDg(Wd@bU+)l6Z~S?n!AT<)OeB95T!|bqX(oAi0+rR@%?|N{qwZ((3vzpnzdE7W4{PvT~jPgYV)(j;iko zYtKsyLe9nI3xPr_1wVo#YBOY5#}_vwT7;cwrkl2*ViSg}WmW)%P)N@G=`Vu8e|d#x zNWSA0PD%g)9Wq9bL|=cdOSG*pDs`tt1{VAf z<)he~!BKR4Ku|@Mm$e?sOGc6S56h|_j-xCgU}I#inC5H30bcp~PgPfhE|4lZEO&Tz zjH!WwxL8ZIRa(0pWcJsi(yzoVLSOWgc5st1Ca|AGH+C&rD{5epeVFmWe*&REeT)@k zNjv`028a4upe1hxhI%AfF~FCKKG|zr*y*IFM0fFiD$(@<6F{+5+&O=V)A+zwCDN@i#w0pO z#Bj3Hqp=M(pxW~M7yQQW@6708OZaoXEJm|Nj!=$eufP@L+w7`Z+ibjyl5qYmFm0hE zl_c}@j8NoomE}KE#Y7e!3)GJ9--nGl$O!pWS23yGi!?D?ezY|5s-`_A&=#sO|=$v zQZ+dT;YzT%XqmNThf=K5wdp2I&_b+KsTad+Vl4c)J} ze4-210Bk{8eq~Aq&(#%CO{@~ZKd!Kpn^Utpu3z$%YG|5BwA;t4s+VwDc>_H-{2Z!$ zl7A&w>02F5*YN3N9$KSh(^2vy2xdOiM8+PFu)7o%8zj*;Ghc96H&wo^o8>G^!dFfAV zdx{<$cwEZ_FyY*)!#YrQhRyhu9SSp4z}D&ga_vY54@C_BGAP)BkiscIE(Ac0PXEDW$qwaWjf9-D*mIv&-(k6T}5CTCgB?zw4nrx?tC#QEC#XfI*UCG=+O z_nr(vH~{x`b+1&%{wU)4ZkaBDN`(%E85oEawt38ZT2$*tN&Kw*Y4sZ7Oz4+oE#vSe zkuR&>D)VHm3^G4_VK2{7iAzv!LwY1SOt@XYtiZY@H4H8avvmIuIxTaFUh*ehroVPe zCe;YMO_#x>yRqKv!J^(;7+}F8;x)GrnqDW(jKii4KXwdkj})2f(P1UB#gl{Z{^Hxh z*lgr+omqlsjUoP5n$b9WvD59C@rvo+T_^b!R4-}^P0aObwQxr^2ok@I1ARx&mj2>f zc~j~i-nVB2a&io}^=cxpWvIYlnyFQnT3hO7;v5mkUwN&+M_{)(SDEM5#y8?rcjn$z znW;LaV~5=x-)I2=sJg^jU^IbRTG0)LneWJ+W}tbUkz#xfU6GDoaYF zk+!nN5*5v+SgKy27|C4V)=)_X7InT})>Ip_6Dbvq@Q6f%_mmUrEvl2y_;nFdEPkOniW#VabG)AQ|BuUl4H z7px_3>E2yW^merH|jO17pe#Sz*ZPHkYZcASuZy zYzK_23O0&TI!9I3Fym@|+I#<`cADXzkO2Ro7PfCkTt?Tt%N^T9KQ`K@SFq7yP7!3ow?A?cqw$e<5+iLhnhb062HJYL1$1TilWC;$Y~3UP zGt+XE)P%_?k{TWRp04K4MHdxrItz-R%|1_i?=F9~ie&R#DnuEi{s> z#h=ahMQsGe7XUVq4cFOquVMI_N|puI#t^)lGCq9yGUl<%p+7)GfBO_BM&Y8=o@oGe zj8I4l=tAXDT*ik-FT)Z=zcOloFS#--iS|~Nq_!XE)?UH$aXd&DY|T9k_d7kgY}LA% z+>`!f8mB8AZ&4d(EdOFH?MffT)`X@nEv$IDY@xqiE99SdUT99V)$#{wOOR)8Q-MXV zvz$<9P!cy9a30dxFv_~BBU4G6FmYI~Qu}`t!p%oNlRXyCt7wCWe|Jn|BoxJ~|1$#r E4}qh literal 0 HcmV?d00001 diff --git a/docs/_navbar.md b/docs/_navbar.md new file mode 100644 index 00000000000..0808e1ed7da --- /dev/null +++ b/docs/_navbar.md @@ -0,0 +1,4 @@ +* [Community E-Mail](https://accounts.eclipse.org/mailing-list/dataspaceconnector-community) +* [Developer E-Mail](https://accounts.eclipse.org/mailing-list/dataspaceconnector-dev) +* [Website](https://projects.eclipse.org/projects/technology.dataspaceconnector) +* [YouTube](https://www.youtube.com/channel/UCYmjEHtMSzycheBB4AeITHg) diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 00000000000..616bae1b342 --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,45 @@ +[comment]: <> (Each folder in the /docs directory contains files for a section. The README.md is the +landing page of this section. Other subsections are placed below and can be linked separately. Feel +free to add sections and subsections to this sidebar.) + +- [Home](README.md) +- [Hands-on](samples.md) + +- Architecture + - [Overview](architecture/README.md) + - [Configuration](architecture/configuration.md) + - [Contracts](architecture/contracts.md) + - [Data Flow](diagrams/data-flow/README.md) + - [Policies](Policies.md) + - [Principles](architecture-principles.md) + - [Terminology](Terminology.md) + +- IDS + - [Overview](ids/README.md) + - [Architectural Alignment](ids/architectural-alignment.md) + - [Key Components](ids/key-components.md) + +- Developer + - [Command Queue](command-queue.md) + - [Dependency Resolution](developer/dependency_resolution.md) + - [DPF Selector](developer/dpf_selector.md) + - [Metrics](metrics.md) + - [Release Approach](developer/releases.md) + - [Writing Tests](testing.md) + +- Decision Records + - [2022-02-03 Integration Testing](developer/decision-records/2022-02-03-integration-testing/README.md) + - [2022-02-07 Micrometer Metrics](developer/decision-records/2022-02-07-micrometer-metrics/README.md) + - [2022-02-07 Tracing](developer/decision-records/2022-02-07-tracing/README.md) + - [2022-02-10 Code Coverage](developer/decision-records/2022-02-10-code-coverage/README.md) + - [Jacoco](developer/decision-records/2022-02-10-code-coverage/jacoco.md) + - [Jacoco with Codacy](developer/decision-records/2022-02-10-code-coverage/codacy.md) + - [Jacoco with Codecov](developer/decision-records/2022-02-10-code-coverage/codecov.md) + - [Jacoco with GitHub Actions](developer/decision-records/2022-02-10-code-coverage/jacoco_github_action.md) + - [Jacoco with Sonarqube](developer/decision-records/2022-02-10-code-coverage/sonarqube.md) + - [2022-02-11 CodeQL](developer/decision-records/2022-02-11-codeql/README.md) + - [2022-02-14 Helm Chart](developer/decision-records/2022-02-14-helm-chart/README.md) + - [2022-03-02 Performance Tests](developer/decision-records/2022-03-02-performance-tests/README.md) + - [2022-03-11 Story Issues](developer/decision-records/2022-03-11-story-issues/README.md) + - [2022-03-15 Policy Scopes](developer/decision-records/2022-03-15-policy-scopes/README.md) + - [2022-03-15 Swagger Annotations](developer/decision-records/2022-03-15-swagger-annotations/README.md) diff --git a/docs/developer/decision-records/2022-02-10-code-coverage/jacoco_github_action.md b/docs/developer/decision-records/2022-02-10-code-coverage/jacoco_github_action.md index acbe4bfa9ff..f6632512a48 100644 --- a/docs/developer/decision-records/2022-02-10-code-coverage/jacoco_github_action.md +++ b/docs/developer/decision-records/2022-02-10-code-coverage/jacoco_github_action.md @@ -19,4 +19,4 @@ Code coverage coming from JaCoCo reports can be added to a PR using [Github Acti ``` The above workflow will send a comment to the PR showing the code coverage of the files modified in the PR and the overall project code coverage. -![Code Coverage with JaCoCo and Github Action](code-coverage-jacoco-gitbhub-actions.png) \ No newline at end of file +![Code Coverage with JaCoCo and Github Action](code-coverage-jacoco-gitbhub-actions.png) diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000000..2f1e432a010 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,67 @@ + + + + + + Eclipse Dataspace Connector + + + + + + + + + +
Loading...
+ + + + + + + + + diff --git a/docs/samples.md b/docs/samples.md new file mode 100644 index 00000000000..f30455c6532 --- /dev/null +++ b/docs/samples.md @@ -0,0 +1,13 @@ +# Hands-on + +If you want to become familiar with the EDC and its functionalities, please take a look at our samples. +For each, a detailed documentation is prepared that guides you step by step and explains major topics. + +- [1 Run the Connector](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/01-basic-connector/README.md) +- [2 Write a First Extension](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/02-health-endpoint/README.md) +- [3 Apply Custom Configurations](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/03-configuration/README.md) +- [4 Perform a Contract Negotiation](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/04.0-file-transfer/README.md) +- [4.1 Implement a Simple Transfer Listener](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/04.1-file-transfer-listener/README.md) +- [4.2 Modify a Transfer Process](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/04.2-modify-transferprocess/README.md) +- [4.3 Work with Open Telemetry](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/04.3-open-telemetry/README.md) +- [5 Run a Cloud Deployment](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/05-file-transfer-cloud/README.md) From 3b55e7d85d17afde155c2183ad29c6d6a7600d5a Mon Sep 17 00:00:00 2001 From: jpampus Date: Wed, 30 Mar 2022 09:26:11 +0200 Subject: [PATCH 2/5] chore: move disclaimer in docs files --- docs/Architecture.md | 2 +- docs/README.md | 10 +--------- docs/architecture/README.md | 10 ++-------- docs/architecture/configuration.md | 12 +++--------- docs/architecture/contracts.md | 12 +++--------- docs/ids/README.md | 12 +++--------- 6 files changed, 13 insertions(+), 45 deletions(-) diff --git a/docs/Architecture.md b/docs/Architecture.md index db42a38b991..09c27c10adc 100644 --- a/docs/Architecture.md +++ b/docs/Architecture.md @@ -5,4 +5,4 @@ TBD TBD ### How write custom extension -TBD \ No newline at end of file +TBD diff --git a/docs/README.md b/docs/README.md index e392dd5f9ee..d6b983abc79 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,14 +1,6 @@ -**Please note** - -### Work in progress - -All content reflects the current state of discussion, not final decisions. - ---- - # Eclipse Dataspace Connector -TBD +**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions. ## Overview diff --git a/docs/architecture/README.md b/docs/architecture/README.md index 306dc59b54c..ceb759d2d43 100644 --- a/docs/architecture/README.md +++ b/docs/architecture/README.md @@ -1,13 +1,7 @@ -**Please note** - -### Work in progress - -All content reflects the current state of discussion, not final decisions. - ---- - # Architecture +**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions. + ## Configuration Each EDC extension may use its own configuration settings and should explain them in their corresponding README.md. diff --git a/docs/architecture/configuration.md b/docs/architecture/configuration.md index 105984a96a7..f6cf8e56434 100644 --- a/docs/architecture/configuration.md +++ b/docs/architecture/configuration.md @@ -1,13 +1,7 @@ -**Please note** - -### Work in progress - -All content reflects the current state of discussion, not final decisions. - ---- - # Configuration +**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions. + It is possible to configure the Eclipse Dataspace Connector. All configuration are retrieved by their key from an extension, that implements the Configuration Extension interface. @@ -50,4 +44,4 @@ The integration of each configuration extension may vary. Please have a look at The following extensions implement the ConfigurationExtension interface. -- [File System Configuration](../../extensions/filesystem/configuration-fs/README.md) \ No newline at end of file +- [File System Configuration](../../extensions/filesystem/configuration-fs/README.md) diff --git a/docs/architecture/contracts.md b/docs/architecture/contracts.md index 593745265b4..f09ec99003b 100644 --- a/docs/architecture/contracts.md +++ b/docs/architecture/contracts.md @@ -1,13 +1,7 @@ -**Please note** - -### Work in progress - -All content reflects the current state of discussion, not final decisions. - ---- - # Contracts +**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions. + ## Offering The EDC connector is able to provide contract offers. This feature requires four different types of extensions: @@ -41,4 +35,4 @@ The EDC connector is able to provide contract offers. This feature requires four ## Negotiation -TBD \ No newline at end of file +TBD diff --git a/docs/ids/README.md b/docs/ids/README.md index 1a29cfef1c1..d058638ead4 100644 --- a/docs/ids/README.md +++ b/docs/ids/README.md @@ -1,13 +1,7 @@ -**Please note** - -### Work in progress - -All content reflects the current state of discussion, not final decisions. - ---- - # IDS +**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions. + ## Specification ### Compliance Issues @@ -22,4 +16,4 @@ will never fulfil. The self-description is only returned on the corresponding RE #### 2. Only one Information Model version supported at a time -The EDC connector will not be able to support more than one IDS Information model per running instance. \ No newline at end of file +The EDC connector will not be able to support more than one IDS Information model per running instance. From fcd3d58dbfd6f7ed8b7c1a608f37c6c6f07d823d Mon Sep 17 00:00:00 2001 From: Julia Pampus <72392527+juliapampus@users.noreply.github.com> Date: Wed, 11 May 2022 17:00:05 +0200 Subject: [PATCH 3/5] docs: update sidebar.md --- docs/_sidebar.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 616bae1b342..1ad0fa02e58 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -10,6 +10,7 @@ free to add sections and subsections to this sidebar.) - [Configuration](architecture/configuration.md) - [Contracts](architecture/contracts.md) - [Data Flow](diagrams/data-flow/README.md) + - [Domain Model](domain-model.md) - [Policies](Policies.md) - [Principles](architecture-principles.md) - [Terminology](Terminology.md) @@ -23,6 +24,7 @@ free to add sections and subsections to this sidebar.) - [Command Queue](command-queue.md) - [Dependency Resolution](developer/dependency_resolution.md) - [DPF Selector](developer/dpf_selector.md) + - [DPF Transfer](developer/dpf_transfer.md) - [Metrics](metrics.md) - [Release Approach](developer/releases.md) - [Writing Tests](testing.md) @@ -43,3 +45,5 @@ free to add sections and subsections to this sidebar.) - [2022-03-11 Story Issues](developer/decision-records/2022-03-11-story-issues/README.md) - [2022-03-15 Policy Scopes](developer/decision-records/2022-03-15-policy-scopes/README.md) - [2022-03-15 Swagger Annotations](developer/decision-records/2022-03-15-swagger-annotations/README.md) + - [2022-03-30 CosmosDB Lease Mechanism](developer/decision-records/2022-03-30-cosmosdb-lease-mechanism/README.md) + - [2022-04-21 DPF Blob Data Transfer](developer/decision-records/2022-04-21-dpf-blob-data-transfer/README.md) From 0cc03b37508cdfc522b9e1af652e64409f9779ce Mon Sep 17 00:00:00 2001 From: Julia Pampus <72392527+juliapampus@users.noreply.github.com> Date: Wed, 11 May 2022 17:15:12 +0200 Subject: [PATCH 4/5] docs: add docsify-updated plugin --- docs/index.html | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/index.html b/docs/index.html index 2f1e432a010..11667cbd71c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,8 +7,7 @@ - +