8yvNp$tSW_6fM9G#jrIZ~?=c9R2zprHk=@(`e@i)_9hd%OOmkdkayDokC zP}$!nx2>==pc#lj8}zTO wJ&%HhQPV z@iE4^qQ!Z2WO)tgv=J9d-#45p6ne%o4QZ(nHK#A1z4}FT*oS-RFhAFu=HQF#naUs6 zTyIfi2M#yNlpamGmQ)7jUI4%ig&Z)EZc)rxovI~{Au9`s0v#lMZ%sCojEnt%MVUc- z;hEp**f$<}OJEYI1Y`@uDf}U24lVL7q1h`TvCu8+D2HZP_ku_Z7~-Z4vKbdIQM{n= z6!ff(kt%_=v_Xn9IGwl&dYn)+Ivmd4&x!7m{isu?$@BR@x(Df5kc2)+iPE_eHMR>O zA4-aavdl-kQ}D(7A)*i-rU!Q{H6 v*jb(UYo&mv7fDWv=E}&nxK1qW&ovk6AY(!^p(#civ$OuzB$d;O zJj9}hNZ-G|@eggH$UI?hc*d)}i00 3aIE5+}>aY4m@;g4OP1B*I*#`gH!*B%Tm12(jp;kkQc>f2) (onS4R)5!sazk)=54;#@e^sw(@aLvJv zXSaoTL2Ef!*Kq!+`5jBAkPY P@s2o7uSpekLeX!YYl|w)Y%x-3!^Q+kiqf^QN z(p#;h{90>jIsoqV7pk7{ydl+^k!I=lUCh2KWz=y;RK7Yo+-~LJq_2aCTkTwzxmT~G z=C2$>G}{8_!-< u4=3Why=H^Wypqso$cqomeLJJfK~+Az)BrP1?H2g<5`^m5gz>cOb{n^X @RLBCeJ0V4MJzRuQxcU#u81f>t=4+hldh$N@U z-RKMRxD2=Y^>)v8Hir}e#qV17y^ pzdp30 z(gCRY%`UU4{o&Ay5~kCTY0tHW-K%D9wf3Vv m+WUG7v6Wm74T zkjWlE_Jo(;R$GcS5HQr;L=gdzPxe{GhW+vEfvi6{*ZS4tK5U|CPs<01k`)FgSRyct zPH)n$+#U|t=bd|xwYuq6@9j4l^wqvA$SmFx0kg(E7}V*uPq#=b0CDjFx&W*0?}fRR z_xjK#mH?TWPR#m8-v4AEWx1rTWTkc?$G(+T`U*gxZPwI3CxGO>Me%hJbH6efTK?=Z zx+mWR=p(vb7v`8s;jF_pe)b19t~HoJrcPjK0O1x`2-ECCUoIZN0+jN`#DY@wO67>9 z{d72%MZ@>!TzWcDJa9>(eE3cAyX!vz3fVYle=zqY0ZEh+yht;3y46aYOC~^~S)(~* zS%}*lfFKGIwI1D6g2joU-|p9cDf>uNKLGUh+C?I|ExVW(*5$j9ZKSlB*`ESD{PXLF z^^8AmKwQ!%OPx!){RbSYXMH7fFl=4NC#$&9Zqy<9> sW59JLVoAX-Z)VGJE*2ZlHg%Fcg;RNaafE(5}-SuGQTYj)PrUQwQ@K zA4VEVRz573BtX!h*O)gEgm+1>9zx2Az6DZB2sQCvt$csgQqdvD_nz ;? zf$b9g3Y!&rIyV;;*L?M2q<^hePrV{ Z`_XO@}+4 zd()AHdG7()ODa*_^6XoTCd+ANOCzM$m)Ze=0BbLRCr?eUpS|!se Z8y032{b%WJ -$}ypsJ+dq>V~)Vcyi&3%0MnkYH9hl zB6SuE33W<^Y=GU|eQ`fDFC0q~O5z(txTCtVw3Wk)rQ@Z#OMA#LY(#zc6h`N)IE0Jf zw-4;7RwWHPV@yE2X4oqDkVyujeaF&wZUfL4)l1!klr#b&rv(p`sOO!)RcEX2pMzZa zk3bw>{O1$Z&Rhc6)iuvaln?#4ZQxs_8%hZ@zW}91wxu@ca;a~x^XFDdC|N#84+@(i zw5#^m#EPiQhH(47CQyX31qST3a$jvaK3waT95FYvT#qqIv5lAIZ}5G!`{QAgJo!s2 zAd%=CQIz9(zMtXBLqMdn1>gV1(v&f2g;cu9+A18h{@C;Ti}ZUL?6uFGYPW~Y#H)vZ z*_U;CkTG|!ZQo!g!GSqHiI|+$@FJ%BK9Rx)3b805k=h_C1Y~VVLAt2gFWxUi$*#4% zA)@4+nIp#3!_TR7XA|~E`-9T*J&R>+Jds}pgtdbK%=>vHW9Xn6Am1r|2x#BztdMqr z)6`bi@*meSe%J#5cPP1%!iptOZ3p()IlwyU(VtxtAuE4dHFmjyP}F?Q_`7uDdfaRR z4ka*5M7llv69x*^|7aSHolj=Yu`~PoLlPblZ3OR>Px|aM@{vo^(L4LyxHLiPUTLGB zZ63#$u{pjL$Z+k;vtDCvXTZ96xb{yxrE*4eDLpep6e0jYIms}}`a=>S`4G1b@&^FT zm+GLnY?4Vz1&tAT! H%XORFv;8y(vVJ+FGj3-hE5ob`7s1k35r&z<@8^3Ix(M z>p&@{BRF(Rf$3?8;(PenFKJ xI!6SIs6v$YngH6 z)5!?UM|{U;cLtf!kfbtovMVy{atqTxBQEY1uryrUOrVd~;<`Lf?oiXhW?5#h4Z4kf zOnX-xM|GD!n6H_aVB |OI@^%Dr43Q{tb5tfQjdI zDTt<9)CuTtziayi &sZ6GfBz&;8KFeG05W?nC{g C8D*g}yW$9| zcjP^I4K6PPuVwP1a``du-t8+Ntpm3XzJCf~*f?ryA*4BCoQtAozv&>|C8sTh;NO<{ z>%E?WOu99rU^>WI2`E|;3YVO|Fob%P?79&q>+-IXUnlCCY*k0n5S;57KPod{Zklrl zm40(4c-X{&mUCfJ^D89NQyXe20Zo%6ib2It_Mj^|NYXi3=x5^J>Q>&}IO=6pUXRw3 zfcDMeoLghVeOi|<(yeQo4cX@~{pg3{B&I*69F}V&Ex+;wNa9bZhbF_0#~{)2X!qo9 z$-JxN?2kN }h}%s6U?{g%0QkiHeLy zK9a6bS{L%sL4K4Z3Imf>k$jT$T%%?Dm1PmQc4CU|m0uNuy4_x|p|0&XL^nUYieI5+ zV;drxMc{JA@Cj!%U-jjtqN_BId{f%^0h~}h8{1%L-R{p67|CMFIQ>iq={2{O>VSGM z|8x#~f@l2hNmR*YP;qx$7GBZXQwT6#6kn8Blw6crlwOoslwFit;ob}A35ruR{mK~Y z{WMv|M!|`raGmEt=mGD6w474xLhw7SmF_S!hiC^)A>MnbU1hU=Od#jffxsv)2{=|8 z52Y)t>tdHSu3CB5A~si5=a53GhrZKSH#;n5gj8_dD7es_Wm)Tz`LJu&bMf^^+Oz%| zsZHtdFs(G%)oGN#8L0ZK0mhKbou|ZG!MA2--47Z7c4ueMok`sS1cMinjO z(l(x`q$Is47?PFCY&MU#rx>Uwmd^IVEjm3;1y916nTHDgN`Q!X{*ZAP6`W-Bovk0K zQT5oU? VOMJ4)%m*Kv&f`xflJ `k zO1KDHbZSwHbH79ra=9TrgPQAl+1&}`^Xc2S710D^-dj&X-%fL$b+4!$M!I>pMMc$0 zeYtU_|3ZBeXtTAIMgzyO6N=@?kLkYhzDK0AOit+}KJoiT^+}k_Z*>}Qf(xhNWzLIG zp9bj$*X{Q~IG?^-XctTo8n!H&@LY)XBy<|3s 3YlLC>=4ID+;o=Q6}g1nJ-) z3p1^pWB|0={K#U3E}+1GvH~_HA*LD~90g+Ro>FV5cBlvs#{&R=%x_gI;vs_?2)*mz zy;Q|>jwgf1$(u@d%W6|1WCajXb(UR(vyzd+naDUAYiS1TfHwzj-tOvA`X%+?*+gC| z#&4uBfDfpTL5+hrKx{o=RkD!R79AH*HR>A=`trYCK9xinCCm5dZN=y7YFe+@q%pMl zh*=PT5~4VstVI)Gu%?bexIC($B|bnamaZjQLANJWR6j!vc}uYf--ZNz=R?zwKyF4% zXh#`rO (IHjqnKL!gv5f2l7 zGTUPmtHGxs_ZJXP 0R!7hNq7(4j~LM zqgjP{sbTCh7{M6INeTL~w1vJBJe&`t0CFJ|3TGrgE_yG*rQnYbF=AXcpw7`M7PWLl zX4=ppueD_E&^tl8@KgdQq58=&E?p#D5<9pb>WR1s$s=4 CCcpiy_BEzsW7zmd@l>V~%MUK;?T6OEsRjpwNjBTX87}=S61Bd}AzqOUz z1Ej|;b>Q;tO~ Ih5ObfMP8 zskA*Q+-0!TKZrx39L~+CH$xp|?lPCIKb-CAa%Y3Dw3a|>K<;m}TCvO1WX@yp#@jTU zC|XPN0P30CqpiX%xNZD-Du)J}=xTPY<#M*+40pwf-}f`34b0;{aa?UbvygkK#P{iv zjA%Wub=A4lm KU6v{Sv2j!m>8B=~U zcfBQVzLoER2jFthb3<~_8)&*+$$1mW@{Q8m26pXS;EW?Gl5O&KlyB4{kZMH&%efp? zRFmjh5>+w%b4V!U1*E0pecPB@#el}88WE*EL%N#`b$OG(%0^4IRPRC+pfb?wNrhCU zA}Gmt%_l#%a_$D+7kGkQm;xp;a|`oP6bcz& XTWVUX z;#IA!4?x0by`%H(;e~XTYAABvcSE7l43qkx%SbGb+cam`tMEst`yocdsn8TC1@uuf zS;A#98cWSRl@+x_J}i@^0`hBOLe%Wo?Zrp3==J6hc^EC)G1r$52GuPOilz35`N_Z^ zEhAwNA{byIJRIf)E)RolYBIsJ?c9*}r(IF3D2uW)Xti8aC-l^l2k7lt$*~ys(>)%o zxwQ!Nb|@cAV3qgQfbyg+K}7+Mw0hfI7cF$GSt|-X`Cs0>470$be>?)U=^Bxv?k0 zTtCK2ZEK&+rW`8Z{BapawhTK)8xHC 7y2X$9V- FNt!s8!hz9_%@hL zRa)#9uF6%9DFqH!y;)%3k^{L7EvUi}up p_RF1Wcwy`5qBM zBWbx*P%YCoVbaXJl;IrL&-a#KdXW?wi|kOlifBY7AW^2>>^P^FmBaTZRA5W`WH^qh z^fgCV$lU4{LN &WKsuC5c8e#p^<6HKCM_ -3NB8Ib-?{W&hjg zKTS5`X#W2^(h6>5g>2&YQYg8Qc@jF}Th=Db`iLc~ Hk1?Q5r9TO2<>*LtBe zpX2|77(EgL0s=4p;r1)wW))wmZQ!DdlKjnfDjNfkO0ThALD1QFAi$6b`+T@NW%UEl zm3smKl5`-b@O}cgx8!HdLXLme*7reb07%O*s#8Z0qcK=
+6*U2*Y>qC0w~L zmU3BYJvIuJH^huCS{zCbW#rNZOkg|^4G0V$p+|EC5L(bKW{5E$+OnCU{10mpSQhtk zn+G(x6}1rsA3Ku;fHQXFV8CW?`lNQ04j>*Y-HjtUqV@ZW9y0a=rd;NB%j>MjL8);U z@n7d%RsX&YfXecKIlOvATgeKS=1`G_M7v%>rK`Xg-d^4aA-;f0GlnwcXx~QgR>V_c zA?R0zifEv8vWyO9GnahXKOW5fmn7(co)$nOU~(j1<{{{!NXE$ 6|g6!^7y9q|RKupO4K_4GIMKzo0C#wOTU9%{`nUchZVn>s zWW-2aeuYM5W)&XJCD3-E{wZ?kKnHXaXf|vcj<{QfybK(5Q5VSg;f4G6BL}}cpY|>| z0WSZ#(EvD~6q(a!LSLC&K|hj51qugVT4&h4)+nMEfy%Cy$&vAMNv4$eN#C|9%8|}# z@r(cCq2|8>)r eNR(G~7m<^LJnGMMBR>&d4Tt$yCPZ zB8BOtu%s>E{AiInKbn?kO-140^~irN_86^l7G0Exdeuhi{_?WI7u(w@=iHC@`Nhpb z8EJWVE7c1xE8H%RZrXMWP5G0_`h9I|#jBjnF3M~3I-8B0U)w+DO<&k {a)w}MM;d?XzV6_w=q(0rkcq>D^xOH F!#X@H%lXIa>CTJ%A}hkfZ`{6L)YKoe?8W1VtX91>{rb?f z+IDs1(BdCwK0a74Pe|&^ - +
@@ -88,7 +88,7 @@ Template Name: "TextCenterAlignedWithCardGrid" Template Name: "TextCenterAlignedWithLinkButtonGrid"
- +Structure Details
@@ -134,7 +134,7 @@ Template Name: "TextCenterAlignedWithLinkButtonGrid" Template Name: "TextImageSideBySideWithCardGrid"
- +Structure Details
@@ -214,7 +214,7 @@ Template Name: "TextImageSideBySideWithCardGrid" Template Name: "TextVideoSideBySide"
- +Structure Details
@@ -239,7 +239,7 @@ Template Name: "TextVideoSideBySide" Template Name: "VideoTextSideBySide"
- +Structure Details
@@ -264,7 +264,7 @@ Template Name: "VideoTextSideBySide" Template Name: "TextImageCenterAligned"
- +Structure Details
@@ -290,7 +290,7 @@ Template Name: "TextImageCenterAligned" Template Name: "TextCenterAligned"
- +Structure Details
@@ -314,7 +314,7 @@ Template Name: "TextCenterAligned" Template Name: "TextImageSideBySide"
- +Structure Details
@@ -340,7 +340,7 @@ Template Name: "TextImageSideBySide" Template Name: "TextCenterAlignedBody2"
- +
@@ -369,7 +369,7 @@ Template Name: "TextCenterAlignedBody2" Template Name: "TextImageSideBySideWithLinks"
- +
@@ -419,7 +419,7 @@ Template Name: "TextImageSideBySideWithLinks" Template Name: "TextImageSideBySideWithSections"
- +
From 6e652b3d4fb2453c3c4dba07a4d5dbaffb4700c4 Mon Sep 17 00:00:00 2001 From: Evelyn GurschlerDate: Wed, 21 Feb 2024 11:29:06 +0100 Subject: [PATCH 4/8] chore: fix prettier formatting --- .../Architecture/Security-Assessment.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer/Technical Documentation/Architecture/Security-Assessment.md b/docs/developer/Technical Documentation/Architecture/Security-Assessment.md index 73915ab19..d6394a792 100644 --- a/docs/developer/Technical Documentation/Architecture/Security-Assessment.md +++ b/docs/developer/Technical Documentation/Architecture/Security-Assessment.md @@ -6,7 +6,7 @@ | Security responsible | [@SSIRKC](https://github.com/SSIRKC)
[Szymon Kowalczyk](szymon.kowalczyk.external@zf.com) | | Version number of product | 23.12 | | Dates of assessment | 2024-02-13: Re-Assessment | -| Status of assessment | RE-ASSESSMENT Finalized | +| Status of assessment | RE-ASSESSMENT Finalized | ## Product Description @@ -209,7 +209,7 @@ All threats identified are mitigated. - Container Scan conducted - Trivy - Infrastructure as Code - KICS - Securing code, dependencies, containers, IaC and Cloud Deployments - SNYK - + Also see [Penetrations Tests](../Tests/Tests.md#penetration-tests). ## NOTICE From 21fec885bcd847232d4ddd2d5ec8c595db3b68c7 Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Wed, 21 Feb 2024 11:44:46 +0100 Subject: [PATCH 5/8] docs: improve offer release process conformity (#252) --- .../App Release Process.md | 83 +++++++++++++++++-- .../03.Terms&Conditions.md | 37 ++++++++- .../03. Terms&Conditions.md | 27 +++++- .../03. Terms&Conditions.md | 25 +++++- 4 files changed, 156 insertions(+), 16 deletions(-) diff --git a/docs/developer/04. Apps/02. App Release Process/App Release Process.md b/docs/developer/04. Apps/02. App Release Process/App Release Process.md index f82885b82..c3996a300 100644 --- a/docs/developer/04. Apps/02. App Release Process/App Release Process.md +++ b/docs/developer/04. Apps/02. App Release Process/App Release Process.md @@ -417,15 +417,36 @@ In case the privacy policies can not get loaded, the response will look like def
-#### Step 3 - Terms & Conditions / Consent +### Step 3 - Terms & Conditions / Consent + +
+ +This step in the app release process is ensuring that your application meets the marketplace's standards and complies with all legal and regulatory requirements. +Following actions are covered in the step: + +- Agreement to Marketplace Rules and Terms & Conditions +- Upload of App Dataspace Conformity Certification + +
-Depending on the response of the endpoint #1 GET agreements, the user will be enabled to download related documents from the portal to read through the relevant agreement details. Expected formats are pdf, however other formats can get supported as well. +
+
+ +### Agreement to Marketplace Rules and Terms & Conditions + +Before the app provider can proceed with the release process, they first must agree to the marketplace's rules and Terms & Conditions. This agreement is essential for ensuring that the provider app adheres to the marketplace's quality standards, operational guidelines, and legal requirements. +To display the relevant agreements, respective linked documents and to store the provider consent, the following endpoints are to be used: + +- GET /api/apps/appreleaseprocess/agreementData - used to fetch all necessary appReleaseProcess agreements +- GET /api/administration/documents/frameDocuments/{documentId} - used to enable the user to access agreement documents +- POST /api/apps/appreleaseprocess/consent/{appId}/agreementConsents - post consent +- GET /api/apps/AppReleaseProcess/{appId}/appStatus - to check the current given consent status
-###### #1 Retrieve Terms & Conditions +#### #1 Retrieve Terms & Conditions Terms and Conditions are fetched via the endpoint @@ -439,9 +460,9 @@ Response Body [ { - "agreementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "agreementId": "uuid", "name": "string", - "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "documentId": "uuid" } ] @@ -462,7 +483,7 @@ If the documentId is NULL, the agreement is displayed without link (as currently
-###### #2 Retrieve Documents +#### #2 Retrieve Documents Terms and Conditions with an document ID in API endpoint #1 can get retrieved via the document endpoint GET /frameDocuments/{documentId} @@ -479,7 +500,48 @@ Response Body
-###### #3 Upload Document +
+
+ +#### #3 Store Consent for Agreements + +The given consent or the unapproved consent for the needed agreements are stored via the POST endpoint. +The endpoint will store the newly added agreement status as well as update existing consent status if necessary. + +```diff +! POST: /api/apps/appreleaseprocess/consent/{appId}/agreementConsents +``` + +
+ +Response Body + + { + "agreements": [ + { + "agreementId": "uuid", + "consentStatus": "ACTIVE" + } + ] + } + +
+
+ +### Conformity Certification + +The Service Dataspace Conformity Certification is a document that certifies that the service provider service complies with specific data handling, privacy, and security standards. This certification is crucial for marketplaces that prioritize the safety and privacy of their users. +To support the conformity certificate upload, following endpoints are available: + +- GET /api/apps/appeReleaseProcess/{appId}/appStatus - to retrieve already uploaded certificates (if any existing) +- PUT /api/apps/appreleaseprocess/updateappdoc/{appId}/documentType/{documentTypeId}/documents - to store the conformity certificate +- DELETE /api/apps/appreleaseprocess/documents/{documentId} - used to delete the conformity certificate + +Note, only PDF is supported. + +
+ +#### #1 Upload Document The user has to upload the app conformity document. @@ -491,18 +553,21 @@ Type: CONFORMITY_APPROVAL_BUSINESS_APPS
-###### #4 DELETE Document +#### #2 DELETE Document In case the user identifiers that a wrong document got uploaded in the respective step, the DELETE endpoint is used to delete documents linked to the app. Important: the deletion is not reversible - since the app is still under DRAFT, all app related details will get deleted immediately. ```diff -! Delete: /api/apps/appreleaseprocess/documents/{documentId} +! DELETE /api/apps/appreleaseprocess/documents/{documentId} ```
+
+
+ #### Step 4 - Integration - Role Upload
diff --git a/docs/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md b/docs/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md index fef58c047..3accfbde9 100644 --- a/docs/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md +++ b/docs/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md @@ -2,13 +2,28 @@
- +This step in the service release process is ensuring that your application meets the marketplace's standards and complies with all legal and regulatory requirements. +Following actions are covered in the step: -Depending on the response of the endpoint #1 GET agreements, the user will be enabled to download related documents from the portal to read through the relevant agreement details. Expected formats are pdf, however other formats can get supported as well. +- Agreement to Marketplace Rules and Terms & Conditions +- Upload of App Dataspace Conformity Certification
-### Implementation Details + + +
+
+ +### Agreement to Marketplace Rules and Terms & Conditions + +Before the service provider can proceed with the release process, they first must agree to the marketplace's rules and Terms & Conditions. This agreement is essential for ensuring that the service provider service adheres to the marketplace's quality standards, operational guidelines, and legal requirements. +To display the relevant agreements, respective linked documents and to store the provider consent, the following endpoints are to be used: + +- GET /api/services/servicerelease/agreementData - used to fetch all necessary serviceReleaseProcess agreements +- GET /api/administration/documents/frameDocuments/{documentId} - used to enable the user to access agreement documents +- POST /api/services/servicerelease/consent/{serviceId}/agreementConsents - post consent +- GET /api/services/ServiceRelease/{serviceId}/serviceStatus - to check the current given consent status #### #1 Retrieve Terms & Conditions @@ -49,7 +64,7 @@ If the documentId is NULL, the agreement is displayed without link (as currently #### #2 Retrieve Documents -Terms and Conditions with an document ID in API endpoint #1 can get retrieved via the document endpoint GET /frameDocuments/{documentId} +Depending on the response of the endpoint #1 GET agreements, the user will be enabled to download related documents from the portal to read through the relevant agreement details. Expected formats are pdf, however other formats can get supported as well. ```diff Get: /api/administration/documents/frameDocuments/{documentId} @@ -89,6 +104,20 @@ Response Body
+### Conformity Certification + +The Service Dataspace Conformity Certification is a document that certifies that the service provider service complies with specific data handling, privacy, and security standards. This certification is crucial for marketplaces that prioritize the safety and privacy of their users. +To support the conformity certificate upload, following endpoints are available: + +- GET /api/services/ServiceRelease/{serviceId}/serviceStatus - to retrieve already uploaded certificates (if any existing) +- PUT /api/services/ServiceRelease/updateservicedoc/{serviceId}/documentType/{documentTypeId}/documents - to store the conformity certificate +- DELETE /api/services/ServiceRelease/documents/{documentId} - used to delete the conformity certificate + +Note, only PDF is supported. + +
+
+ ## NOTICE This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). diff --git a/docs/user/04. App(s)/02. App Release Process/03. Terms&Conditions.md b/docs/user/04. App(s)/02. App Release Process/03. Terms&Conditions.md index 96a4535d0..ee5267807 100644 --- a/docs/user/04. App(s)/02. App Release Process/03. Terms&Conditions.md +++ b/docs/user/04. App(s)/02. App Release Process/03. Terms&Conditions.md @@ -1,6 +1,6 @@ ### Step 3 - Terms & Conditions / Consent -Under Step 3 - the user needs to agree to the terms and conditions of the app publish rules before getting on the marketplace. This section is mandatory and displays agreement documents; if any documents are linked to the relevant agreement types +This step in the app release process is ensuring that your application meets the marketplace's standards and complies with all legal and regulatory requirements. Below is a detailed guide on how to complete this phase successfully.
@@ -11,6 +11,31 @@ Under Step 3 - the user needs to agree to the terms and conditions of the app pu
+#### Agreement to Marketplace Rules and Terms & Conditions + +Before you can proceed with uploading your app to the marketplace, you must first agree to the marketplace's rules and Terms & Conditions. This agreement is essential for ensuring that your app adheres to the marketplace's quality standards, operational guidelines, and legal requirements. To complete this step, follow the instructions below: + +- **Review the Documents:** Carefully read through the marketplace rules and Terms & Conditions. Pay special attention to sections detailing your rights and responsibilities as a developer/provider, as well as any requirements your app must meet to be eligible for listing. + +- **Accept the Agreement:** After reviewing the documents, you will find an option to accept the Terms & Conditions. This usually involves checking a box to indicate your agreement and then clicking a button to confirm. By doing so, you are legally binding yourself to these terms, so ensure you understand them fully before agreeing. + +#### Upload of App Dataspace Conformity Certification + +The App Dataspace Conformity Certification is a document that certifies your app complies with specific catena-x dataspace, data handling, privacy, and security standards. This certification is crucial for marketplaces that prioritize the safety and privacy of their users as well as it gives the customer the trust that all catena-x dataspace quality standards are followed. Follow these steps to upload your certification: + +- **Prepare Your Certification:** Before you can upload your certification, you must obtain it from a recognized certifying authority. Ensure that your app meets all the criteria for certification and that your documentation is up to date. Respective certification authorities can get found on the catena-x homepage. + +- **Access the Certification Upload Section:** On the app submission page, look for the section designated for uploading conformity certifications. This section is typically found after the agreement to marketplace rules and Terms & Conditions. + +- **Upload Your Certification:** Click on the upload button and select your certification document from your files. The marketplace accepts PDF format. Ensure the document is clear and all information is legible. + +
+ +Once you have successfully completed the page; proceed to the next step "Technical Integration". + +
+
+ ## NOTICE This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). diff --git a/docs/user/05. Service(s)/02. Service Release Process/03. Terms&Conditions.md b/docs/user/05. Service(s)/02. Service Release Process/03. Terms&Conditions.md index 194c2fcd0..3372495db 100644 --- a/docs/user/05. Service(s)/02. Service Release Process/03. Terms&Conditions.md +++ b/docs/user/05. Service(s)/02. Service Release Process/03. Terms&Conditions.md @@ -1,6 +1,6 @@ ### Step 3 - Terms & Conditions / Consent -Under Step 3 - the user needs to agree to the terms and conditions of the service publish rules before getting on the marketplace. This section is mandatory and displays agreement documents; if any documents are linked to the relevant agreement types +This step in the service release process is ensuring that your service offer meets the marketplace's standards and complies with all legal and regulatory requirements. Below is a detailed guide on how to complete this phase successfully.
@@ -8,9 +8,30 @@ Under Step 3 - the user needs to agree to the terms and conditions of the servic
+
+ +#### Agreement to Marketplace Rules and Terms & Conditions + +Before you can proceed with uploading your service offer to the marketplace, you must first agree to the marketplace's rules and Terms & Conditions. This agreement is essential for ensuring that your service adheres to the marketplace's quality standards, operational guidelines, and legal requirements. To complete this step, follow the instructions below: + +- **Review the Documents:** Carefully read through the marketplace rules and Terms & Conditions. Pay special attention to sections detailing your rights and responsibilities as a developer/provider, as well as any requirements your service must meet to be eligible for listing. + +- **Accept the Agreement:** After reviewing the documents, you will find an option to accept the Terms & Conditions. This usually involves checking a box to indicate your agreement and then clicking a button to confirm. By doing so, you are legally binding yourself to these terms, so ensure you understand them fully before agreeing. + +#### Upload of Service Dataspace Conformity Certification + +The Service Dataspace Conformity Certification is a document that certifies your service complies with specific catena-x dataspace, data handling, privacy, and security standards. This certification is crucial for marketplaces that prioritize the safety and privacy of their users as well as it gives the customer the trust that all catena-x dataspace quality standards are followed. Follow these steps to upload your certification: + +- **Prepare Your Certification:** Before you can upload your certification, you must obtain it from a recognized certifying authority. Ensure that your service meets all the criteria for certification and that your documentation is up to date. Respective certification authorities can get found on the catena-x homepage or within the portal company role details "Service Provider". + +- **Access the Certification Upload Section:** On the service submission page, look for the section designated for uploading conformity certifications. This section is typically found after the agreement to marketplace rules and Terms & Conditions. + +- **Upload Your Certification:** Click on the upload button and select your certification document from your files. The marketplace accepts PDF format. Ensure the document is clear and all information is legible. +
-In case any documents or further details to the agreements are available, the agreement will be blue highlighted and can get downloaded by clicking on the agreement title. +Once you have successfully completed the page; proceed to the next step "Technical Integration" or you might directly get forwarded to the "Verify&Submit" step, depending on your service offering type.
From 8c04d5a0b6e35207b9adf439db4bb9eecdfeb4c3 Mon Sep 17 00:00:00 2001 From: Martin RohrmeierDate: Wed, 21 Feb 2024 20:36:05 +0700 Subject: [PATCH 6/8] fix(documentation): fix relative links (#257) --- CHANGELOG.md | 2 +- .../02. Identity Provider Management/index.md | 2 +- public/documentation/js/Main.js | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 25101fc9e..32e525e01 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ New features, fixed bugs, known defects and other noteworthy changes to each rel ### Bugfix -- fixed links from documentation pages to GitHub +- fixed links in documentation pages ## 1.8.0-RC4 diff --git a/docs/user/02. Technical Integration/02. Identity Provider Management/index.md b/docs/user/02. Technical Integration/02. Identity Provider Management/index.md index 3a2bccfa3..66fe8d01b 100644 --- a/docs/user/02. Technical Integration/02. Identity Provider Management/index.md +++ b/docs/user/02. Technical Integration/02. Identity Provider Management/index.md @@ -6,7 +6,7 @@ - [User Migration](./03.%20User%20Migration.md) - [Identity Provider Disablement](./05.%20Disable%20Identity%20Provider.md) - [Identity Provider Deletion](./04.%20Identity%20Provider%20Deletion.md) -- [FAQ](./04.%20FAQ.md) +- [FAQ](./06.%20FAQ.md)
diff --git a/public/documentation/js/Main.js b/public/documentation/js/Main.js index 09937cb98..edafbcce1 100644 --- a/public/documentation/js/Main.js +++ b/public/documentation/js/Main.js @@ -595,10 +595,10 @@ class Content extends Viewable { filterText(text) { const path = state.selection.split('/').map(encodeURIComponent).join('/') - return text.replaceAll( - '](.', - `](${Settings.DOCBASE}/${state.releaseSelection}/${path}` - ) + return text + .replaceAll(/\]\(\.([^)]*)(\/(index.md)?)?\)/g, `](.?path=${path}$1)`) + .replaceAll(/\]\(\/docs\/([^)]*)/g, `](.?path=$1)`) + .replaceAll(/\/\)/g, ')') } mdFromText(text) { From e1bd38fefe137062f58217b96754c9a3d127230e Mon Sep 17 00:00:00 2001 From: Evelyn GurschlerDate: Thu, 22 Feb 2024 21:16:49 +0100 Subject: [PATCH 7/8] build(v1.8.0-RC5): update changelog --- CHANGELOG.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 32e525e01..00521a1f2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,16 @@ New features, fixed bugs, known defects and other noteworthy changes to each release of the Catena-X Portal Assets. -## unreleased 1.8.0-RC5 +## 1.8.0-RC5 + +### Change + +- improved offer release process documentation +- updated security assessment ### Bugfix -- fixed links in documentation pages +- fixed links (relative links, image links and links to GitHub) in documentation app ## 1.8.0-RC4 From 4d890c81963a1d06c899b34f60cf277d42734589 Mon Sep 17 00:00:00 2001 From: Evelyn Gurschler Date: Thu, 22 Feb 2024 21:17:28 +0100 Subject: [PATCH 8/8] build(v1.8.0-RC5): bump version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index e89a7573f..dafc50744 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "cx-portal-assets", - "version": "v1.8.0-RC4", + "version": "v1.8.0-RC5", "description": "Shared frontend content and static assets for the Catena-X Portal", "main": "index.js", "repository": "git@github.com:eclipse-tractusx/portal-assets.git",