From 5331f727ea1590a4ab3c5829b8034b7e76bbf2cd Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Tue, 16 Aug 2022 13:54:37 +0100 Subject: [PATCH 01/43] Configuring release pipeline for non Nodejs/Nodejs I created an empty file for documenting the configuring release pipeline for both Nodejs and Non-Nodejs. --- docs/configuring-release-pipeline-for-no-Nodejs.md | 0 docs/configuring-release-pipline-for-Nodejs.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/configuring-release-pipeline-for-no-Nodejs.md create mode 100644 docs/configuring-release-pipline-for-Nodejs.md diff --git a/docs/configuring-release-pipeline-for-no-Nodejs.md b/docs/configuring-release-pipeline-for-no-Nodejs.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/configuring-release-pipline-for-Nodejs.md b/docs/configuring-release-pipline-for-Nodejs.md new file mode 100644 index 000000000..e69de29bb From 20a8342da02a80652eca7cea3e7df609d8588719 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Tue, 16 Aug 2022 14:12:40 +0100 Subject: [PATCH 02/43] Created a folder for documenting the new files(#903) This folder will hold documentations for the new AsyncAPI community section --- ...o-Nodejs.md => configuring-release-pipeline-for-non-Nodejs.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{configuring-release-pipeline-for-no-Nodejs.md => configuring-release-pipeline-for-non-Nodejs.md} (100%) diff --git a/docs/configuring-release-pipeline-for-no-Nodejs.md b/docs/configuring-release-pipeline-for-non-Nodejs.md similarity index 100% rename from docs/configuring-release-pipeline-for-no-Nodejs.md rename to docs/configuring-release-pipeline-for-non-Nodejs.md From 782ab428412eab382b6e703f849d4bd347fb2140 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Tue, 16 Aug 2022 14:22:17 +0100 Subject: [PATCH 03/43] docs: created folder for documenting new files(asynceAPI#903)[https://github.com/asyncapi/website/issues/903] This folder holds documentations for the new AsyncAPI community section --- ...e-for-Nodejs.md => configuring-release-pipeline-for-Nodejs.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{configuring-release-pipline-for-Nodejs.md => configuring-release-pipeline-for-Nodejs.md} (100%) diff --git a/docs/configuring-release-pipline-for-Nodejs.md b/docs/configuring-release-pipeline-for-Nodejs.md similarity index 100% rename from docs/configuring-release-pipline-for-Nodejs.md rename to docs/configuring-release-pipeline-for-Nodejs.md From b8e7e1afb5ef29054aca83821d2955dde0ad9ce3 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Tue, 16 Aug 2022 14:43:21 +0100 Subject: [PATCH 04/43] docs: created folder for documenting new files[asyncAPI#903](https://github.com/asyncapi/website/issues/903) This folder holds documentations for the new AsyncAPI community section --- docs/configuring-release-pipeline-for-non-Nodejs.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 docs/configuring-release-pipeline-for-non-Nodejs.md diff --git a/docs/configuring-release-pipeline-for-non-Nodejs.md b/docs/configuring-release-pipeline-for-non-Nodejs.md deleted file mode 100644 index e69de29bb..000000000 From 2b56975d7b98bcd29ca77bfb6ce514891b541f6c Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Tue, 16 Aug 2022 20:25:01 +0100 Subject: [PATCH 05/43] This is the documentation folder for the new asyncapi community section --- ...eline-for-Nodejs.md => configuring-release-pipeline-Nodejs.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{configuring-release-pipeline-for-Nodejs.md => configuring-release-pipeline-Nodejs.md} (100%) diff --git a/docs/configuring-release-pipeline-for-Nodejs.md b/docs/configuring-release-pipeline-Nodejs.md similarity index 100% rename from docs/configuring-release-pipeline-for-Nodejs.md rename to docs/configuring-release-pipeline-Nodejs.md From e11ec45ebc89b00eda0710f41245f6bc44109d97 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Wed, 17 Aug 2022 14:11:12 +0100 Subject: [PATCH 06/43] Added README.md --- docs/README.md | 1 + docs/configuring-release-pipeline-Nodejs.md | 0 2 files changed, 1 insertion(+) create mode 100644 docs/README.md delete mode 100644 docs/configuring-release-pipeline-Nodejs.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..ebd88ebd6 --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +__docs__ folder is for all community related documentation. \ No newline at end of file diff --git a/docs/configuring-release-pipeline-Nodejs.md b/docs/configuring-release-pipeline-Nodejs.md deleted file mode 100644 index e69de29bb..000000000 From de1fe04e52bb1ac60bd9480878631fd127440608 Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Tue, 30 Aug 2022 10:17:14 +0100 Subject: [PATCH 07/43] Update docs/README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index ebd88ebd6..f5b4cf7b2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1 @@ -__docs__ folder is for all community related documentation. \ No newline at end of file +__docs__ folder for community related documentation. \ No newline at end of file From c267bb911e29ec8337e26311a2a57937c48221fc Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Mon, 5 Sep 2022 11:36:36 +0100 Subject: [PATCH 08/43] Generated docs content from a meeting with Lukasz --- assets/image-for-docs/Github-discussion.jpg | Bin 0 -> 20359 bytes assets/image-for-docs/discussion.PNG | Bin 0 -> 1617 bytes docs/how-to-create-new-repository.md | 36 ++++++++++++++++++++ 3 files changed, 36 insertions(+) create mode 100644 assets/image-for-docs/Github-discussion.jpg create mode 100644 assets/image-for-docs/discussion.PNG create mode 100644 docs/how-to-create-new-repository.md diff --git a/assets/image-for-docs/Github-discussion.jpg b/assets/image-for-docs/Github-discussion.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8527a8b8bfd25e6abfe67b09961a0809b0a3f6ee GIT binary patch literal 20359 zcmeFZc|6-&+c%olE*(tWZ4Fgad$-z}YO7FFik9vwI+~|aQUq0!n1WUf-KI{48fz=nW`OF!V++EE-@vBUrT_pc z{lMnEJ;LXG53f3g005GmJAb=+gWlf<0Bn!_dD-+%nA;LHvR>mZLX|feI-H+)^vD%c z+e??ex8GFiv)cRTaf|dYYTy)kJiQEEJU2fnuV1ru^;3DjnmhfMCzz0%bH1fD66bxllq%EF%OLIo05UxXrLh+U-SOCAf$f&MF+bVV!Pkh- zrjHzQZ`IDfGntm^;gmFhFXRuVRt0b&dZm^*Gh1Wqh2^?y4Bz;lQcwgdnGQLi&+-oy?c>U_95sTKXa+PJ93=CL#uwIj=Rzc-4Wgb00O z9dT8va{~CFr=E<83;^JuA*@7MRwQ(7E%q)X?D6qrpVv7nm61Dw_E)k=Hxfieprh9( zirkF~3x4(l`1-HQf6TW{C5F$ng^ZZ6+BA$;i@yOuo7X0ss&pigr)*2q*u2tl`uF5v z38~HFh;8~3IJQtQBsH9`?AoQ1pU-Xk`88yuf%Y>vqVyuMQG?%BG5qI9K?a0Kn7Yg$ z7jEhsuaQGWqKi4`Qs=_J%)$+IJ)i4S zIHYA;;%|!_oUNCpEG60?=u~c4#I)+h(xTQV0>RiIN2He9R<|HS0?Rpt;k<95LpS4~ zGW$pBGD-Bd5jsII9ls_}Wm(g`83Ux{kP#}#ck#`mrLkW2=w)Mqk>E}Y)b;CAQ(Cml<-pzW-a1;Fwjz-XD-2n- zwhf)yWgtsAX6Ul6wd}`RiC_DY1~aY-8Opx`0vmO1eHy%IMkrlc7*v*IZdM~RbWLS$5z=!UnEhaDZN?n zyzJOkLXi>xz`cCn>3H8hlC|Vyj9WaJ5NMkS_1WfL-25IoOhK0>E6F9s_Xbj&vhvr^ zuPhm)d(*0*t8n)^W5vjy$1g9fr&SD7$=KtVk9TDf{6G;GT-VYDW@b@>;5fnL`TbNv z8DA@aiQ4RAR9Pq+zxYcYH1@uHMi~Ac|^a5fC*!P+gcDVw*HyGO?@g4?L!tW zC~UNm`nG8^tfM`|qj`P^fca@b>k086yY8_}igoZ8UJpo{@W=2yvsE|r z`RKV4&>^fw00Qo7x7r@M1g}F7bnqD%__PE{@;U`)AQ^8vX(awGBlv3h?w|4bXh?Hl z=z$+0G>UFsN2@xO_B5-Er5Ixu#7=MlZLFL*oVtDXxgz0xfqYuChOrDI!QH4pb8!mY z^1;ts=01HNid|SNGUDwRyS0U&9Kev%G&H))gQ!kCJf>wkY>rA|v4eF;Y`>Fs9 zd+%Oqt>jBRc2b(GU@Ya88ZnaX8a31l*VBX=W4`E0{CJOvs(Z%rmYb3RrLOou{4+0P zSk&fe%O<1qHv3RjV6_98$2|1{Y%%CG-!oJ7;89|C;<#sIGM@bg9e=;$LGMhbeB(+8 zD(&(>XEML#KI9c$?Q7y7KS0NpFZ!C141HaJ)@Bz)+uJ5(8&$Mr3>Xs-T+- ztO%1^Y^h-Zm5!qatdB|?x_?o}gcJqDI|!E*1PNjdu5CnCJ3A#Q>R)u_Q-kO6V2)41 zv%2#3^DZ(3`>AHHNP~rUUZQmsBWC!&634xUGiZTnv+-+PBA7A4S*45Or<1Egbj_Ki zD=-2PkHgH%C{95Rx=U!r zhoyp}o^>Hc9N2UVNT`dAs?N%K?gEUD&mBOOEnS1tfE$`!B38N20^<9J*wNqGiFFwj zM?Kl{xMdxT>YZKi&|LPlgmG@&^Fu+*3!U?s-`oZI)a~}KO#_=z7rrf#EtM5bqzpG+ z7~R$_(!cZVy|J33FNYvJMJ~zwu;|c=af7C%>-QDV5Zocg1U-127DV`tj6$&LAfxhAsv9XtbBq9>Z; zCoCwcWo!KH9CxKrNvnKfyppnM?(ysN(K2bcXkUadTH2~K;=ols6az&!?8JX4dUzY z-gb5C{h$~3AW#Drc8;2#KV#H|=9N|$wE1wuw_t?5s0=TV(;k|yz%jCD{~$G;cJS9S z6IJ0R#1}lH=AoAw^{Cra1vGuxxfgkU2*U9m52P|NKq!N_$FYT0m3a<&k}V|KBtot^7Gj1&aq zpPG7MVB+RGTIz1H1N`2`luntL%<6A@(u)^R%Cjt<%SQMpMlB!yXd_~RwU!NCTKi0x zk$g-UCK5FU^VtsJbDtAOuH0>%g#}vKo7|{!Z){U;Uiv%qmfia1Qh}mpr||529r)8? z)5RNlm;RGaL+HCY{$zUpTI+$~Q{(%DxZ3VNSp#YRC2Qb++no4s4OB)VC&9STZm8aY z9rL6z#(ue_2?$T3Zolmu&Yg;iGT>Fk6r^4JcHcoKSfZyvj&y&)DZlp{crqJ3#YHak zBew~mT)jg8!1*#c^Iivop3xE%_u55PXV#$JAuOo^IQID4k7C>FNYL7+&~}BX*KY71 z3ik%Obmd6X2gh{fNj@&cCH|Q2cab1qD?81-3_iIU#lsV}tPBK2+c!5meggpdJjE5g z7UXXCjvMrhm!Q_KB^}3lB&9yDnf)~L*S+1uiOk|OBywoD!TI-X?FfnlsH$!2oZ?!U z@^vk0ByKuFXni@R6nUvDdM$R0^W2jeRj=Qu00T)z)7hZ231SXfY5F|dx#kA_KzP!& zOsgPd`)1f4KrHpJ*P@(ruUw>VkVb*Lr&j{wt45HfsIdIh4cB6Je@{Z1*!1GzDcJ0)+V_rRsgT_~UtJa>p)Wa-+qJlZI<&Qy9Q_nWlF@D17|M9-?+n z8VcsSaV=Zkb0*)zs%RH6x6#gu^sqWyy0spXLyzXyBQH-_v9e`+B^mqGelGJgb<1kKa-ux)-)6dErK3&UfT}?0N{&W znc)H-LyL-+Sw=Hp4g!XfNp(x0tpl!7ws0?2{>F5$;%Q3|9u?rQLmI^ty5IvVi zp1e5O)^`rQ7wE=6@aG;1{-DN~hHo$=+k|>(g!Yae&3j;gY;2*~{n6#d{d_LUW~Jly zG~0Iv9{{V3HM=ZgTY0?Pk+}3IRqFZ|y%Al#$sEm%F5QJ5$~F+Od0X!==5ziJaF8t~ z=3CoZ6M^RHG9|lWVY6}!a<(2OAjNDxXbt>O;QMs^ZuT<-Rem9^u;oPl&t|T{E72mD z^uyj+Gj#wU@^4{R(LbJ84bx%-s8BX-@>QA<_uaHXU0yAx-e7a8mN7NG+LlC#qf4Mn zlU$Gel6a5O5l=4}Zl)pY&vnq+0|QQdT{7co$l&(XX2uqhSl93^h!uHWF#CaJ1xEZp zGAL;?+?k$uWo&Kr`pb0p+av|=6%JCX$@2~ktuv@FwqAnVGM@+^QG^_$wSu@naZ-#H1rwAP{21pLWgOJ;uuT zb`*;iQyd7dGg{9PxPjnF0$fbk%5viPNv*4T##=6mA3u)Jcuo;DhdeQPaC;sRB#5XP z)QWMf3bBgdKO{dZ{K;Pnt5e?`d9`qxbu@5&%6XVn=M6%vCdVPFiy9*gW10g9;7Du!PmSJfN8U$Sl4^5$oQ>?0h{Y|6E|F3aLcRU4{5#=D(L<14;tX$_6EWA zgV2QzdXEaX64|A`6tch?^v#s&TmT_7@^vRlU(o)_OB{!no%Gsx(F-LOhIVupUfuqI zL*UM2W}qEYw&KS@R+RnFrdc^aY@6eNbR@4y*^Ml%prY+_!zQ-I&qq98#!~leyg5$H2TrQYakFxGm>yttc=DNfYbv)R%%_*^ZpA9 z=b{9OVw!_QU(g}`f@(SI+GlByz+yhU^Axln8g=;_1VrAbnK| zA++Q;_Si1qnr4?wprO(ZFq(fcwjafcpfxS@4^8|C=qv8tc%i&7zt}0 ziav$%85;kRs>L7iFbA14<9)5r#{dA{g9bC^AYtj6C5}U|H|esdX%Pgmkl<@Gj$>-b zR+J=qMSS51X;ME&J{3B>L9D38euy?{*oU&7Z{b@>k?yS_=$m&1FO0Rl6bQ9#Arwcb zVqw$lUqO}OA0f>prAD$)RnLoiI?{^dvr)9pjViCT-ZEMbuAuXRHKX|&!;(f|jg(BU|n4iU2B+BI1Kn_o~j<}$kin=*7+#*ygbEG1sxt&Hb)*m;|xiXIOtgz zy*afOBj8ys;I@=O*D;7WFRSL%#vw^m2HZ7k8TrIN1kb_*V!b_qoF#jc9Hs57y;u>D zpbR{0&Ec}F3VC+i!5;T*PvIy1U2cIKQDLiOf1CXvykE^15kJ0KS4FMmLBT-S$XQvL zMKM4u$6xsVOYEZ!^21gQ?Nz&~8x-xADn$aew2iEw!)IBQ;CMFWMb-&3=3RT&jA(W) zZFGu9#4Ot-QRj)yNs5&UDo_^_-Ekn{W5VDgA#2OBQ`^zt%OUXPa224BS5PC=UT_^U zS#S)q*;DEF8)5I;l7P8`1hxf2Z+n0?rh}tsP26+|ax-JDI%VwO=<5zu(h8nHSo#6f z%Ej7X|6sOe?~1OE^^En~YYaj~Q}<6RcR^z4=U(K8pb*U}J!DwcG+q;1DOsb{^5cm# zHutFzNjNA}$a}gs5uz1lVAGs4CSt%ROogc*3H7WtK9Sa|V3I-fzPEz|DpSYAcl5jY zicJ^4g&R9@imOy`ydSk9Z-kAcs8`ni2l~^&ZGlD>qy*_}!>#LTnqmNejOu?v zfwZ-`8HV14b9;mUbNXnie?zDQ{TIg0hqpYJ%j4U#ci`z%{)d>-xzIH+yDm3MTm=|L#H(ugE z!g#A&!w1QIK_<(#BXfF+uOyAWCwXSajy?J^ce31nWuBLl;;&P^gT+_NNy@oGe2ipl z%Lrz{+a+x=xNvDjp@<#+4aRrCHTDA6?X0j_i^*#F$0}2oRHydI5U;t!1#1k399X#! zj5XivJ)?9rw!6Q4l z4%==q^9L8$>qh!9Nz~AG6<_u@%d*aN6BMjVJ7%Xz(c$kMpAudiv?2$Ww5+_Jp&vkL z(fAEe5vj1w+~FyHn`WzLpSe`|u96<%SS|^Zb5f}rO|C+ZM()(3k6)wdx6FmJ82@oXrzh7qx~)J*$!=ne^af)mKV3K14(u#-Ome|7C{pZLqv<7vuptu#I}@@=-%C9A2Z%|cm>v!?dmK%Z>Sn1g<~B&>po znRqm|_rkz6@z*Dxb{%hV-fA*rIdgy9{C$^Nn#RP7tX>pMq$Ex%w8MF=S2%!ft8J|hHmN=fCZ=h*7`&Y(+TEG|k0}@L1on@h0zjqbeO$(T>&R@#U4w*VU|9p4h03zAnpJ8B6DdUh_8=a>Fu5jjFr8UR+cgBQyPVeLQp9Tkh|)0-308zH4fdg z-Dx85V)t9!-Pd&L>hqd|GLOVfZ4SV%!NAhtYcFRib3Xiopaea zh^0Yo;EBuMAN!Z^(f4(^^1X71%v^e7RxRzlAr6)!KOU7Y?Y)t!-rZ1#CFtw@Em2q9 z%?n??;zCP4A|S7Y90S*v{L3to>W=>@^)^-3(~!{IBkreo&C3FIIM9&LDcSje0sMY5 zNwK9M`&kv{bD-sNCC<=Jr;CU=M1Ne{3~=tK*Tnny)qQaUtxrHGjzr0_IKi^fc2y^o z4XZcza|Mqj3^gD0bG|1Buyfng_^Tt>w_PTuBh;5t@)u90_N8*rK@~MonwsvJG_EC0 z7kTn&@Zqc#7L9QsIiKg4ylsSW*ZiHDe zo}T{ELmFP~o`_WeO67$+479OC2X6sfk9XNjxgFC%<8>6U!zw_{nisw*p=ZpN^`jEr zd&wEF9VeHY!(H<^7WhPd+EUKfsJH^}{Q5nYdi& zu@JrE7Vnd5=aWx=?T)~6QbI>4?NK&W5)WTA3CQ~J}Xb*@y!$mR##F2?^?PNM>F=!mAU~O z_N>7DjN`}W9LI$2A8qG`mmICpGPRO@E_F|s5AqlNeK$NW$DSS7)L0X>Mf_fLI_=&B zr`c&*SyYX)31jO_ZQfRG>uE~;a+H2P@OB!jSe=+0D?5u1*E9c*0gpa-!mOkn#5ZjV zN1O{+YQr9~6Z^*f#%0&sd!~cJA9S!H+9m}MUdrg|ln;>gIN(iR+)%S2YHXSvaaYr+ppTtSbu5 zJBYUP%ZzN$#au>y2N_?R=0U25!p+8(ADH=X5z_ZA2j^c7Pb%!4Pkvw(q88#}Tj!%D zdy;#wmt;iAbq56->&~V+z|UfA2x@5|MAqBc&DKV3a|rPE#Qq#kKja7mt6Ww0RN7g~ zy~}be|3{f_ajw=s^Qj^SSerFpv{CP1-PV z3s)*Yp|s&1oJ+~W?Hw$6v-ZIJx86YKOy_!)=x7VmHlCAHkcI}G)h(gm$%pJPn(Y%w zyOs+c87`Tf_yl}>u1#|tbR1Z_H~HY4oxz2<6Yqd@_D6iR(!dYkF1^aNkU>tvnh+%6 zs(S(0$*1E=zYAeCFR1t_H}$w#h!N|kPOA08RPxs|&Z+Fl$#Un2>PXvvb#b5X7-*0? zW)P_zV!7So)c+`{BIAI&5T%mv8jFykG^52;MLMtm;Yt>Cj^O3_9`%?k^sG& zTR0)Wg&Z!)tDl_Pk17#bn}7%ZFVR>%e%`$#<%p*{Lv3Gn9AKW=u`z0#clrcGnD0Q) zw|Wr@o_dN8uTDh$99j_iH7YSXsh|`1E2YU0`@X1=F0>G1)Tpa)XCrZFlP^NjNxgNx zB(jXQMFm~m#h?x^{P>wWB}uos+b@--E36`*7w3$d;R6Lts?gb4j44&c^X zqRhp+NvXbbR~Jg+gb4aA?gV2X#6K8m2Kg5|J5W>c{7&H`jzIk4XUBX6w5sgP?u){I|AC>_wY=ly2Arqz z_MsxnWO1PqW=vC7leR0Y16^-_&v8hFB8!P8Frm}E>+>^SXdeBWaqp3=C32coS@i16 zLUyYaUTAaK5-pPye;b#rib$eHIvcQ_EG>*4kkJmKcA7z+X0mN2agC5FW_0dvFE{4P zv=OL-RlT$rK>J6cNmrT(vpjJ;8=A7~x-nm$#e5}=oqjq#_IF{=TDOG|;a&n&1tbNC zjo+0-@yon~S~>fL;5#?;hJU!YU(od|iBwU8d})QaxA@cOfO>|*nN8w71LyT@NUW}W zeX&5V^tROJ#Uykpm!$MuYT{ybB=Q^g5X1KA+MsrQT7$27+u)|D$1>3RH8?;Ht;ai; zna|7A&muQhd3~j~z?^!*(0MtxSw?$6gnAk=xZIUxYnN zO--3Q@*RqPM31R%wmpWf3sp)KJpA&$u-3ovLmiv&0age^$R^Osefc$M+|?DB4l-*{ zcgR>ac>%ewNKdwgwxr@;l?Jm%8&tU@`Q7f-%c{ zG&KDPz=1^6?6MIZACo|Fs=5Z=mdi6!vM}4`xEO=^=ik=Jm#QU!s zYH_tWL8Pu!;?=jmN9G~~pF2EU-M0|lNWUATD4NOOa&sJzj;Aa^M4!wEG{;p_yX!v~ z*q8axPjD|fxhcaj?gvDEq{U5*EL1$(_0s`y-I2z+yQd<88iD<6%5Gfh>xo-30cAYaGzF613i=am?!&ev%{QM&~Hs5lnV9FA2om;nhn` z1mB97L?kvKXNa~`r~r7YMLgY=DO^ek0R43;!!gu z>AA$gE-?ai9O3E&v03sZEgh7r$zF)WUWJXX=r79=&mE`i@tzZ-+S>E^ ze<9`O%Q0uJ0Tk@ccJ;hHyJb!rQ+hqtalDUhdRM%55lWX2lN7zVVbUj3`Z2cVrBuzt zx0ByR>OTuESco*<#HyyF#!4a57n=y@n`n-4U2o8xdKQ0cHwgmkpILr?~Yt=^7 z&6a1RPv}IxRYvBriBXD`S?j^3E7`rP45$z7$OPsgO><OnDV?_&P+E|CwKgm|QB%t&Zno zf9i+>DkCctJneBxw(?`b(RTWu>w~LxYpQFD~c22QBvVQLdK! z@dTtL1B|$-Y~IE)bq1qLh5~N4C~;PH3&ymutp~<36m9ET#?Tu)972PRE0%HJt_OQM z%Y@sA37nU4;XLQ0J+aYFty40zG4iQ|=|cVB;?eS+K%NUY^T z`$$*#M=SgF=eW)J4CtMy1?)9U;UcLj1ii*qh7L&XO|HaNjAxNiwxdH+wD7U;!lS&L zXn&q(s5P+ERjaPLiYyqbR_*s=nL(jxs@I#i76Abo74>ON<(LM+?~8=$iVft_`;)A~ z&oc$Q$e@BPCB>O~_C7$RWrd9AfydBcHG5WSKJTp%OwGMLcV1pD@Xo>Gt3QP77~TtN z#x$y{L0;G5om4@Wuy!~~kESZSBn>gr^&=kJH6FlNRc~;K$nx2~=`!{4e%0+jqbmBIB{+@do%fEl4|ySD#!0sQuE>BY!1~dp;Zp z-OW_q8dCd(SxTL;(iDlBjI3W^r@!Wr3i_~12vwTD{}*3MCaQO#cQcQ7ZT*T#X;=3@ z)G+<$=5Q@5HI}*Z;19mUH_DyjV3vn=$|CrLHP4 z2~qM3g633z7 zZpZxNhasJ4k6uud8m0Xccjg=(EAeZaGj8d%i~idC&@u%N<3qyL(%yV$e@(%&ox_p( z=7>k!uRYydbK~DNT2Yol_fhn7YOTX<((ncZ=<#kI9Gh1UU}`=a4K zt@t8C(D9b}rIJY-P&YiS7P;`2`J<94CFY%5C#;{Ln4i%Kxxp>1WL_D;O9~r{xx>w@ zWX{Izbf#6{#!b*`3%?^H8}5oerBrIlJU8fgV^{mXuPWv!Ov?adeO zbK^JbrS!Q8U8Kos6p$JPeuJAMkW$K6YGrK+Q&^mtT2f23CPhyza;#F=;sY1%gh*-T z(yNTt2s?7ANU!(U`b`;ka7H%}>Ug*JePwy1lVkmdv&m>1jf%A3J9div`r7%rQgvRf zW(5y+$Bwh%**BdB^bW3O)Gkh@_m%s5YI_F{=z0fh5WUA5E}pBXCi{8^SLu1L=-kM< z3p!L>y9oBy_FkzQf89-Z;A$u6PwOi$oL%rne(sa3z)!=k+?K(a%h;oX?9e5e$uw_k z$IY}{H?*xCx5w0xV;FkJP7s({`_q;3x|{XYlw46)t7ol|Oj{9_TP}11D#`ZHUN);M zsP)kD&ft5~S1`Ue&~Q6g*IMmj5bb>>FIUccMX&a3GA=)^*51e4(nhOd3n&~oj(k%l zrZczpC&i?p^5~(IzH-#Z`dT@!3*Oq?Y$v-^M+@&UhtqwYkdfEj*0DvKSz$rBpc~xbN@jMmdQXD2V~RYZ)=yk0i=Is3YwYVw%XgCT zB9*H5)I%M0dlZGu&`ilzwY4*gwQ@Ro-rAYf_;M8IedW;*sXn*73`J0bde54$8IG_S zCg@znAHpSn#gXh>mU(6FLEnkwQSZAz`HZ`7gmQiHET{I?_}uB;;HR~@S~kwLP#OQ5 zDzKi|n@O$;#WCleo>HRZ#E)|xV9bY{M=t6GwSQ?A$0g4VQ`3c~(e)RJ!zE|N98YxF zEnW)l=JNXQvRJv4_D zPBwcwep7lu^kqkT*yION*~p1`@BB&e9A}-7d{b{lNkhCay1La-aQn#(ai!b}iQv>$ zxrn`8zQl%o?=_q!lv*!wt-0_>fJtk?6K2?i3Xprz%L6py@RwkCvG>}#k?lqMd#hn} zGroJC-vj06G-yz4ZY_A+*=^WIT|7AJLG`9yS2J-5haeBt4`8ik8 znv_%rXU5Iw8bOwDepK!_IFfqLI2;6|fpO*&piXu^?Hav zDB@3o)bj2#3Lb6gcg@9Ng)u6)laBmp=v0ASq~X$0q~3!Ov$#&58UrV!(tAnDxba+= zDxU>gYUNf_;U|1CJR#w#OJNaHc)`lHXwDd^9q^sv^z+o9D zk?N1DUlhMUyS_fGi58#h6PdU&CLhq3IZH_s`{>ITW>6qjWdZYW_ zEe%ME1^rssb;XqQl=a(A7%GMe{4Ow-_v{n2-Y|Z(2pbDvihnYs`+DYn=)L9Ow%A*_ zbqlefZBxKv>Z_Vv;X6?1EflF4wvHy_9LLvtI=eP{aNL zpxeRWK1FQeOJ&Aonm6P7>_$^SKK;2e;{;);QZQQEtU8gi4u<0nw2A_Fr3x0dQxQ%K z|Heh0vn4GtyQFn-1S6zvMKp4cUFd%Mhw`Y6G9aDwL9DFvkW7!tTcb01?{!4uOHBRl zIkqi@-7u27JQwgj6|JD9C7G>OvJ3WFmyyo*<^_)-Mijfi-X#d}MLfm$y&(D%nkkA*=R)pgG$j(J*%jDJzOYAqgXDALSbHO(JjI1rumgbat#d!@EPsBjg} ziA?bLzR>%pxyE;b3Z;(E=sSyy>7yAVz17*epHkZJ{LmlGV?9x^6h(15zcS04U+xZ1 zGd7%p@n!WB9SaAm%Ze$bH!v5Y=Sv}n<}PLu+he{2h3BdcM!LDvUAmh$7({I%KQOa_ z|G^PMwso~7RtL5oz{m77lPpdL-Tsj7%(N2`~bpA!TFvi{+Y z9|m8hDtLm$Upk4jM6}M2`cOOCbqy{m*Gm{g+bga%fAb3UOn_RD>rFZDA$_$`l<9W( zXl5y5hC3H9e{^)LrOq$=*e4R>xn?w( z%`iB+WeJ`UAeAP&$XehW{vNR3+PHZ2tO!fK_ts(-7djTWZASNd*dhz2fCI`2w(Mqw z6Qa=c^|3aX6U)PplaoKS%x$>oiw_vms8{$Qh5x12t+ana@w z{^V{zCEQH?K)D!qy+3D<>n^JE@6H%SNfFbwsAqLo@plP+PF2#By!97QrR6M7UBb4| z4XN-=SS?cXA4=k%D6>@IEdZtHwP)QTI}V`j6YPvyk7^-V@uf5UPd*d=aK%H&0nH=- zn=6LjD;8)Yrt~OmCHDW3qj2Jla_Ibv?q5Eh7_Q-bO_R?(VQ49Hiofix?D8%YBO_!) z*6i;$e}cVOacf)mPyXdILLVII4}QDyH3+g}Qpa4*Ounv1(CBI!N8fR?+mB2Y`b30a z3}W=luKJ(5d;UKc`=W*f-M4DqTum>_4QdNFMY&bFmy6A-3dI!b_RJ$<@FM-)AshXB zI~lYpFA9QC23|IV|Gn7_HqI;9_}uC1jENe{+X<-o^|J$bZfN?u8Qg~Z@K(3CtKK_} z^)lhrqT2>r%;D9N$g$aN<9r1BWViQi#cfCgzh(&~plIQWTBcrhp|;lRXMc7u1VJ`< zm+ib-FLh0tqFBo*0bOMO?Cl-)YwcQpP3CUK1ynRfQUzx0bUDeGk5e~!Q2jDP5*3*l zHymTK^lmNPxm+6SZN&>JYdvLr!v$$Aq^9253opTBNIRodg%_L83TDnak8H#HGDD%k z8~^$>Q^!>4NbiQto!@47xu-ARRsz4esxWeL!yrQq$Ie~*G`O-p0PGgTw@k5&CWVoD z1wM`?AK*2#vf&Iedd8c&RL;p+by*2(KH(r4NHON;IzBHC(g^75?Wk)zg1MoDX;+Hb z@W?&=^@?NN@>__U=gGH{_+-p}Fy4~?ph1-uc!QqV?E1>IW^C%-nL+ah)aANfgfu4& zv#{1HAe7oe(Loq!%a%tzSd5eTF|3U`K(Lv#G16~a(HOfI)gQkaI8Sh=^N%W-qtp$1 zN)-<=?uhnsKQ&5_Yj3sM2VL}isJ5~z=+Er{d}&9-ft}SqpK(MAb@#o0W_JVuLGSs@ zIRTKwQ=k%^-W-IIPuXA%k&o|VcwCI4x)S&IuONoV5Rw8@cZ zkRZIpoYl}Yg|1;at%ogswcm@n%`?ulW#X{Q^HASRcwc`IECq_Y&zVJN>!W@6rf-!J zm(5zOjtg=37qtrQLx%fft4Ieg=f1&TJA1+I-oqO~U}_N&;_ELcRX>0|gkOcFcdmLk zat(I-f^o%Y^!1AcE{bng9ovE(@n;}uU=9CH51svP9D|XM*Y)mXn)_%-3GG?x7og-z zokcm(%D@}KSAeDFH?IP(OQ1Rtp}Y^RHoaXd^?d))Qk(Zm*^gSnoehzUOB3YMJ3y13 z2exqK838Q4ic)yHlYipZTJ4*7I&S(^A^yv=hYB4!2i}Iu1uUM+hFGGh%TLGSecZrG zgm=W^e~JzHkEi1+%~XWO&b7o#$VzMB z9Xox=5){IJ?vLGc_(y#sBB4`wtRFkT&QT%4A<5)nQ>(JGyb@w#C`x(+E* zW(e+cLivyCZK#>14-4K$_B6@+C(b^rWy)bGq+VbY)fl~s%H-;T{@HQ4LfSc^(>aLI zKCvHha6cAvK+4C^62m~7(H-1aT?&TKKnW!h=wz1+T1}C`oRNRu`DcF)6g;@-p{tI( zpi&~K*I7Fgq?Fk5`K#_;=cOg=;}8qLfXIDzgoAx6%eSNMRHk*{tHf#;)(|=ya7K8) zcDuE8F@4zJR8@2#x5uW+YnkhO+axe%WAgQ&`G?B#lZHLZ1{)1S#^@EsS&rrop?(Re zZke=)XZ7n0(Zp@eEaZg@o)sllJ7^KL#zfX${VLP4^;`pbK2@F=-xYz1{-E@>@IQqc z{8t}51_BHMLnfl;PzyhBCTA5_UVywsl0p>eMuUijoNS97&Yjqg*K0*f{*jAOF5LQ= zr&mJCLp+#RuN;5?f~#lpdYjVyk5|VJ>kgmVaWMFw{)q2THfWZ6G_F5=G|9gxG&S^B zEJscf<*Jn6$4d8&&YqBY?hL)T;TNS(yxiZi6tn!T`%-65-FA2)L01_3xzo^zsd0J( zSlLee0>lW3*uKZnz1eK{Xh;3joSs(nv$~g%s#g7MxZ&lFdn8s@rR$#oFfygBvV<}N zR63ifyZ$O3xDWNu7@8X(D%?)WFdrA@-#qKQ{?1TYp;1s|`|kENMs@jmnIf%nf<53r zjGf`kX1(*rHL1B`8Hji&=_6`^x<2(HFy=nkV5YNVw!-$8WU6NOp?XW#V`i%j8mCs< z?=Czsgugq`_RzYS+fgCfu~I4Z&I*TCqi(gI%3qT4Kg$UfUWV}>))*R$q`5o5HCiM#7Aj`L?sHlKyM1aF*Ln8?mYJcOGwZ!Io7b&wGTGXMY# z;_B1!fQ8}zt8QzLO8SoCZLV3G>4vXH=FE;}mRh8i7%r{hW9G6H6fniq%*0xN=Cjn) zGAT1(Lywiu`GC*}CZQQlEj5jfKu%!lL^+`N$X9~x2kwuZ&e{L>`@Q%4e&74K=X3A< zP!Y%HXqf13J!?9!#0ev#?r`W8)YsIuJs1@oGd>TG^DPcZyA(r4wIv6%x_mhm?p(c4 zJ5->sOQ|~fI>v=>*vNXMPV$#i&+7P~z$52d|RQZ^X6yiQDT^7bod-FxtB8Oek zqQv81S;-d8r1r?rr zxM}Y7l~=LS%-s5UD6vMSVC^XnWT#FxLAAf2gASt}B?KSisPqpr9L0q&FyY)XLi*Th z(AY!nkes&0!@mWFmS16XsKx3sf%D?W$MnSWHHE>k^3(A%kCL z*VN0jq)K~z(p*bC!XimfBh>84$aufp6bzq?s##F52uCuIn_scSZe_>ND^7m}-ivXU zBff?dhU*SN(CdRF`7=qoH^Mcz@PH{+oKMP`Fo!+6xbQ^z7R+5^wUBeS(kc>BDN1sK zOKovHiLEp6jVD#?xTTSdbGTKeIXxa z9WJCCdTqs-l-SyP7N@TA@V%Asd2!_FOo8j(?fVU|RNGkRiM;YG*`+ojywxcZRw;^8 zcq7DZO*$ozrIyefVc99>>aX~euO{m(aRs~HSozrwc*voOSia*REGuxT>44#k2>@OI zMl>01r4{zai-NQ1F^U|%@ZRE$QTddfRLRU+zRjrC)q&7*x6|I=IlrKsx?p_OJ12JM zl|?w$h)}|I#9V$~nt@6*7nYvt<^86YF+Y9oW5ekn=g#dr$t2b~Ci3?v1_ZYIe0)x{qJ9WYpNMMNOoe(7|) z_;mKGKh0+V$=HaovI)v1p(>w8CxNi`UIzd=S=eo?7^+d^rz#aqb$8NsA!0xbK^{$wW!E0!6EXr_M&jLAN7tz z79VVsRpEy*&ef=_xIo9cnAt8b>yhBid4T3q_PV)z0-R=?pRuGjvzMRyOK-doN z@j#iGe*7@OXGG$PwCjvi7Y_ll$hx!HTC+$;@X4uGm!nO*0~SRZHiKkjB3spFp~7#m zQuQj|b%IP?FxX3~Y$MJ#upe6YithtTVVNeoZ}ms*A}_fqX0Z>$#&5+~{0F6JQf9w& zaJt(>OYgHor6t#(D<0j39(rInT5F;2rDnW?gxHHe47)skK9>&S-Y|FF7n}I02-_1j z0Gf1pbFFNR`Sn=vUX0}i&P&FexLXd*b;0Jg)8(sU=w@+gU#X5K|waporsW5985W-7PXiZ0~`#H*YuF8BOw)o1Y367+To0y9su3$9q#hp<rgk8K7{K3 hxp2QBcG>%rn*T2u6!*~de*kadYUKa` literal 0 HcmV?d00001 diff --git a/assets/image-for-docs/discussion.PNG b/assets/image-for-docs/discussion.PNG new file mode 100644 index 0000000000000000000000000000000000000000..fd1f00c51368644b9ca400edfdf21b33578ced77 GIT binary patch literal 1617 zcmV-X2Cn&uP)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>D1?EXaK~#8N?VM{& zmSq^nYwJUP?MqueQC9ISRb0J)@dtqnbov1QxGy4b0wMODJO;@ z0}q59PyrEx5J6B*B4-dm&Ij+_-_>sRyzhJSIvy6UVF*L}fwxasCw zW*L=gvQltVzNFx&d`ZDk`I3U8@}-F2+_8AJx&On*&Ag3InfXait7fq9F}}vH4d*Z3UY!+?toD{lm_|RIwu% zfQ3*#tir${!*&g%iao(XC?8e|j%q?FI4WOKa8$me;HZ3Q+QC_#@tNrz>NBI)#>~#5 zeL;1}$G4i{(P5KXav-Su|JEzJ-!?5hZ6dy3btq20&n(Y&wx4dzO?<-qRh?%Vt~8mq zep%scGu?_BI9wflmxBy(qkxli?0YjXGH8y~6gb;Yw-$Z(yeV(3GFJwA%*w1Uoo%LD zQ3D47NnYJ4*-_NpDB!r-sDc$Wa4vMznxcjhGdMCNJDj>uZ~!X3?2zdj>X!(`=bqwU zWe3(>Zjgxe`o87THm54rTnl`qmSo8Nrra$uw!Qc2U?)rD^Z&90$j) z<3w$tv|oKVUg{X1FV_C-kFU!5wx8N-y864NoUsm791ZJ__?|NAxZiwYTTs8#4gW+e zKi^&>cEf($e-QXQ*LJ~-j*X7n23y%pXxksG$dNj`?xlO*m-?wHYT)o-@1=h#Mr!D4 zG|z2c8V1h((kw9yfPImjC=bpNlJLi70mVAPg2YwUd`|k3pY#v+o6nCV1kI0OEi{D} zi)E~e*7IUm7dQYyZo!(r&HG8}n1gme$vD(+$=_kpN;AcI-u`x8FF5b+|5%^r@t2*oZsBjD)$*@kI0y;fwkC;LVKR6K42F%QAuN&++#Pprl}~Z;BZfZ z3>;bIzl|Fla9-T`h8XA4m1cp8wiwgq9ypwc0w60g*GTjs53tT>H)2d2@11|yfmNnw z@T#fqs1x8QBWltAdf*TZ79>9-dMOaKDDMpPdnfIqpgAT3&YJA61!mSVQ91p+;1G4k z0+0ZW9iQhS2Vw)!hxXV9J5f(=MC7q{pQ@q`4iAaLac26NgX7@XcCHI2;9wkG)m|;| zHFdX`9Yv`!PD=hx0l~Gq*nLBzLqSfpW4XYg{;Ql#rmeR_c5MIffZ1D;E{mm{tR z4)@y%_lTpp_yo#G1Tyu z=tmf5hgJrni#OC4)Soupfw8=XwX!=8;A}o%ck4vpSgk(1!L(j&m;OJT{8`pVbO_BG zES&b3LHTt>Va{g$q}&vFcJDZ@axVyxB948om;eWHRI#JEY>vau0wi(~ez$@{iZ7iJ zBT>J#V3!#g8xaw8Fc^lzu`Y)qA{@sQ`M~kolj2CZ56t5NhkF2EZq`uSc~Qm(qN9O` zh668lT?)!^EWkV`c?xA58x|ba&vUHJ`9_Xk)`}RzRUQhC%?-H+9@fSY#WUI8jl~Q& zOHy7Cr+C4k40td)7tTG~@?T;~y>$>f&B8>^!{y!Wq2ebJ=CVgmcIBTENnGHN<8YMX z6xuT%#|h(*>(CdFxL7BUP)Af?Z2B~IH%mfo!FerpndENN@x|O6hZB`EUML7Fv(}oL z&ibHr@e`hnqB9O0)y$BBqw*yMN99Wjj>?x59F;Fk3LO1obrqWQAFK091g}Q822;h3 zCjEMhzL2LvlYSu&L7Kh-9J})M3NW(&bl{;)OU#^vg_`rkfbNNV#LU^SP<)Q>ef`q` zD?$~6kR*{|t7fk7F}{v;Jb4un9F=M!DL5)$QgBqhq~NH0Nx@P1&@A&Wf@GrD`kseU P00000NkvXXu0mjf&hQfU literal 0 HcmV?d00001 diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md new file mode 100644 index 000000000..ccd66431a --- /dev/null +++ b/docs/how-to-create-new-repository.md @@ -0,0 +1,36 @@ +# How to create new repository + +This is not about creating a repository on Github, so you will not be reading about that, but you can check [here](https://docs.github.com/en/get-started/quickstart/create-a-repo) + +This docs is about creating a new project in [asyncapi](https://www.asyncapi.com/), it is the guide to how you can create a repository in [asyncapi organisation on Github](https://github.com/asyncapi), who you need to talk, and how you should configure the repository. + +This docs is also helpful if you are donating a project to [asyncapi](https://www.asyncapi.com/), which involves transfering a repository into [asyncapi organization](https://github.com/asyncapi) and become an onwer of that project. + +----------------------------- +## Creating a Repo for new project in Asyncapi + +1. Visit [asyncapi initaitive on Github](https://github.com/asyncapi) click on `Discussion tab` to start new discussion. + +![alt text](../assets/image-for-docs/discussion.PNG "New Disccusion on Github") + +2. Click on `New discussion`, select `Category` add a `title`, ping [Lukasz Gornick](https://github.com/derberg) or [Fran Méndez](https://github.com/fmvilas) in your discussion about the new project. + + +![alt text](../assets/image-for-docs/Github-discussion.jpg "Start a new discussion") + +### Note: +There are 9 categories to every dicussion that been discuss here on asyncapi organization, each of these ctategories represent what you are proposing to the technical steering commitee. + +3. After starting a discussion about your new project for asyncapi, and successfully convienced other members of the community why your project ideas is necessary and you want to maintain the codebase. + + + + + +----------------------------- + + + +## Configuring the repo + +## Donating a project to asyncapi From efb51ec3be5fec28bb2ae6bacd9bbc8c62ede687 Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Tue, 6 Sep 2022 10:09:16 +0100 Subject: [PATCH 09/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index ccd66431a..f37577808 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -1,6 +1,6 @@ # How to create new repository -This is not about creating a repository on Github, so you will not be reading about that, but you can check [here](https://docs.github.com/en/get-started/quickstart/create-a-repo) +This document is not about creating a repository on GitHub. If this is what you were looking for, then [read GitHub guides on repository creation](https://docs.github.com/en/get-started/quickstart/create-a-repo). This docs is about creating a new project in [asyncapi](https://www.asyncapi.com/), it is the guide to how you can create a repository in [asyncapi organisation on Github](https://github.com/asyncapi), who you need to talk, and how you should configure the repository. From c31564eb0284c9c2d7362d22203dd4ff9bbf69ba Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Tue, 6 Sep 2022 10:10:24 +0100 Subject: [PATCH 10/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index f37577808..a86288eab 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -2,7 +2,7 @@ This document is not about creating a repository on GitHub. If this is what you were looking for, then [read GitHub guides on repository creation](https://docs.github.com/en/get-started/quickstart/create-a-repo). -This docs is about creating a new project in [asyncapi](https://www.asyncapi.com/), it is the guide to how you can create a repository in [asyncapi organisation on Github](https://github.com/asyncapi), who you need to talk, and how you should configure the repository. +This document is about creating a new repository at [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). This guide explains what is the approval process and default repository configuration options. This docs is also helpful if you are donating a project to [asyncapi](https://www.asyncapi.com/), which involves transfering a repository into [asyncapi organization](https://github.com/asyncapi) and become an onwer of that project. From aea65f8be0e760b054b65b92fdf1f08c131016a8 Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Tue, 6 Sep 2022 10:10:33 +0100 Subject: [PATCH 11/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index a86288eab..2fcbd3968 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -4,7 +4,7 @@ This document is not about creating a repository on GitHub. If this is what you This document is about creating a new repository at [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). This guide explains what is the approval process and default repository configuration options. -This docs is also helpful if you are donating a project to [asyncapi](https://www.asyncapi.com/), which involves transfering a repository into [asyncapi organization](https://github.com/asyncapi) and become an onwer of that project. +This document is also helpful if you are donating a project to AsyncAPI Initiative, which involves transferring repository ownership, but still becoming its maintainer. ----------------------------- ## Creating a Repo for new project in Asyncapi From 05df504dbb636c8211257b2276e8b61bb43c54cb Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Tue, 6 Sep 2022 10:10:40 +0100 Subject: [PATCH 12/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 2fcbd3968..06df8d30e 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -6,7 +6,6 @@ This document is about creating a new repository at [AsyncAPI Initiative GitHub This document is also helpful if you are donating a project to AsyncAPI Initiative, which involves transferring repository ownership, but still becoming its maintainer. ------------------------------ ## Creating a Repo for new project in Asyncapi 1. Visit [asyncapi initaitive on Github](https://github.com/asyncapi) click on `Discussion tab` to start new discussion. From 4a387420e21938a72e94ce5e8406995ab9de2b26 Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Tue, 6 Sep 2022 10:10:47 +0100 Subject: [PATCH 13/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 06df8d30e..cbf075d23 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -6,7 +6,7 @@ This document is about creating a new repository at [AsyncAPI Initiative GitHub This document is also helpful if you are donating a project to AsyncAPI Initiative, which involves transferring repository ownership, but still becoming its maintainer. -## Creating a Repo for new project in Asyncapi +## Creating a repo for a new project 1. Visit [asyncapi initaitive on Github](https://github.com/asyncapi) click on `Discussion tab` to start new discussion. From f308f42c3aa2dfd8c72a707144677521511f726a Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Tue, 6 Sep 2022 10:11:11 +0100 Subject: [PATCH 14/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index cbf075d23..fb69f8e4b 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -8,7 +8,7 @@ This document is also helpful if you are donating a project to AsyncAPI Initiati ## Creating a repo for a new project -1. Visit [asyncapi initaitive on Github](https://github.com/asyncapi) click on `Discussion tab` to start new discussion. +1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions) ![alt text](../assets/image-for-docs/discussion.PNG "New Disccusion on Github") From 0e3dd8d05f555a966e197fe44a226d1618ef775c Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Tue, 6 Sep 2022 10:12:20 +0100 Subject: [PATCH 15/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index fb69f8e4b..be6a6f52c 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -12,7 +12,9 @@ This document is also helpful if you are donating a project to AsyncAPI Initiati ![alt text](../assets/image-for-docs/discussion.PNG "New Disccusion on Github") -2. Click on `New discussion`, select `Category` add a `title`, ping [Lukasz Gornick](https://github.com/derberg) or [Fran Méndez](https://github.com/fmvilas) in your discussion about the new project. +2. Start a new discussion by clicking on `New discussion` and selecting the `Idea` category. + + Specify in the title that you want to create a new repository. In the description specify what is the purpose of the new repository, and why it should be created under the AsyncAPI organization. See also [example discussion from the past](https://github.com/orgs/asyncapi/discussions/300). ![alt text](../assets/image-for-docs/Github-discussion.jpg "Start a new discussion") From d3da9a98c140559534b761f1157c6f8cdeb33066 Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Tue, 6 Sep 2022 10:12:37 +0100 Subject: [PATCH 16/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index be6a6f52c..e271b62a3 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -22,7 +22,9 @@ This document is also helpful if you are donating a project to AsyncAPI Initiati ### Note: There are 9 categories to every dicussion that been discuss here on asyncapi organization, each of these ctategories represent what you are proposing to the technical steering commitee. -3. After starting a discussion about your new project for asyncapi, and successfully convienced other members of the community why your project ideas is necessary and you want to maintain the codebase. +3. Additionally specify the initial maintainers of the project. At least 2 are needed to start + +4. Your proposal for a new repository must be approved by Technical Steering Committee (TSC). So make sure that at the end of proposal description you mention @asyncapi/tsc_members GitHub team to get TSC members notified. From 6e2ca988408909889401b73b3c001aed4db50790 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Tue, 6 Sep 2022 13:44:27 +0100 Subject: [PATCH 17/43] Removing screentshot and note --- assets/image-for-docs/Github-discussion.jpg | Bin 20359 -> 0 bytes assets/image-for-docs/discussion.PNG | Bin 1617 -> 0 bytes docs/how-to-create-new-repository.md | 6 ------ 3 files changed, 6 deletions(-) delete mode 100644 assets/image-for-docs/Github-discussion.jpg delete mode 100644 assets/image-for-docs/discussion.PNG diff --git a/assets/image-for-docs/Github-discussion.jpg b/assets/image-for-docs/Github-discussion.jpg deleted file mode 100644 index 8527a8b8bfd25e6abfe67b09961a0809b0a3f6ee..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 20359 zcmeFZc|6-&+c%olE*(tWZ4Fgad$-z}YO7FFik9vwI+~|aQUq0!n1WUf-KI{48fz=nW`OF!V++EE-@vBUrT_pc z{lMnEJ;LXG53f3g005GmJAb=+gWlf<0Bn!_dD-+%nA;LHvR>mZLX|feI-H+)^vD%c z+e??ex8GFiv)cRTaf|dYYTy)kJiQEEJU2fnuV1ru^;3DjnmhfMCzz0%bH1fD66bxllq%EF%OLIo05UxXrLh+U-SOCAf$f&MF+bVV!Pkh- zrjHzQZ`IDfGntm^;gmFhFXRuVRt0b&dZm^*Gh1Wqh2^?y4Bz;lQcwgdnGQLi&+-oy?c>U_95sTKXa+PJ93=CL#uwIj=Rzc-4Wgb00O z9dT8va{~CFr=E<83;^JuA*@7MRwQ(7E%q)X?D6qrpVv7nm61Dw_E)k=Hxfieprh9( zirkF~3x4(l`1-HQf6TW{C5F$ng^ZZ6+BA$;i@yOuo7X0ss&pigr)*2q*u2tl`uF5v z38~HFh;8~3IJQtQBsH9`?AoQ1pU-Xk`88yuf%Y>vqVyuMQG?%BG5qI9K?a0Kn7Yg$ z7jEhsuaQGWqKi4`Qs=_J%)$+IJ)i4S zIHYA;;%|!_oUNCpEG60?=u~c4#I)+h(xTQV0>RiIN2He9R<|HS0?Rpt;k<95LpS4~ zGW$pBGD-Bd5jsII9ls_}Wm(g`83Ux{kP#}#ck#`mrLkW2=w)Mqk>E}Y)b;CAQ(Cml<-pzW-a1;Fwjz-XD-2n- zwhf)yWgtsAX6Ul6wd}`RiC_DY1~aY-8Opx`0vmO1eHy%IMkrlc7*v*IZdM~RbWLS$5z=!UnEhaDZN?n zyzJOkLXi>xz`cCn>3H8hlC|Vyj9WaJ5NMkS_1WfL-25IoOhK0>E6F9s_Xbj&vhvr^ zuPhm)d(*0*t8n)^W5vjy$1g9fr&SD7$=KtVk9TDf{6G;GT-VYDW@b@>;5fnL`TbNv z8DA@aiQ4RAR9Pq+zxYcYH1@uHMi~Ac|^a5fC*!P+gcDVw*HyGO?@g4?L!tW zC~UNm`nG8^tfM`|qj`P^fca@b>k086yY8_}igoZ8UJpo{@W=2yvsE|r z`RKV4&>^fw00Qo7x7r@M1g}F7bnqD%__PE{@;U`)AQ^8vX(awGBlv3h?w|4bXh?Hl z=z$+0G>UFsN2@xO_B5-Er5Ixu#7=MlZLFL*oVtDXxgz0xfqYuChOrDI!QH4pb8!mY z^1;ts=01HNid|SNGUDwRyS0U&9Kev%G&H))gQ!kCJf>wkY>rA|v4eF;Y`>Fs9 zd+%Oqt>jBRc2b(GU@Ya88ZnaX8a31l*VBX=W4`E0{CJOvs(Z%rmYb3RrLOou{4+0P zSk&fe%O<1qHv3RjV6_98$2|1{Y%%CG-!oJ7;89|C;<#sIGM@bg9e=;$LGMhbeB(+8 zD(&(>XEML#KI9c$?Q7y7KS0NpFZ!C141HaJ)@Bz)+uJ5(8&$Mr3>Xs-T+- ztO%1^Y^h-Zm5!qatdB|?x_?o}gcJqDI|!E*1PNjdu5CnCJ3A#Q>R)u_Q-kO6V2)41 zv%2#3^DZ(3`>AHHNP~rUUZQmsBWC!&634xUGiZTnv+-+PBA7A4S*45Or<1Egbj_Ki zD=-2PkHgH%C{95Rx=U!r zhoyp}o^>Hc9N2UVNT`dAs?N%K?gEUD&mBOOEnS1tfE$`!B38N20^<9J*wNqGiFFwj zM?Kl{xMdxT>YZKi&|LPlgmG@&^Fu+*3!U?s-`oZI)a~}KO#_=z7rrf#EtM5bqzpG+ z7~R$_(!cZVy|J33FNYvJMJ~zwu;|c=af7C%>-QDV5Zocg1U-127DV`tj6$&LAfxhAsv9XtbBq9>Z; zCoCwcWo!KH9CxKrNvnKfyppnM?(ysN(K2bcXkUadTH2~K;=ols6az&!?8JX4dUzY z-gb5C{h$~3AW#Drc8;2#KV#H|=9N|$wE1wuw_t?5s0=TV(;k|yz%jCD{~$G;cJS9S z6IJ0R#1}lH=AoAw^{Cra1vGuxxfgkU2*U9m52P|NKq!N_$FYT0m3a<&k}V|KBtot^7Gj1&aq zpPG7MVB+RGTIz1H1N`2`luntL%<6A@(u)^R%Cjt<%SQMpMlB!yXd_~RwU!NCTKi0x zk$g-UCK5FU^VtsJbDtAOuH0>%g#}vKo7|{!Z){U;Uiv%qmfia1Qh}mpr||529r)8? z)5RNlm;RGaL+HCY{$zUpTI+$~Q{(%DxZ3VNSp#YRC2Qb++no4s4OB)VC&9STZm8aY z9rL6z#(ue_2?$T3Zolmu&Yg;iGT>Fk6r^4JcHcoKSfZyvj&y&)DZlp{crqJ3#YHak zBew~mT)jg8!1*#c^Iivop3xE%_u55PXV#$JAuOo^IQID4k7C>FNYL7+&~}BX*KY71 z3ik%Obmd6X2gh{fNj@&cCH|Q2cab1qD?81-3_iIU#lsV}tPBK2+c!5meggpdJjE5g z7UXXCjvMrhm!Q_KB^}3lB&9yDnf)~L*S+1uiOk|OBywoD!TI-X?FfnlsH$!2oZ?!U z@^vk0ByKuFXni@R6nUvDdM$R0^W2jeRj=Qu00T)z)7hZ231SXfY5F|dx#kA_KzP!& zOsgPd`)1f4KrHpJ*P@(ruUw>VkVb*Lr&j{wt45HfsIdIh4cB6Je@{Z1*!1GzDcJ0)+V_rRsgT_~UtJa>p)Wa-+qJlZI<&Qy9Q_nWlF@D17|M9-?+n z8VcsSaV=Zkb0*)zs%RH6x6#gu^sqWyy0spXLyzXyBQH-_v9e`+B^mqGelGJgb<1kKa-ux)-)6dErK3&UfT}?0N{&W znc)H-LyL-+Sw=Hp4g!XfNp(x0tpl!7ws0?2{>F5$;%Q3|9u?rQLmI^ty5IvVi zp1e5O)^`rQ7wE=6@aG;1{-DN~hHo$=+k|>(g!Yae&3j;gY;2*~{n6#d{d_LUW~Jly zG~0Iv9{{V3HM=ZgTY0?Pk+}3IRqFZ|y%Al#$sEm%F5QJ5$~F+Od0X!==5ziJaF8t~ z=3CoZ6M^RHG9|lWVY6}!a<(2OAjNDxXbt>O;QMs^ZuT<-Rem9^u;oPl&t|T{E72mD z^uyj+Gj#wU@^4{R(LbJ84bx%-s8BX-@>QA<_uaHXU0yAx-e7a8mN7NG+LlC#qf4Mn zlU$Gel6a5O5l=4}Zl)pY&vnq+0|QQdT{7co$l&(XX2uqhSl93^h!uHWF#CaJ1xEZp zGAL;?+?k$uWo&Kr`pb0p+av|=6%JCX$@2~ktuv@FwqAnVGM@+^QG^_$wSu@naZ-#H1rwAP{21pLWgOJ;uuT zb`*;iQyd7dGg{9PxPjnF0$fbk%5viPNv*4T##=6mA3u)Jcuo;DhdeQPaC;sRB#5XP z)QWMf3bBgdKO{dZ{K;Pnt5e?`d9`qxbu@5&%6XVn=M6%vCdVPFiy9*gW10g9;7Du!PmSJfN8U$Sl4^5$oQ>?0h{Y|6E|F3aLcRU4{5#=D(L<14;tX$_6EWA zgV2QzdXEaX64|A`6tch?^v#s&TmT_7@^vRlU(o)_OB{!no%Gsx(F-LOhIVupUfuqI zL*UM2W}qEYw&KS@R+RnFrdc^aY@6eNbR@4y*^Ml%prY+_!zQ-I&qq98#!~leyg5$H2TrQYakFxGm>yttc=DNfYbv)R%%_*^ZpA9 z=b{9OVw!_QU(g}`f@(SI+GlByz+yhU^Axln8g=;_1VrAbnK| zA++Q;_Si1qnr4?wprO(ZFq(fcwjafcpfxS@4^8|C=qv8tc%i&7zt}0 ziav$%85;kRs>L7iFbA14<9)5r#{dA{g9bC^AYtj6C5}U|H|esdX%Pgmkl<@Gj$>-b zR+J=qMSS51X;ME&J{3B>L9D38euy?{*oU&7Z{b@>k?yS_=$m&1FO0Rl6bQ9#Arwcb zVqw$lUqO}OA0f>prAD$)RnLoiI?{^dvr)9pjViCT-ZEMbuAuXRHKX|&!;(f|jg(BU|n4iU2B+BI1Kn_o~j<}$kin=*7+#*ygbEG1sxt&Hb)*m;|xiXIOtgz zy*afOBj8ys;I@=O*D;7WFRSL%#vw^m2HZ7k8TrIN1kb_*V!b_qoF#jc9Hs57y;u>D zpbR{0&Ec}F3VC+i!5;T*PvIy1U2cIKQDLiOf1CXvykE^15kJ0KS4FMmLBT-S$XQvL zMKM4u$6xsVOYEZ!^21gQ?Nz&~8x-xADn$aew2iEw!)IBQ;CMFWMb-&3=3RT&jA(W) zZFGu9#4Ot-QRj)yNs5&UDo_^_-Ekn{W5VDgA#2OBQ`^zt%OUXPa224BS5PC=UT_^U zS#S)q*;DEF8)5I;l7P8`1hxf2Z+n0?rh}tsP26+|ax-JDI%VwO=<5zu(h8nHSo#6f z%Ej7X|6sOe?~1OE^^En~YYaj~Q}<6RcR^z4=U(K8pb*U}J!DwcG+q;1DOsb{^5cm# zHutFzNjNA}$a}gs5uz1lVAGs4CSt%ROogc*3H7WtK9Sa|V3I-fzPEz|DpSYAcl5jY zicJ^4g&R9@imOy`ydSk9Z-kAcs8`ni2l~^&ZGlD>qy*_}!>#LTnqmNejOu?v zfwZ-`8HV14b9;mUbNXnie?zDQ{TIg0hqpYJ%j4U#ci`z%{)d>-xzIH+yDm3MTm=|L#H(ugE z!g#A&!w1QIK_<(#BXfF+uOyAWCwXSajy?J^ce31nWuBLl;;&P^gT+_NNy@oGe2ipl z%Lrz{+a+x=xNvDjp@<#+4aRrCHTDA6?X0j_i^*#F$0}2oRHydI5U;t!1#1k399X#! zj5XivJ)?9rw!6Q4l z4%==q^9L8$>qh!9Nz~AG6<_u@%d*aN6BMjVJ7%Xz(c$kMpAudiv?2$Ww5+_Jp&vkL z(fAEe5vj1w+~FyHn`WzLpSe`|u96<%SS|^Zb5f}rO|C+ZM()(3k6)wdx6FmJ82@oXrzh7qx~)J*$!=ne^af)mKV3K14(u#-Ome|7C{pZLqv<7vuptu#I}@@=-%C9A2Z%|cm>v!?dmK%Z>Sn1g<~B&>po znRqm|_rkz6@z*Dxb{%hV-fA*rIdgy9{C$^Nn#RP7tX>pMq$Ex%w8MF=S2%!ft8J|hHmN=fCZ=h*7`&Y(+TEG|k0}@L1on@h0zjqbeO$(T>&R@#U4w*VU|9p4h03zAnpJ8B6DdUh_8=a>Fu5jjFr8UR+cgBQyPVeLQp9Tkh|)0-308zH4fdg z-Dx85V)t9!-Pd&L>hqd|GLOVfZ4SV%!NAhtYcFRib3Xiopaea zh^0Yo;EBuMAN!Z^(f4(^^1X71%v^e7RxRzlAr6)!KOU7Y?Y)t!-rZ1#CFtw@Em2q9 z%?n??;zCP4A|S7Y90S*v{L3to>W=>@^)^-3(~!{IBkreo&C3FIIM9&LDcSje0sMY5 zNwK9M`&kv{bD-sNCC<=Jr;CU=M1Ne{3~=tK*Tnny)qQaUtxrHGjzr0_IKi^fc2y^o z4XZcza|Mqj3^gD0bG|1Buyfng_^Tt>w_PTuBh;5t@)u90_N8*rK@~MonwsvJG_EC0 z7kTn&@Zqc#7L9QsIiKg4ylsSW*ZiHDe zo}T{ELmFP~o`_WeO67$+479OC2X6sfk9XNjxgFC%<8>6U!zw_{nisw*p=ZpN^`jEr zd&wEF9VeHY!(H<^7WhPd+EUKfsJH^}{Q5nYdi& zu@JrE7Vnd5=aWx=?T)~6QbI>4?NK&W5)WTA3CQ~J}Xb*@y!$mR##F2?^?PNM>F=!mAU~O z_N>7DjN`}W9LI$2A8qG`mmICpGPRO@E_F|s5AqlNeK$NW$DSS7)L0X>Mf_fLI_=&B zr`c&*SyYX)31jO_ZQfRG>uE~;a+H2P@OB!jSe=+0D?5u1*E9c*0gpa-!mOkn#5ZjV zN1O{+YQr9~6Z^*f#%0&sd!~cJA9S!H+9m}MUdrg|ln;>gIN(iR+)%S2YHXSvaaYr+ppTtSbu5 zJBYUP%ZzN$#au>y2N_?R=0U25!p+8(ADH=X5z_ZA2j^c7Pb%!4Pkvw(q88#}Tj!%D zdy;#wmt;iAbq56->&~V+z|UfA2x@5|MAqBc&DKV3a|rPE#Qq#kKja7mt6Ww0RN7g~ zy~}be|3{f_ajw=s^Qj^SSerFpv{CP1-PV z3s)*Yp|s&1oJ+~W?Hw$6v-ZIJx86YKOy_!)=x7VmHlCAHkcI}G)h(gm$%pJPn(Y%w zyOs+c87`Tf_yl}>u1#|tbR1Z_H~HY4oxz2<6Yqd@_D6iR(!dYkF1^aNkU>tvnh+%6 zs(S(0$*1E=zYAeCFR1t_H}$w#h!N|kPOA08RPxs|&Z+Fl$#Un2>PXvvb#b5X7-*0? zW)P_zV!7So)c+`{BIAI&5T%mv8jFykG^52;MLMtm;Yt>Cj^O3_9`%?k^sG& zTR0)Wg&Z!)tDl_Pk17#bn}7%ZFVR>%e%`$#<%p*{Lv3Gn9AKW=u`z0#clrcGnD0Q) zw|Wr@o_dN8uTDh$99j_iH7YSXsh|`1E2YU0`@X1=F0>G1)Tpa)XCrZFlP^NjNxgNx zB(jXQMFm~m#h?x^{P>wWB}uos+b@--E36`*7w3$d;R6Lts?gb4j44&c^X zqRhp+NvXbbR~Jg+gb4aA?gV2X#6K8m2Kg5|J5W>c{7&H`jzIk4XUBX6w5sgP?u){I|AC>_wY=ly2Arqz z_MsxnWO1PqW=vC7leR0Y16^-_&v8hFB8!P8Frm}E>+>^SXdeBWaqp3=C32coS@i16 zLUyYaUTAaK5-pPye;b#rib$eHIvcQ_EG>*4kkJmKcA7z+X0mN2agC5FW_0dvFE{4P zv=OL-RlT$rK>J6cNmrT(vpjJ;8=A7~x-nm$#e5}=oqjq#_IF{=TDOG|;a&n&1tbNC zjo+0-@yon~S~>fL;5#?;hJU!YU(od|iBwU8d})QaxA@cOfO>|*nN8w71LyT@NUW}W zeX&5V^tROJ#Uykpm!$MuYT{ybB=Q^g5X1KA+MsrQT7$27+u)|D$1>3RH8?;Ht;ai; zna|7A&muQhd3~j~z?^!*(0MtxSw?$6gnAk=xZIUxYnN zO--3Q@*RqPM31R%wmpWf3sp)KJpA&$u-3ovLmiv&0age^$R^Osefc$M+|?DB4l-*{ zcgR>ac>%ewNKdwgwxr@;l?Jm%8&tU@`Q7f-%c{ zG&KDPz=1^6?6MIZACo|Fs=5Z=mdi6!vM}4`xEO=^=ik=Jm#QU!s zYH_tWL8Pu!;?=jmN9G~~pF2EU-M0|lNWUATD4NOOa&sJzj;Aa^M4!wEG{;p_yX!v~ z*q8axPjD|fxhcaj?gvDEq{U5*EL1$(_0s`y-I2z+yQd<88iD<6%5Gfh>xo-30cAYaGzF613i=am?!&ev%{QM&~Hs5lnV9FA2om;nhn` z1mB97L?kvKXNa~`r~r7YMLgY=DO^ek0R43;!!gu z>AA$gE-?ai9O3E&v03sZEgh7r$zF)WUWJXX=r79=&mE`i@tzZ-+S>E^ ze<9`O%Q0uJ0Tk@ccJ;hHyJb!rQ+hqtalDUhdRM%55lWX2lN7zVVbUj3`Z2cVrBuzt zx0ByR>OTuESco*<#HyyF#!4a57n=y@n`n-4U2o8xdKQ0cHwgmkpILr?~Yt=^7 z&6a1RPv}IxRYvBriBXD`S?j^3E7`rP45$z7$OPsgO><OnDV?_&P+E|CwKgm|QB%t&Zno zf9i+>DkCctJneBxw(?`b(RTWu>w~LxYpQFD~c22QBvVQLdK! z@dTtL1B|$-Y~IE)bq1qLh5~N4C~;PH3&ymutp~<36m9ET#?Tu)972PRE0%HJt_OQM z%Y@sA37nU4;XLQ0J+aYFty40zG4iQ|=|cVB;?eS+K%NUY^T z`$$*#M=SgF=eW)J4CtMy1?)9U;UcLj1ii*qh7L&XO|HaNjAxNiwxdH+wD7U;!lS&L zXn&q(s5P+ERjaPLiYyqbR_*s=nL(jxs@I#i76Abo74>ON<(LM+?~8=$iVft_`;)A~ z&oc$Q$e@BPCB>O~_C7$RWrd9AfydBcHG5WSKJTp%OwGMLcV1pD@Xo>Gt3QP77~TtN z#x$y{L0;G5om4@Wuy!~~kESZSBn>gr^&=kJH6FlNRc~;K$nx2~=`!{4e%0+jqbmBIB{+@do%fEl4|ySD#!0sQuE>BY!1~dp;Zp z-OW_q8dCd(SxTL;(iDlBjI3W^r@!Wr3i_~12vwTD{}*3MCaQO#cQcQ7ZT*T#X;=3@ z)G+<$=5Q@5HI}*Z;19mUH_DyjV3vn=$|CrLHP4 z2~qM3g633z7 zZpZxNhasJ4k6uud8m0Xccjg=(EAeZaGj8d%i~idC&@u%N<3qyL(%yV$e@(%&ox_p( z=7>k!uRYydbK~DNT2Yol_fhn7YOTX<((ncZ=<#kI9Gh1UU}`=a4K zt@t8C(D9b}rIJY-P&YiS7P;`2`J<94CFY%5C#;{Ln4i%Kxxp>1WL_D;O9~r{xx>w@ zWX{Izbf#6{#!b*`3%?^H8}5oerBrIlJU8fgV^{mXuPWv!Ov?adeO zbK^JbrS!Q8U8Kos6p$JPeuJAMkW$K6YGrK+Q&^mtT2f23CPhyza;#F=;sY1%gh*-T z(yNTt2s?7ANU!(U`b`;ka7H%}>Ug*JePwy1lVkmdv&m>1jf%A3J9div`r7%rQgvRf zW(5y+$Bwh%**BdB^bW3O)Gkh@_m%s5YI_F{=z0fh5WUA5E}pBXCi{8^SLu1L=-kM< z3p!L>y9oBy_FkzQf89-Z;A$u6PwOi$oL%rne(sa3z)!=k+?K(a%h;oX?9e5e$uw_k z$IY}{H?*xCx5w0xV;FkJP7s({`_q;3x|{XYlw46)t7ol|Oj{9_TP}11D#`ZHUN);M zsP)kD&ft5~S1`Ue&~Q6g*IMmj5bb>>FIUccMX&a3GA=)^*51e4(nhOd3n&~oj(k%l zrZczpC&i?p^5~(IzH-#Z`dT@!3*Oq?Y$v-^M+@&UhtqwYkdfEj*0DvKSz$rBpc~xbN@jMmdQXD2V~RYZ)=yk0i=Is3YwYVw%XgCT zB9*H5)I%M0dlZGu&`ilzwY4*gwQ@Ro-rAYf_;M8IedW;*sXn*73`J0bde54$8IG_S zCg@znAHpSn#gXh>mU(6FLEnkwQSZAz`HZ`7gmQiHET{I?_}uB;;HR~@S~kwLP#OQ5 zDzKi|n@O$;#WCleo>HRZ#E)|xV9bY{M=t6GwSQ?A$0g4VQ`3c~(e)RJ!zE|N98YxF zEnW)l=JNXQvRJv4_D zPBwcwep7lu^kqkT*yION*~p1`@BB&e9A}-7d{b{lNkhCay1La-aQn#(ai!b}iQv>$ zxrn`8zQl%o?=_q!lv*!wt-0_>fJtk?6K2?i3Xprz%L6py@RwkCvG>}#k?lqMd#hn} zGroJC-vj06G-yz4ZY_A+*=^WIT|7AJLG`9yS2J-5haeBt4`8ik8 znv_%rXU5Iw8bOwDepK!_IFfqLI2;6|fpO*&piXu^?Hav zDB@3o)bj2#3Lb6gcg@9Ng)u6)laBmp=v0ASq~X$0q~3!Ov$#&58UrV!(tAnDxba+= zDxU>gYUNf_;U|1CJR#w#OJNaHc)`lHXwDd^9q^sv^z+o9D zk?N1DUlhMUyS_fGi58#h6PdU&CLhq3IZH_s`{>ITW>6qjWdZYW_ zEe%ME1^rssb;XqQl=a(A7%GMe{4Ow-_v{n2-Y|Z(2pbDvihnYs`+DYn=)L9Ow%A*_ zbqlefZBxKv>Z_Vv;X6?1EflF4wvHy_9LLvtI=eP{aNL zpxeRWK1FQeOJ&Aonm6P7>_$^SKK;2e;{;);QZQQEtU8gi4u<0nw2A_Fr3x0dQxQ%K z|Heh0vn4GtyQFn-1S6zvMKp4cUFd%Mhw`Y6G9aDwL9DFvkW7!tTcb01?{!4uOHBRl zIkqi@-7u27JQwgj6|JD9C7G>OvJ3WFmyyo*<^_)-Mijfi-X#d}MLfm$y&(D%nkkA*=R)pgG$j(J*%jDJzOYAqgXDALSbHO(JjI1rumgbat#d!@EPsBjg} ziA?bLzR>%pxyE;b3Z;(E=sSyy>7yAVz17*epHkZJ{LmlGV?9x^6h(15zcS04U+xZ1 zGd7%p@n!WB9SaAm%Ze$bH!v5Y=Sv}n<}PLu+he{2h3BdcM!LDvUAmh$7({I%KQOa_ z|G^PMwso~7RtL5oz{m77lPpdL-Tsj7%(N2`~bpA!TFvi{+Y z9|m8hDtLm$Upk4jM6}M2`cOOCbqy{m*Gm{g+bga%fAb3UOn_RD>rFZDA$_$`l<9W( zXl5y5hC3H9e{^)LrOq$=*e4R>xn?w( z%`iB+WeJ`UAeAP&$XehW{vNR3+PHZ2tO!fK_ts(-7djTWZASNd*dhz2fCI`2w(Mqw z6Qa=c^|3aX6U)PplaoKS%x$>oiw_vms8{$Qh5x12t+ana@w z{^V{zCEQH?K)D!qy+3D<>n^JE@6H%SNfFbwsAqLo@plP+PF2#By!97QrR6M7UBb4| z4XN-=SS?cXA4=k%D6>@IEdZtHwP)QTI}V`j6YPvyk7^-V@uf5UPd*d=aK%H&0nH=- zn=6LjD;8)Yrt~OmCHDW3qj2Jla_Ibv?q5Eh7_Q-bO_R?(VQ49Hiofix?D8%YBO_!) z*6i;$e}cVOacf)mPyXdILLVII4}QDyH3+g}Qpa4*Ounv1(CBI!N8fR?+mB2Y`b30a z3}W=luKJ(5d;UKc`=W*f-M4DqTum>_4QdNFMY&bFmy6A-3dI!b_RJ$<@FM-)AshXB zI~lYpFA9QC23|IV|Gn7_HqI;9_}uC1jENe{+X<-o^|J$bZfN?u8Qg~Z@K(3CtKK_} z^)lhrqT2>r%;D9N$g$aN<9r1BWViQi#cfCgzh(&~plIQWTBcrhp|;lRXMc7u1VJ`< zm+ib-FLh0tqFBo*0bOMO?Cl-)YwcQpP3CUK1ynRfQUzx0bUDeGk5e~!Q2jDP5*3*l zHymTK^lmNPxm+6SZN&>JYdvLr!v$$Aq^9253opTBNIRodg%_L83TDnak8H#HGDD%k z8~^$>Q^!>4NbiQto!@47xu-ARRsz4esxWeL!yrQq$Ie~*G`O-p0PGgTw@k5&CWVoD z1wM`?AK*2#vf&Iedd8c&RL;p+by*2(KH(r4NHON;IzBHC(g^75?Wk)zg1MoDX;+Hb z@W?&=^@?NN@>__U=gGH{_+-p}Fy4~?ph1-uc!QqV?E1>IW^C%-nL+ah)aANfgfu4& zv#{1HAe7oe(Loq!%a%tzSd5eTF|3U`K(Lv#G16~a(HOfI)gQkaI8Sh=^N%W-qtp$1 zN)-<=?uhnsKQ&5_Yj3sM2VL}isJ5~z=+Er{d}&9-ft}SqpK(MAb@#o0W_JVuLGSs@ zIRTKwQ=k%^-W-IIPuXA%k&o|VcwCI4x)S&IuONoV5Rw8@cZ zkRZIpoYl}Yg|1;at%ogswcm@n%`?ulW#X{Q^HASRcwc`IECq_Y&zVJN>!W@6rf-!J zm(5zOjtg=37qtrQLx%fft4Ieg=f1&TJA1+I-oqO~U}_N&;_ELcRX>0|gkOcFcdmLk zat(I-f^o%Y^!1AcE{bng9ovE(@n;}uU=9CH51svP9D|XM*Y)mXn)_%-3GG?x7og-z zokcm(%D@}KSAeDFH?IP(OQ1Rtp}Y^RHoaXd^?d))Qk(Zm*^gSnoehzUOB3YMJ3y13 z2exqK838Q4ic)yHlYipZTJ4*7I&S(^A^yv=hYB4!2i}Iu1uUM+hFGGh%TLGSecZrG zgm=W^e~JzHkEi1+%~XWO&b7o#$VzMB z9Xox=5){IJ?vLGc_(y#sBB4`wtRFkT&QT%4A<5)nQ>(JGyb@w#C`x(+E* zW(e+cLivyCZK#>14-4K$_B6@+C(b^rWy)bGq+VbY)fl~s%H-;T{@HQ4LfSc^(>aLI zKCvHha6cAvK+4C^62m~7(H-1aT?&TKKnW!h=wz1+T1}C`oRNRu`DcF)6g;@-p{tI( zpi&~K*I7Fgq?Fk5`K#_;=cOg=;}8qLfXIDzgoAx6%eSNMRHk*{tHf#;)(|=ya7K8) zcDuE8F@4zJR8@2#x5uW+YnkhO+axe%WAgQ&`G?B#lZHLZ1{)1S#^@EsS&rrop?(Re zZke=)XZ7n0(Zp@eEaZg@o)sllJ7^KL#zfX${VLP4^;`pbK2@F=-xYz1{-E@>@IQqc z{8t}51_BHMLnfl;PzyhBCTA5_UVywsl0p>eMuUijoNS97&Yjqg*K0*f{*jAOF5LQ= zr&mJCLp+#RuN;5?f~#lpdYjVyk5|VJ>kgmVaWMFw{)q2THfWZ6G_F5=G|9gxG&S^B zEJscf<*Jn6$4d8&&YqBY?hL)T;TNS(yxiZi6tn!T`%-65-FA2)L01_3xzo^zsd0J( zSlLee0>lW3*uKZnz1eK{Xh;3joSs(nv$~g%s#g7MxZ&lFdn8s@rR$#oFfygBvV<}N zR63ifyZ$O3xDWNu7@8X(D%?)WFdrA@-#qKQ{?1TYp;1s|`|kENMs@jmnIf%nf<53r zjGf`kX1(*rHL1B`8Hji&=_6`^x<2(HFy=nkV5YNVw!-$8WU6NOp?XW#V`i%j8mCs< z?=Czsgugq`_RzYS+fgCfu~I4Z&I*TCqi(gI%3qT4Kg$UfUWV}>))*R$q`5o5HCiM#7Aj`L?sHlKyM1aF*Ln8?mYJcOGwZ!Io7b&wGTGXMY# z;_B1!fQ8}zt8QzLO8SoCZLV3G>4vXH=FE;}mRh8i7%r{hW9G6H6fniq%*0xN=Cjn) zGAT1(Lywiu`GC*}CZQQlEj5jfKu%!lL^+`N$X9~x2kwuZ&e{L>`@Q%4e&74K=X3A< zP!Y%HXqf13J!?9!#0ev#?r`W8)YsIuJs1@oGd>TG^DPcZyA(r4wIv6%x_mhm?p(c4 zJ5->sOQ|~fI>v=>*vNXMPV$#i&+7P~z$52d|RQZ^X6yiQDT^7bod-FxtB8Oek zqQv81S;-d8r1r?rr zxM}Y7l~=LS%-s5UD6vMSVC^XnWT#FxLAAf2gASt}B?KSisPqpr9L0q&FyY)XLi*Th z(AY!nkes&0!@mWFmS16XsKx3sf%D?W$MnSWHHE>k^3(A%kCL z*VN0jq)K~z(p*bC!XimfBh>84$aufp6bzq?s##F52uCuIn_scSZe_>ND^7m}-ivXU zBff?dhU*SN(CdRF`7=qoH^Mcz@PH{+oKMP`Fo!+6xbQ^z7R+5^wUBeS(kc>BDN1sK zOKovHiLEp6jVD#?xTTSdbGTKeIXxa z9WJCCdTqs-l-SyP7N@TA@V%Asd2!_FOo8j(?fVU|RNGkRiM;YG*`+ojywxcZRw;^8 zcq7DZO*$ozrIyefVc99>>aX~euO{m(aRs~HSozrwc*voOSia*REGuxT>44#k2>@OI zMl>01r4{zai-NQ1F^U|%@ZRE$QTddfRLRU+zRjrC)q&7*x6|I=IlrKsx?p_OJ12JM zl|?w$h)}|I#9V$~nt@6*7nYvt<^86YF+Y9oW5ekn=g#dr$t2b~Ci3?v1_ZYIe0)x{qJ9WYpNMMNOoe(7|) z_;mKGKh0+V$=HaovI)v1p(>w8CxNi`UIzd=S=eo?7^+d^rz#aqb$8NsA!0xbK^{$wW!E0!6EXr_M&jLAN7tz z79VVsRpEy*&ef=_xIo9cnAt8b>yhBid4T3q_PV)z0-R=?pRuGjvzMRyOK-doN z@j#iGe*7@OXGG$PwCjvi7Y_ll$hx!HTC+$;@X4uGm!nO*0~SRZHiKkjB3spFp~7#m zQuQj|b%IP?FxX3~Y$MJ#upe6YithtTVVNeoZ}ms*A}_fqX0Z>$#&5+~{0F6JQf9w& zaJt(>OYgHor6t#(D<0j39(rInT5F;2rDnW?gxHHe47)skK9>&S-Y|FF7n}I02-_1j z0Gf1pbFFNR`Sn=vUX0}i&P&FexLXd*b;0Jg)8(sU=w@+gU#X5K|waporsW5985W-7PXiZ0~`#H*YuF8BOw)o1Y367+To0y9su3$9q#hp<rgk8K7{K3 hxp2QBcG>%rn*T2u6!*~de*kadYUKa` diff --git a/assets/image-for-docs/discussion.PNG b/assets/image-for-docs/discussion.PNG deleted file mode 100644 index fd1f00c51368644b9ca400edfdf21b33578ced77..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1617 zcmV-X2Cn&uP)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>D1?EXaK~#8N?VM{& zmSq^nYwJUP?MqueQC9ISRb0J)@dtqnbov1QxGy4b0wMODJO;@ z0}q59PyrEx5J6B*B4-dm&Ij+_-_>sRyzhJSIvy6UVF*L}fwxasCw zW*L=gvQltVzNFx&d`ZDk`I3U8@}-F2+_8AJx&On*&Ag3InfXait7fq9F}}vH4d*Z3UY!+?toD{lm_|RIwu% zfQ3*#tir${!*&g%iao(XC?8e|j%q?FI4WOKa8$me;HZ3Q+QC_#@tNrz>NBI)#>~#5 zeL;1}$G4i{(P5KXav-Su|JEzJ-!?5hZ6dy3btq20&n(Y&wx4dzO?<-qRh?%Vt~8mq zep%scGu?_BI9wflmxBy(qkxli?0YjXGH8y~6gb;Yw-$Z(yeV(3GFJwA%*w1Uoo%LD zQ3D47NnYJ4*-_NpDB!r-sDc$Wa4vMznxcjhGdMCNJDj>uZ~!X3?2zdj>X!(`=bqwU zWe3(>Zjgxe`o87THm54rTnl`qmSo8Nrra$uw!Qc2U?)rD^Z&90$j) z<3w$tv|oKVUg{X1FV_C-kFU!5wx8N-y864NoUsm791ZJ__?|NAxZiwYTTs8#4gW+e zKi^&>cEf($e-QXQ*LJ~-j*X7n23y%pXxksG$dNj`?xlO*m-?wHYT)o-@1=h#Mr!D4 zG|z2c8V1h((kw9yfPImjC=bpNlJLi70mVAPg2YwUd`|k3pY#v+o6nCV1kI0OEi{D} zi)E~e*7IUm7dQYyZo!(r&HG8}n1gme$vD(+$=_kpN;AcI-u`x8FF5b+|5%^r@t2*oZsBjD)$*@kI0y;fwkC;LVKR6K42F%QAuN&++#Pprl}~Z;BZfZ z3>;bIzl|Fla9-T`h8XA4m1cp8wiwgq9ypwc0w60g*GTjs53tT>H)2d2@11|yfmNnw z@T#fqs1x8QBWltAdf*TZ79>9-dMOaKDDMpPdnfIqpgAT3&YJA61!mSVQ91p+;1G4k z0+0ZW9iQhS2Vw)!hxXV9J5f(=MC7q{pQ@q`4iAaLac26NgX7@XcCHI2;9wkG)m|;| zHFdX`9Yv`!PD=hx0l~Gq*nLBzLqSfpW4XYg{;Ql#rmeR_c5MIffZ1D;E{mm{tR z4)@y%_lTpp_yo#G1Tyu z=tmf5hgJrni#OC4)Soupfw8=XwX!=8;A}o%ck4vpSgk(1!L(j&m;OJT{8`pVbO_BG zES&b3LHTt>Va{g$q}&vFcJDZ@axVyxB948om;eWHRI#JEY>vau0wi(~ez$@{iZ7iJ zBT>J#V3!#g8xaw8Fc^lzu`Y)qA{@sQ`M~kolj2CZ56t5NhkF2EZq`uSc~Qm(qN9O` zh668lT?)!^EWkV`c?xA58x|ba&vUHJ`9_Xk)`}RzRUQhC%?-H+9@fSY#WUI8jl~Q& zOHy7Cr+C4k40td)7tTG~@?T;~y>$>f&B8>^!{y!Wq2ebJ=CVgmcIBTENnGHN<8YMX z6xuT%#|h(*>(CdFxL7BUP)Af?Z2B~IH%mfo!FerpndENN@x|O6hZB`EUML7Fv(}oL z&ibHr@e`hnqB9O0)y$BBqw*yMN99Wjj>?x59F;Fk3LO1obrqWQAFK091g}Q822;h3 zCjEMhzL2LvlYSu&L7Kh-9J})M3NW(&bl{;)OU#^vg_`rkfbNNV#LU^SP<)Q>ef`q` zD?$~6kR*{|t7fk7F}{v;Jb4un9F=M!DL5)$QgBqhq~NH0Nx@P1&@A&Wf@GrD`kseU P00000NkvXXu0mjf&hQfU diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index ccd66431a..47319d3b5 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -11,16 +11,10 @@ This docs is also helpful if you are donating a project to [asyncapi](https://ww 1. Visit [asyncapi initaitive on Github](https://github.com/asyncapi) click on `Discussion tab` to start new discussion. -![alt text](../assets/image-for-docs/discussion.PNG "New Disccusion on Github") 2. Click on `New discussion`, select `Category` add a `title`, ping [Lukasz Gornick](https://github.com/derberg) or [Fran Méndez](https://github.com/fmvilas) in your discussion about the new project. -![alt text](../assets/image-for-docs/Github-discussion.jpg "Start a new discussion") - -### Note: -There are 9 categories to every dicussion that been discuss here on asyncapi organization, each of these ctategories represent what you are proposing to the technical steering commitee. - 3. After starting a discussion about your new project for asyncapi, and successfully convienced other members of the community why your project ideas is necessary and you want to maintain the codebase. From 65dcbca2ce491376c7fe40e8336505437312e05b Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Fri, 9 Sep 2022 16:06:50 +0100 Subject: [PATCH 18/43] Add docs about Github Actions --- docs/how-to-create-new-repository.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index efd8c41da..218187e89 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -4,7 +4,7 @@ This document is not about creating a repository on GitHub. If this is what you This document is about creating a new repository at [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). This guide explains what is the approval process and default repository configuration options. -This document is also helpful if you are donating a project to AsyncAPI Initiative, which involves transferring repository ownership, but still becoming its maintainer. +This document is also helpful if you are donating a project to AsyncAPI Initiative, which involves transferring repository ownership, and still becomes its maintainer. ## Creating a repo for a new project @@ -12,8 +12,7 @@ This document is also helpful if you are donating a project to AsyncAPI Initiati 2. Start a new discussion by clicking on `New discussion` and selecting the `Idea` category. - - Specify in the title that you want to create a new repository. In the description specify what is the purpose of the new repository, and why it should be created under the AsyncAPI organization. See also [example discussion from the past](https://github.com/orgs/asyncapi/discussions/300). +Specify in the title that you want to create a new repository. In the description specify what is the purpose of the new repository, and why it should be created under the AsyncAPI organization. See also [example discussion from the past](https://github.com/orgs/asyncapi/discussions/300). 3. After starting a discussion about your new project for asyncapi, and successfully convienced other members of the community why your project ideas is necessary and you want to maintain the codebase. @@ -23,16 +22,29 @@ This document is also helpful if you are donating a project to AsyncAPI Initiati 5. Your proposal for a new repository must be approved by Technical Steering Committee (TSC). So make sure that at the end of proposal description you mention `@asyncapi/tsc_members` GitHub team to get TSC members notified. -6. After getting approval from the TSC, Repo is created by Lukasz or Fran, we will need to distribute all `CI/CD workflow` to the users. To know more about asyncapi `CI/CD` watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) and - invites new maintainers as admins. +6. After getting approval from the TSC, Repo is created by Lukasz or Fran, and the `CI/CD workflow` will be push to the Repo. Next, we invite new maintainers as admins of the repo. + To know more about asyncapi `CI/CD` watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) + +## Github Actions CI/CD in new Repo +Using asyncapi `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by Lukasz or Fran. + +1. Go to asyncapi `/.github` repo +2. Click on `Action` to view all workflows +3. Select `Global workflow to rule then all` +4. Click on `run workflow` and paste the name of the new repo. +5. `Run workflow`. - +We have one `worklfow` that basically takes all the workflows from `.github` and we can selectively push to a specific repo. One of the owners which at this time is Lukasz or Fran becuase they have not transfer ownership to the new maintainers executes this actions. - ------------------------------ +A set of `pull request` is created by the asyncapi bot for a given repo, you need to `merge` them in as a maintainer of the repo. +If you don't want to use asyncapi global workflow, then you will have to automate all the necessary `pull request` that would have been made by bot. +We open a `pull request` in `.github` repo, select `global_replicator.yml` and add the newly created repo to every single `Job` from the `global_replicator.yml` file. Add as **list of repo to be ignore** in `repos_to_ignore: name-of-repo` + +This tells the asyncapi bot not to constantly push `pull request` to the repo. ## Configuring the repo + ## Donating a project to asyncapi From 949ec86ee77a322246be75bf42a6816c1dff4318 Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Wed, 21 Sep 2022 12:48:06 +0100 Subject: [PATCH 19/43] Update how-to-create-new-repository.md --- docs/how-to-create-new-repository.md | 43 ++++++++++++++-------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 218187e89..6568e5018 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -1,48 +1,47 @@ -# How to create new repository +# How to create a new repository -This document is not about creating a repository on GitHub. If this is what you were looking for, then [read GitHub guides on repository creation](https://docs.github.com/en/get-started/quickstart/create-a-repo). +This document is not about creating a repository on GitHub. If this is what you were looking for, then [read GitHub's guides on repository creation](https://docs.github.com/en/get-started/quickstart/create-a-repo). -This document is about creating a new repository at [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). This guide explains what is the approval process and default repository configuration options. +This document is about creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). This guide explains what is the approval process and default repository configuration options. -This document is also helpful if you are donating a project to AsyncAPI Initiative, which involves transferring repository ownership, and still becomes its maintainer. +This document is also helpful if you donate a project to the AsyncAPI Initiative, which involves transferring repository ownership and becoming its maintainer. ## Creating a repo for a new project -1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions) +1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). -2. Start a new discussion by clicking on `New discussion` and selecting the `Idea` category. -Specify in the title that you want to create a new repository. In the description specify what is the purpose of the new repository, and why it should be created under the AsyncAPI organization. See also [example discussion from the past](https://github.com/orgs/asyncapi/discussions/300). +2. Start a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the title that you want to create a new repository. In the description specify what is the purpose of the new repository, and why it should be created under the AsyncAPI organization. See also [example discussion from the past](https://github.com/orgs/asyncapi/discussions/300). -3. After starting a discussion about your new project for asyncapi, and successfully convienced other members of the community why your project ideas is necessary and you want to maintain the codebase. +3. After starting a discussion about your new project for AsyncAPI, and successfully convinced other community members why your project ideas are necessary, and you want to maintain the codebase. -4. Additionally, when creating proposal specify the initial maintainers of the project and specify if you want to use asyncapi CI/CD workflows or not, so we don't get to ask you. At least 2 code maintainers are needed to start +4. Additionally, when creating a proposal, specify the initial maintainers of the project and whether you want to use AsyncAPI CI/CD workflows or not, so we don't need to ask you. At least 2 code maintainers are needed to start. -5. Your proposal for a new repository must be approved by Technical Steering Committee (TSC). So make sure that at the end of proposal description you mention `@asyncapi/tsc_members` GitHub team to get TSC members notified. +5. Your proposal for a new repository must be approved by the Technical Steering Committee (TSC). Make sure that at the end of the proposal description you mention the `@asyncapi/tsc_members` GitHub team so as notify all TSC members. -6. After getting approval from the TSC, Repo is created by Lukasz or Fran, and the `CI/CD workflow` will be push to the Repo. Next, we invite new maintainers as admins of the repo. - To know more about asyncapi `CI/CD` watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) +6. After getting approval from the TSC, the repo is created by either Lukasz or Fran, and the `CI/CD workflow` will be pushed to the repo. Next, we invite new maintainers as repo admins. + To learn more, watch this [AsyncAPI `CI/CD video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) -## Github Actions CI/CD in new Repo -Using asyncapi `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by Lukasz or Fran. +## Github Actions CI/CD in new repo +Using AsyncAPI `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by Lukasz or Fran. -1. Go to asyncapi `/.github` repo -2. Click on `Action` to view all workflows -3. Select `Global workflow to rule then all` +1. Go to Asyncapi `/.github` repo. +2. Click on `Action` to view all workflows. +3. Select `Global workflow to rule then all`. 4. Click on `run workflow` and paste the name of the new repo. 5. `Run workflow`. -We have one `worklfow` that basically takes all the workflows from `.github` and we can selectively push to a specific repo. One of the owners which at this time is Lukasz or Fran becuase they have not transfer ownership to the new maintainers executes this actions. +We have a `workflow` that takes all the workflows from `.github` and allows you to push to a specific repo selectively. One of the owners (which at the time of this writing is still Lukasz or Fran) executes these actions. -A set of `pull request` is created by the asyncapi bot for a given repo, you need to `merge` them in as a maintainer of the repo. +The AsyncAPI bot creates a set of `pull requests` for a given repo. You need to `merge` them as a repo's maintainer. -If you don't want to use asyncapi global workflow, then you will have to automate all the necessary `pull request` that would have been made by bot. +If you don't want to use the AsyncAPI global workflow, you will have to automate all the necessary `pull requests` that the bot would have made. -We open a `pull request` in `.github` repo, select `global_replicator.yml` and add the newly created repo to every single `Job` from the `global_replicator.yml` file. Add as **list of repo to be ignore** in `repos_to_ignore: name-of-repo` +We open a `pull request` in the `.github` repo, select `global_replicator.yml` and add the newly created repo to every single `Job` from the `global_replicator.yml` file. Add as **list of repos to be ignored** in `repos_to_ignore: name-of-repo` -This tells the asyncapi bot not to constantly push `pull request` to the repo. +The previous action tells the AsyncAPI bot not constantly push `pull request` to the repo. ## Configuring the repo From fe566fcbbda1a1a337d0ddaf55dd74c4f8329ba4 Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Wed, 21 Sep 2022 13:13:08 +0100 Subject: [PATCH 20/43] Update how-to-create-new-repository.md --- docs/how-to-create-new-repository.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 6568e5018..bc1ed57b3 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -14,15 +14,15 @@ This document is also helpful if you donate a project to the AsyncAPI Initiative 2. Start a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the title that you want to create a new repository. In the description specify what is the purpose of the new repository, and why it should be created under the AsyncAPI organization. See also [example discussion from the past](https://github.com/orgs/asyncapi/discussions/300). -3. After starting a discussion about your new project for AsyncAPI, and successfully convinced other community members why your project ideas are necessary, and you want to maintain the codebase. +3. After starting a discussion about your new project for AsyncAPI and successfully convinced other community members why your project ideas are necessary, and you want to maintain the codebase. 4. Additionally, when creating a proposal, specify the initial maintainers of the project and whether you want to use AsyncAPI CI/CD workflows or not, so we don't need to ask you. At least 2 code maintainers are needed to start. 5. Your proposal for a new repository must be approved by the Technical Steering Committee (TSC). Make sure that at the end of the proposal description you mention the `@asyncapi/tsc_members` GitHub team so as notify all TSC members. -6. After getting approval from the TSC, the repo is created by either Lukasz or Fran, and the `CI/CD workflow` will be pushed to the repo. Next, we invite new maintainers as repo admins. - To learn more, watch this [AsyncAPI `CI/CD video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) +6. After getting approval from the TSC, the repo is created by either Lukasz or Fran, and the `CI/CD workflow` will be pushed to the repo. Next, we invite new maintainers as repo admins. +To learn more, watch this [AsyncAPI CI/CD video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) ## Github Actions CI/CD in new repo Using AsyncAPI `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by Lukasz or Fran. From b34df352617c2bfc3dae017f07de3269fc13359d Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Thu, 29 Sep 2022 00:12:31 +0100 Subject: [PATCH 21/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index bc1ed57b3..01a5616e0 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -37,7 +37,7 @@ We have a `workflow` that takes all the workflows from `.github` and allows you The AsyncAPI bot creates a set of `pull requests` for a given repo. You need to `merge` them as a repo's maintainer. -If you don't want to use the AsyncAPI global workflow, you will have to automate all the necessary `pull requests` that the bot would have made. +If you don't want to use the AsyncAPI global workflow, you will have to manage project automation independently. We open a `pull request` in the `.github` repo, select `global_replicator.yml` and add the newly created repo to every single `Job` from the `global_replicator.yml` file. Add as **list of repos to be ignored** in `repos_to_ignore: name-of-repo` From 22ae8aab2424449ba00fcc49460006e6ffb53389 Mon Sep 17 00:00:00 2001 From: Tabah Baridule Date: Thu, 29 Sep 2022 10:04:38 +0100 Subject: [PATCH 22/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 01a5616e0..c7302a092 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -21,7 +21,10 @@ This document is also helpful if you donate a project to the AsyncAPI Initiative 5. Your proposal for a new repository must be approved by the Technical Steering Committee (TSC). Make sure that at the end of the proposal description you mention the `@asyncapi/tsc_members` GitHub team so as notify all TSC members. -6. After getting approval from the TSC, the repo is created by either Lukasz or Fran, and the `CI/CD workflow` will be pushed to the repo. Next, we invite new maintainers as repo admins. +6. After getting approval from the TSC, the repo is created by either @derberg or @fmvilas. They: + - Configure the repo setting + - Push the AsyncaPI `CI/CD workflow` + - Invite new maintainers as repo admins. To learn more, watch this [AsyncAPI CI/CD video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) ## Github Actions CI/CD in new repo From 1de231a49761080af6b311f0749166a4ef9f6c80 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Thu, 29 Sep 2022 10:14:44 +0100 Subject: [PATCH 23/43] added feedback --- docs/how-to-create-new-repository.md | 82 +++++++++++++++++++++++++--- 1 file changed, 73 insertions(+), 9 deletions(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 218187e89..ea398311b 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -15,18 +15,19 @@ This document is also helpful if you are donating a project to AsyncAPI Initiati Specify in the title that you want to create a new repository. In the description specify what is the purpose of the new repository, and why it should be created under the AsyncAPI organization. See also [example discussion from the past](https://github.com/orgs/asyncapi/discussions/300). -3. After starting a discussion about your new project for asyncapi, and successfully convienced other members of the community why your project ideas is necessary and you want to maintain the codebase. +3. Start a conversaction with community members to initialize a new project for AsyncAPI, discuss the project ideas and indicate that you want to be a maintainer of the codebase and at least 2 code maintainers are needed to start -4. Additionally, when creating proposal specify the initial maintainers of the project and specify if you want to use asyncapi CI/CD workflows or not, so we don't get to ask you. At least 2 code maintainers are needed to start +4. Specify if you want to use asyncapi CI/CD workflows or not during your discussion about the project, so we don't get to ask you. +To know more about asyncapi `CI/CD` watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) -5. Your proposal for a new repository must be approved by Technical Steering Committee (TSC). So make sure that at the end of proposal description you mention `@asyncapi/tsc_members` GitHub team to get TSC members notified. +5. Your proposal for a new repository must be approved by Technical Steering Committee (TSC). So make sure that at the end of proposal description you mention `@asyncapi/tsc_members` GitHub team to notify all TSC members about voting + +6. After getting approval from the TSC, Repo is created by @derberg or @fmvilas, and the `CI/CD workflow` will be push to the Repo. Next, we invite new maintainers as admins of the repo. -6. After getting approval from the TSC, Repo is created by Lukasz or Fran, and the `CI/CD workflow` will be push to the Repo. Next, we invite new maintainers as admins of the repo. - To know more about asyncapi `CI/CD` watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) ## Github Actions CI/CD in new Repo -Using asyncapi `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by Lukasz or Fran. +Using asyncapi `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by @derberg or @fmvilas. 1. Go to asyncapi `/.github` repo 2. Click on `Action` to view all workflows @@ -34,17 +35,80 @@ Using asyncapi `CI/CD` workflow saves you from a lot of work load, after includi 4. Click on `run workflow` and paste the name of the new repo. 5. `Run workflow`. -We have one `worklfow` that basically takes all the workflows from `.github` and we can selectively push to a specific repo. One of the owners which at this time is Lukasz or Fran becuase they have not transfer ownership to the new maintainers executes this actions. +One `worklfow` that basically takes all the workflows from `.github` and can selectively be push to a specific repo. A set of `pull request` is created by the asyncapi bot for a given repo, you need to `merge` them in as a maintainer of the repo. If you don't want to use asyncapi global workflow, then you will have to automate all the necessary `pull request` that would have been made by bot. -We open a `pull request` in `.github` repo, select `global_replicator.yml` and add the newly created repo to every single `Job` from the `global_replicator.yml` file. Add as **list of repo to be ignore** in `repos_to_ignore: name-of-repo` +what user have to do, to make sure their repo never gets CI/CD updates +A `pull request` is open in `.github` repo, `global_replicator.yml` is selected and the newly created repo is added to every single `Job` from the `global_replicator.yml` file. Add as **list of repo to be ignore** in `repos_to_ignore: name-of-repo` This tells the asyncapi bot not to constantly push `pull request` to the repo. -## Configuring the repo +## Configuring the repository +All repositories in `asyncapi` organizations should be similar in structure, settings, and restrictions. Follow these guidelines to adjust settings of a new repository created in one of these organizations. + +## Adjust repository options + +Under the repository name, choose the **Settings** tab. Carry out the following actions: + +1. Scroll down to the **Features** section and disable these options: + - Wikis + - Projects + - Discussions +As an admin you can always enable **Discussions** when you want. + +Make sure **Sponsorships** option is enable and `open_collective: asyncapi` is provided. + +2. Go to the **Merge button** section and disable these options: + - Allow merge commits + - Allow rebase merging + +enable only the **Allow squash merging** option. This option combines all commits into one before merging the changes into the `master` branch. + +3. Make sure option **Automatically delete head branches** is enable + +## SonarCloud scans + +Each repository must be integrated with https://sonarcloud.io/organizations/asyncapi/projects for automated quality and security scans. +If your project is not in the list, please add it via https://sonarcloud.io/projects/create. +Our **CI/CD** is very important so, if you create a repository named `main branch` you have to rename it to `master branch`. +In all our project we name the `master branch` as the `main branch`. + +## Branch protection rules +Branch protection is be added by whoever creates the repository, here are the steps: + +- Under the **Setting** tab, click `branches` +- After that you can edith the branch name to `master` while adding branch protection + +Under the **Protect matching branch** you will enable the following: + +- enable `Require a pull request before merging` +- enable `Request approvals` +- enable `Dismiss stale pull request approvals when new commits are push` +- enable `Require review from Code Owners` +- enable `Restrict who can dismiss pull request reviews` this is done only by admin +- enable `Require status check before merging` at this point you have to set your status check for Github action to check before merging pull request. +- enable `Require branch to be up to date before merging` +- enable `Do not allow bypassing the above settings` +- enable `Restrict who can push to matching branches` +- enable `Restrict pushes that create matching branches` + +This setting is required to done by who create the repository. + +## Collaborators and teams +This is the point where you give admin role to individual that will be the maintainer of the project. + +You have to invite the `bot` as a maintainer, it is very important you do. + +## Codeowners file +This file contains name of the two code owners which are also the admin and also the asyncapi-bot-eve is also added. + +Here is an example to `mcturo` and `magicmatatjahu` requesting to create a [`Design-system`](https://github.com/asyncapi/community/discussions/265) repository and [`An interface/project for describing errors/problems in tools in our organization`](https://github.com/asyncapi/community/discussions/300) repository ## Donating a project to asyncapi + For donating a project to asyncapi you can click [here](https://github.com/asyncapi/community/discussions/223) for an example. + + same repository setting is applicable to donated project. \ No newline at end of file From b7a5ffaa2b395e03ab69474daf919356a184a58e Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Thu, 29 Sep 2022 10:19:20 +0100 Subject: [PATCH 24/43] Updated the description of creating a repository --- docs/how-to-create-new-repository.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 62dbd3645..8cca0990b 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -13,8 +13,6 @@ This document is also helpful if you donate a project to the AsyncAPI Initiative 2. Start a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the title that you want to create a new repository. In the description specify what is the purpose of the new repository, and why it should be created under the AsyncAPI organization. See also [example discussion from the past](https://github.com/orgs/asyncapi/discussions/300). - -<<<<<<< HEAD 3. Start a conversaction with community members to initialize a new project for AsyncAPI, discuss the project ideas and indicate that you want to be a maintainer of the codebase and at least 2 code maintainers are needed to start @@ -28,7 +26,7 @@ To know more about asyncapi `CI/CD` watch this [video](https://www.youtube.com/w ## Github Actions CI/CD in new Repo Using asyncapi `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by @derberg or @fmvilas. -======= + 3. After starting a discussion about your new project for AsyncAPI and successfully convinced other community members why your project ideas are necessary, and you want to maintain the codebase. From e12d2337558295387880031a929646cd77cc9545 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Thu, 29 Sep 2022 11:02:50 +0100 Subject: [PATCH 25/43] Update docs on new repo creation --- docs/how-to-create-new-repository.md | 33 +++++----------------------- 1 file changed, 5 insertions(+), 28 deletions(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 8cca0990b..45d79be44 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -21,28 +21,13 @@ To know more about asyncapi `CI/CD` watch this [video](https://www.youtube.com/w 5. Your proposal for a new repository must be approved by Technical Steering Committee (TSC). So make sure that at the end of proposal description you mention `@asyncapi/tsc_members` GitHub team to notify all TSC members about voting -6. After getting approval from the TSC, Repo is created by @derberg or @fmvilas, and the `CI/CD workflow` will be push to the Repo. Next, we invite new maintainers as admins of the repo. - +6. After getting approval from the TSC, Repo is created by @derberg or @fmvilas, and the `CI/CD workflow` will be push to the Repo. Next, we invite new maintainers as admins of the repo. +- Configure the repo setting +- Push the AsyncaPI `CI/CD workflow` +- Invite new maintainers as repo admins. ## Github Actions CI/CD in new Repo -Using asyncapi `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by @derberg or @fmvilas. - -3. After starting a discussion about your new project for AsyncAPI and successfully convinced other community members why your project ideas are necessary, and you want to maintain the codebase. - - -4. Additionally, when creating a proposal, specify the initial maintainers of the project and whether you want to use AsyncAPI CI/CD workflows or not, so we don't need to ask you. At least 2 code maintainers are needed to start. - -5. Your proposal for a new repository must be approved by the Technical Steering Committee (TSC). Make sure that at the end of the proposal description you mention the `@asyncapi/tsc_members` GitHub team so as notify all TSC members. - -6. After getting approval from the TSC, the repo is created by either @derberg or @fmvilas. They: - - Configure the repo setting - - Push the AsyncaPI `CI/CD workflow` - - Invite new maintainers as repo admins. -To learn more, watch this [AsyncAPI CI/CD video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) - -## Github Actions CI/CD in new repo -Using AsyncAPI `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by Lukasz or Fran. ->>>>>>> 22ae8aab2424449ba00fcc49460006e6ffb53389 +Using asyncapi `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by @derberg or @fmvilas: 1. Go to Asyncapi `/.github` repo. 2. Click on `Action` to view all workflows. @@ -50,22 +35,14 @@ Using AsyncAPI `CI/CD` workflow saves you from a lot of work load, after includi 4. Click on `run workflow` and paste the name of the new repo. 5. `Run workflow`. -<<<<<<< HEAD One `worklfow` that basically takes all the workflows from `.github` and can selectively be push to a specific repo. -======= -We have a `workflow` that takes all the workflows from `.github` and allows you to push to a specific repo selectively. One of the owners (which at the time of this writing is still Lukasz or Fran) executes these actions. ->>>>>>> 22ae8aab2424449ba00fcc49460006e6ffb53389 The AsyncAPI bot creates a set of `pull requests` for a given repo. You need to `merge` them as a repo's maintainer. If you don't want to use the AsyncAPI global workflow, you will have to manage project automation independently. -<<<<<<< HEAD what user have to do, to make sure their repo never gets CI/CD updates A `pull request` is open in `.github` repo, `global_replicator.yml` is selected and the newly created repo is added to every single `Job` from the `global_replicator.yml` file. Add as **list of repo to be ignore** in `repos_to_ignore: name-of-repo` -======= -We open a `pull request` in the `.github` repo, select `global_replicator.yml` and add the newly created repo to every single `Job` from the `global_replicator.yml` file. Add as **list of repos to be ignored** in `repos_to_ignore: name-of-repo` ->>>>>>> 22ae8aab2424449ba00fcc49460006e6ffb53389 The previous action tells the AsyncAPI bot not constantly push `pull request` to the repo. From dc4cf7443a4809ccf6a7be027a301d0bb0d8c86a Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Tue, 4 Oct 2022 08:45:42 -0700 Subject: [PATCH 26/43] Re-wrote doc This doc had TOO MANY spelling mistakes, grammar issues, and repeating content. Because it was too roughly written I spent time re-writing it so as to make these docs better for our community. --- docs/how-to-create-new-repository.md | 167 +++++++++++++-------------- 1 file changed, 81 insertions(+), 86 deletions(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 45d79be44..8cbaff01a 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -1,114 +1,109 @@ -# How to create a new repository - -This document is not about creating a repository on GitHub. If this is what you were looking for, then [read GitHub's guides on repository creation](https://docs.github.com/en/get-started/quickstart/create-a-repo). - -This document is about creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). This guide explains what is the approval process and default repository configuration options. - -This document is also helpful if you donate a project to the AsyncAPI Initiative, which involves transferring repository ownership and becoming its maintainer. - -## Creating a repo for a new project +# Create new AsyncAPI repository +This guide explains the _approval process_ and the _default repository configurations_ required for creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). We also cover how to _donate a project_ to the AsyncAPI Initiative by transferring repository ownership and becoming its maintainer. +Let's create a new AsyncAPI repository: 1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). - - -2. Start a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the title that you want to create a new repository. In the description specify what is the purpose of the new repository, and why it should be created under the AsyncAPI organization. See also [example discussion from the past](https://github.com/orgs/asyncapi/discussions/300). - -3. Start a conversaction with community members to initialize a new project for AsyncAPI, discuss the project ideas and indicate that you want to be a maintainer of the codebase and at least 2 code maintainers are needed to start - - -4. Specify if you want to use asyncapi CI/CD workflows or not during your discussion about the project, so we don't get to ask you. -To know more about asyncapi `CI/CD` watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) - -5. Your proposal for a new repository must be approved by Technical Steering Committee (TSC). So make sure that at the end of proposal description you mention `@asyncapi/tsc_members` GitHub team to notify all TSC members about voting - -6. After getting approval from the TSC, Repo is created by @derberg or @fmvilas, and the `CI/CD workflow` will be push to the Repo. Next, we invite new maintainers as admins of the repo. -- Configure the repo setting -- Push the AsyncaPI `CI/CD workflow` -- Invite new maintainers as repo admins. - -## Github Actions CI/CD in new Repo -Using asyncapi `CI/CD` workflow saves you from a lot of work load, after including it in your Github discussion/proposal specifing that you want to use our `CI/CD` workflow, the following activities will be carried out by @derberg or @fmvilas: - +2. Create a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the _title_ that you want to create a new repository. In the _description_, specify the new repository's purpose and why it belongs under the AsyncAPI organization. [Sample new discussion example.](https://github.com/orgs/asyncapi/discussions/300). +3. Start a discussion with community members to initialize a new project for AsyncAPI, discuss the project ideas, specify if you want to use AsyncAPI CI/CD workflows, and volunteer to become a maintainer for that project. (At least 2 code maintainers are needed to start.) +To learn more about asyncapi `CI/CD`, watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) +4. The Technical Steering Committee (TSC) must approve the newly proposed repository. Make sure to tag them by adding `@asyncapi/tsc_members` at the end of the proposal description; this notifies all TSC members to vote on the proposed project. +5. If the TSC approves the new repository, then either `@derberg` or `@fmvilas` will take over creating the actual new repository. Next, they'll run AsyncAPI `CI/CD workflows`. +6. Invite new maintainers as repo admins. + +## GitHub Actions: CI/CD workflow +Here are the steps `@derberg` or `@fmvilas` take when running AsyncAPI `CI/CD` workflows: 1. Go to Asyncapi `/.github` repo. -2. Click on `Action` to view all workflows. -3. Select `Global workflow to rule then all`. -4. Click on `run workflow` and paste the name of the new repo. -5. `Run workflow`. - -One `worklfow` that basically takes all the workflows from `.github` and can selectively be push to a specific repo. +2. Click `Action` to view all workflows. +3. Select `Global workflow to rule them all`. +4. Click `run workflow` and paste the name of the new repo. Running the workflow takes all the workflows from the AsyncAPI `.github` repo and runs those on the specified repo. The AsyncAPI bot creates a set of `pull requests` for a given repo. You need to `merge` them as a repo's maintainer. -If you don't want to use the AsyncAPI global workflow, you will have to manage project automation independently. - -what user have to do, to make sure their repo never gets CI/CD updates -A `pull request` is open in `.github` repo, `global_replicator.yml` is selected and the newly created repo is added to every single `Job` from the `global_replicator.yml` file. Add as **list of repo to be ignore** in `repos_to_ignore: name-of-repo` + + Manage project automation independently if you don't want to use the AsyncAPI global workflow. + + +Repos that shouldn't get CI/CD updates must do the following: +Open a `pull request` in the `.github` repo. +Edit the`global_replicator.yml` in the `.github` repo; add the newly created repo to every `Job` under **repos to ignore**. (Example: `repos_to_ignore: your-repo-name`) + -The previous action tells the AsyncAPI bot not constantly push `pull request` to the repo. - -## Configuring the repository -All repositories in `asyncapi` organizations should be similar in structure, settings, and restrictions. Follow these guidelines to adjust settings of a new repository created in one of these organizations. +## Configure repository +All AsyncAPI repositories should be similar in structure, settings, and restrictions. ## Adjust repository options - -Under the repository name, choose the **Settings** tab. Carry out the following actions: - -1. Scroll down to the **Features** section and disable these options: +1. Under your repository name, click the **Settings** tab. +2. Scroll down to the **Features** section and disable these options: - Wikis - Projects - Discussions -As an admin you can always enable **Discussions** when you want. +You can always enable **Discussions** as an admin when you want. -Make sure **Sponsorships** option is enable and `open_collective: asyncapi` is provided. +3. Ensure the **Sponsorships** option is enabled and that `open_collective: asyncapi` is provided. -2. Go to the **Merge button** section and disable these options: +3. Go to the **Merge button** section and _disable_ the following: - Allow merge commits - Allow rebase merging -enable only the **Allow squash merging** option. This option combines all commits into one before merging the changes into the `master` branch. - -3. Make sure option **Automatically delete head branches** is enable +4. Stay on the **Merge button** section and _enable_ the following: +**Allow squash merging** option. This option combines all commits before merging changes into the `master` branch. +Make sure the **Automatically delete head branches** option is enabled. ## SonarCloud scans +Integrate each AsyncAPI repository with `https://sonarcloud.io/organizations/asyncapi/projects` for automated quality and security scans. -Each repository must be integrated with https://sonarcloud.io/organizations/asyncapi/projects for automated quality and security scans. -If your project is not in the list, please add it via https://sonarcloud.io/projects/create. +Add your project to the list via: `https://sonarcloud.io/projects/create`. -Our **CI/CD** is very important so, if you create a repository named `main branch` you have to rename it to `master branch`. -In all our project we name the `master branch` as the `main branch`. + +Our `CI/CD workflows` fail if your repository has a `main branch` because we currently support only `master branch` in our projects. +Should you accidentally forget and create a repository with a `main branch`, remember to rename it to `master branch`. + + ## Branch protection rules -Branch protection is be added by whoever creates the repository, here are the steps: - -- Under the **Setting** tab, click `branches` -- After that you can edith the branch name to `master` while adding branch protection - -Under the **Protect matching branch** you will enable the following: - -- enable `Require a pull request before merging` -- enable `Request approvals` -- enable `Dismiss stale pull request approvals when new commits are push` -- enable `Require review from Code Owners` -- enable `Restrict who can dismiss pull request reviews` this is done only by admin -- enable `Require status check before merging` at this point you have to set your status check for Github action to check before merging pull request. -- enable `Require branch to be up to date before merging` -- enable `Do not allow bypassing the above settings` -- enable `Restrict who can push to matching branches` -- enable `Restrict pushes that create matching branches` - -This setting is required to done by who create the repository. +Branch protection must be added by whoever creates the repository. + +Let's walk through the steps: +1. Under the **Setting** tab, click `branches`. +2. Change the branch name to `master`. +3. **Enable** all of the following settings under **Protect matching branch**: +- `Require a pull request before merging` +- `Request approvals` +- `Dismiss stale pull request approvals when new commits are pushed` +- `Require review from Code Owners` +- `Restrict who can dismiss pull request reviews` _(admin only)_ +- `Require status check before merging` _(This status check runs Github action workflows before merging pull requests.)_ +- `Require branch to be up to date before merging` +- `Do not allow bypassing the above settings` +- `Restrict who can push to matching branches` +- `Restrict pushes that create matching branches` ## Collaborators and teams -This is the point where you give admin role to individual that will be the maintainer of the project. +The AsyncAPI Initiative grants admin roles to project maintainers. -You have to invite the `bot` as a maintainer, it is very important you do. + +Don't forget to add the `AsyncAPI bot` as a maintainer to each project. + ## Codeowners file -This file contains name of the two code owners which are also the admin and also the asyncapi-bot-eve is also added. - -Here is an example to `mcturo` and `magicmatatjahu` requesting to create a [`Design-system`](https://github.com/asyncapi/community/discussions/265) repository and [`An interface/project for describing errors/problems in tools in our organization`](https://github.com/asyncapi/community/discussions/300) repository - -## Donating a project to asyncapi - For donating a project to asyncapi you can click [here](https://github.com/asyncapi/community/discussions/223) for an example. - - same repository setting is applicable to donated project. \ No newline at end of file +The Codeowners file contains the code owners' names; this includes both the admins and the `asyncapi-bot-eve`. + +Checkout the following [`Codeowners file` example from the `/website` repository](https://github.com/asyncapi/website/blob/master/CODEOWNERS): +``` +# This file provides an overview of code owners in this repository. + + # Each line is a file pattern followed by one or more owners. + # The last matching pattern has the most precedence. + # For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/. + + # The default owners are automatically added as reviewers when you open a pull request unless different owners are specified in the file. + * @fmvilas @derberg @mcturco @akshatnema @magicmatatjahu @asyncapi-bot-eve + + # All .md files + *.md @alequetzalli @asyncapi-bot-eve + + README.md @alequetzalli @fmvilas @derberg @mcturco @akshatnema @magicmatatjahu @asyncapi-bot-eve +``` + +## Donate project to AsyncAPI +To donate a project to AsyncAPI, copy the repository settings in the following [sample donated RabbitMQ template for .NET](https://github.com/mr-nuno/dotnet-rabbitmq-template). From 49af752814b78dc31e2f3a5ca7adabf461bc073f Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Oct 2022 22:59:30 +0100 Subject: [PATCH 27/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 8cbaff01a..0b0788b47 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -39,7 +39,7 @@ All AsyncAPI repositories should be similar in structure, settings, and restrict - Discussions You can always enable **Discussions** as an admin when you want. -3. Ensure the **Sponsorships** option is enabled and that `open_collective: asyncapi` is provided. +3. Ensure the **Sponsorships** option is enabled. 3. Go to the **Merge button** section and _disable_ the following: - Allow merge commits From d8435da833d942a8aa215cd71fd9e2c6b6ba0267 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Oct 2022 23:00:15 +0100 Subject: [PATCH 28/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 0b0788b47..72a334ca8 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -47,7 +47,8 @@ You can always enable **Discussions** as an admin when you want. 4. Stay on the **Merge button** section and _enable_ the following: **Allow squash merging** option. This option combines all commits before merging changes into the `master` branch. -Make sure the **Automatically delete head branches** option is enabled. + +5. Make sure the **Automatically delete head branches** option is enabled. ## SonarCloud scans Integrate each AsyncAPI repository with `https://sonarcloud.io/organizations/asyncapi/projects` for automated quality and security scans. From fc2e1cf149111b3c1f771b01600d300f5bda978e Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Oct 2022 23:00:39 +0100 Subject: [PATCH 29/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 72a334ca8..29c9cbffe 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -83,7 +83,7 @@ Let's walk through the steps: The AsyncAPI Initiative grants admin roles to project maintainers. -Don't forget to add the `AsyncAPI bot` as a maintainer to each project. +Don't forget to add the `[bots](https://github.com/orgs/asyncapi/teams/bots)` team as a maintainer to each project. ## Codeowners file From 5dbc9f62be5880b36a8cc1b2c8cc07cd3df8f5b3 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Oct 2022 23:04:00 +0100 Subject: [PATCH 30/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 29c9cbffe..afdba1d5d 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -93,17 +93,17 @@ Checkout the following [`Codeowners file` example from the `/website` repository ``` # This file provides an overview of code owners in this repository. - # Each line is a file pattern followed by one or more owners. - # The last matching pattern has the most precedence. - # For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/. +# Each line is a file pattern followed by one or more owners. +# The last matching pattern has the most precedence. +# For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/. - # The default owners are automatically added as reviewers when you open a pull request unless different owners are specified in the file. - * @fmvilas @derberg @mcturco @akshatnema @magicmatatjahu @asyncapi-bot-eve +# The default owners are automatically added as reviewers when you open a pull request unless different owners are specified in the file. +* @fmvilas @derberg @mcturco @akshatnema @magicmatatjahu @asyncapi-bot-eve - # All .md files - *.md @alequetzalli @asyncapi-bot-eve +# All .md files +*.md @alequetzalli @asyncapi-bot-eve - README.md @alequetzalli @fmvilas @derberg @mcturco @akshatnema @magicmatatjahu @asyncapi-bot-eve +README.md @alequetzalli @fmvilas @derberg @mcturco @akshatnema @magicmatatjahu @asyncapi-bot-eve ``` ## Donate project to AsyncAPI From 73ab860644226ab913aead1da12574e5c98ba2fb Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Oct 2022 23:09:44 +0100 Subject: [PATCH 31/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index afdba1d5d..b577bfdda 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -1,4 +1,3 @@ -# Create new AsyncAPI repository This guide explains the _approval process_ and the _default repository configurations_ required for creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). We also cover how to _donate a project_ to the AsyncAPI Initiative by transferring repository ownership and becoming its maintainer. Let's create a new AsyncAPI repository: From 2f50a55ad7554fb2eda5d8dc4308d942cb7e17a0 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Oct 2022 23:15:21 +0100 Subject: [PATCH 32/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index b577bfdda..2788e8f89 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -1,5 +1,6 @@ This guide explains the _approval process_ and the _default repository configurations_ required for creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). We also cover how to _donate a project_ to the AsyncAPI Initiative by transferring repository ownership and becoming its maintainer. +## Getting a new AsyncAPI repository approved Let's create a new AsyncAPI repository: 1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). 2. Create a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the _title_ that you want to create a new repository. In the _description_, specify the new repository's purpose and why it belongs under the AsyncAPI organization. [Sample new discussion example.](https://github.com/orgs/asyncapi/discussions/300). From 824aa28748d8940c10652219caf9f987a07357ee Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Oct 2022 23:15:50 +0100 Subject: [PATCH 33/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 2788e8f89..fe25e2070 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -1,7 +1,7 @@ This guide explains the _approval process_ and the _default repository configurations_ required for creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). We also cover how to _donate a project_ to the AsyncAPI Initiative by transferring repository ownership and becoming its maintainer. ## Getting a new AsyncAPI repository approved -Let's create a new AsyncAPI repository: +In case you want to donate existing project to AsyncAPI organization, or start a new project, follow below steps: 1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). 2. Create a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the _title_ that you want to create a new repository. In the _description_, specify the new repository's purpose and why it belongs under the AsyncAPI organization. [Sample new discussion example.](https://github.com/orgs/asyncapi/discussions/300). 3. Start a discussion with community members to initialize a new project for AsyncAPI, discuss the project ideas, specify if you want to use AsyncAPI CI/CD workflows, and volunteer to become a maintainer for that project. (At least 2 code maintainers are needed to start.) From 0f05345983e02d81565446926038102464924138 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Oct 2022 23:20:04 +0100 Subject: [PATCH 34/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index fe25e2070..48bf001ae 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -73,7 +73,7 @@ Let's walk through the steps: - `Dismiss stale pull request approvals when new commits are pushed` - `Require review from Code Owners` - `Restrict who can dismiss pull request reviews` _(admin only)_ -- `Require status check before merging` _(This status check runs Github action workflows before merging pull requests.)_ +- `Require status check before merging` _(This status check runs Github action workflows before merging pull requests.)_ and select `Lint PR title` and pull request testing related workflows - `Require branch to be up to date before merging` - `Do not allow bypassing the above settings` - `Restrict who can push to matching branches` From 8f93cfa83efc0ec55245134fe0a6f9adeabda0c8 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Oct 2022 23:22:20 +0100 Subject: [PATCH 35/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 48bf001ae..cae517f67 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -77,7 +77,6 @@ Let's walk through the steps: - `Require branch to be up to date before merging` - `Do not allow bypassing the above settings` - `Restrict who can push to matching branches` -- `Restrict pushes that create matching branches` ## Collaborators and teams The AsyncAPI Initiative grants admin roles to project maintainers. From c4c8c48ea6bc6ac4ef4f04f497544808be2504c5 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Wed, 26 Oct 2022 20:08:57 +0100 Subject: [PATCH 36/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index cae517f67..1ce41eefd 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -29,7 +29,7 @@ Edit the`global_replicator.yml` in the `.github` repo; add the newly created rep ## Configure repository -All AsyncAPI repositories should be similar in structure, settings, and restrictions. +All AsyncAPI repositories start with the same settings and restrictions. It is up to maintainers of given repository to modify settings if these disrupt maintenance. ## Adjust repository options 1. Under your repository name, click the **Settings** tab. From 7522337b4d0da9b3d4665e1955bccc362c8e7310 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Thu, 16 Mar 2023 07:49:19 +0100 Subject: [PATCH 37/43] Update docs/how-to-create-new-repository.md Co-authored-by: Lukasz Gornicki --- docs/how-to-create-new-repository.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/how-to-create-new-repository.md b/docs/how-to-create-new-repository.md index 1ce41eefd..fc1f495cf 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/how-to-create-new-repository.md @@ -1,5 +1,6 @@ This guide explains the _approval process_ and the _default repository configurations_ required for creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). We also cover how to _donate a project_ to the AsyncAPI Initiative by transferring repository ownership and becoming its maintainer. +## Getting a new AsyncAPI repository approved ## Getting a new AsyncAPI repository approved In case you want to donate existing project to AsyncAPI organization, or start a new project, follow below steps: 1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). From daa273a9439bc85323de056ba5d1f849ededdc65 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Thu, 16 Mar 2023 08:08:57 +0100 Subject: [PATCH 38/43] I made some changed to this files. --- ...ository.md => Create-Repository-as-an-admin.md} | 14 +------------- docs/Donate-a-project.md | 4 ++++ docs/Getting-a-new-AsyncAPI-repository-approved.md | 9 +++++++++ 3 files changed, 14 insertions(+), 13 deletions(-) rename docs/{how-to-create-new-repository.md => Create-Repository-as-an-admin.md} (68%) create mode 100644 docs/Donate-a-project.md create mode 100644 docs/Getting-a-new-AsyncAPI-repository-approved.md diff --git a/docs/how-to-create-new-repository.md b/docs/Create-Repository-as-an-admin.md similarity index 68% rename from docs/how-to-create-new-repository.md rename to docs/Create-Repository-as-an-admin.md index 1ce41eefd..526e2fe72 100644 --- a/docs/how-to-create-new-repository.md +++ b/docs/Create-Repository-as-an-admin.md @@ -1,14 +1,4 @@ -This guide explains the _approval process_ and the _default repository configurations_ required for creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). We also cover how to _donate a project_ to the AsyncAPI Initiative by transferring repository ownership and becoming its maintainer. - -## Getting a new AsyncAPI repository approved -In case you want to donate existing project to AsyncAPI organization, or start a new project, follow below steps: -1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). -2. Create a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the _title_ that you want to create a new repository. In the _description_, specify the new repository's purpose and why it belongs under the AsyncAPI organization. [Sample new discussion example.](https://github.com/orgs/asyncapi/discussions/300). -3. Start a discussion with community members to initialize a new project for AsyncAPI, discuss the project ideas, specify if you want to use AsyncAPI CI/CD workflows, and volunteer to become a maintainer for that project. (At least 2 code maintainers are needed to start.) -To learn more about asyncapi `CI/CD`, watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) -4. The Technical Steering Committee (TSC) must approve the newly proposed repository. Make sure to tag them by adding `@asyncapi/tsc_members` at the end of the proposal description; this notifies all TSC members to vote on the proposed project. -5. If the TSC approves the new repository, then either `@derberg` or `@fmvilas` will take over creating the actual new repository. Next, they'll run AsyncAPI `CI/CD workflows`. -6. Invite new maintainers as repo admins. +Here are technical steps taken by organization admins while creating a repository for a project. ## GitHub Actions: CI/CD workflow Here are the steps `@derberg` or `@fmvilas` take when running AsyncAPI `CI/CD` workflows: @@ -105,5 +95,3 @@ Checkout the following [`Codeowners file` example from the `/website` repository README.md @alequetzalli @fmvilas @derberg @mcturco @akshatnema @magicmatatjahu @asyncapi-bot-eve ``` -## Donate project to AsyncAPI -To donate a project to AsyncAPI, copy the repository settings in the following [sample donated RabbitMQ template for .NET](https://github.com/mr-nuno/dotnet-rabbitmq-template). diff --git a/docs/Donate-a-project.md b/docs/Donate-a-project.md new file mode 100644 index 000000000..6935e5b71 --- /dev/null +++ b/docs/Donate-a-project.md @@ -0,0 +1,4 @@ +This guide explains the _approval process_ and the _default repository configurations_ required for creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). We also cover how to _donate a project_ to the AsyncAPI Initiative by transferring repository ownership and becoming its maintainer. + +## Donate project to AsyncAPI +To donate a project to AsyncAPI, copy the repository settings in the following [sample donated RabbitMQ template for .NET](https://github.com/mr-nuno/dotnet-rabbitmq-template). \ No newline at end of file diff --git a/docs/Getting-a-new-AsyncAPI-repository-approved.md b/docs/Getting-a-new-AsyncAPI-repository-approved.md new file mode 100644 index 000000000..8569721d2 --- /dev/null +++ b/docs/Getting-a-new-AsyncAPI-repository-approved.md @@ -0,0 +1,9 @@ +## Getting a new AsyncAPI repository approved +In case you want to donate existing project to AsyncAPI organization, or start a new project, follow below steps: +1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). +2. Create a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the _title_ that you want to create a new repository. In the _description_, specify the new repository's purpose and why it belongs under the AsyncAPI organization. [Sample new discussion example.](https://github.com/orgs/asyncapi/discussions/300). +3. Start a discussion with community members to initialize a new project for AsyncAPI, discuss the project ideas, specify if you want to use AsyncAPI CI/CD workflows, and volunteer to become a maintainer for that project. (At least 2 code maintainers are needed to start.) +To learn more about asyncapi `CI/CD`, watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) +4. The Technical Steering Committee (TSC) must approve the newly proposed repository. Make sure to tag them by adding `@asyncapi/tsc_members` at the end of the proposal description; this notifies all TSC members to vote on the proposed project. +5. If the TSC approves the new repository, then either `@derberg` or `@fmvilas` will take over creating the actual new repository. Next, they'll run AsyncAPI `CI/CD workflows`. +6. Invite new maintainers as repo admins. \ No newline at end of file From 7d2364ddbbfc06ada33ec64fb43d5dbeff305505 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Thu, 16 Mar 2023 08:13:19 +0100 Subject: [PATCH 39/43] Updates docs by creating new markdown files --- docs/Create-Repository-as-an-admin.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/Create-Repository-as-an-admin.md b/docs/Create-Repository-as-an-admin.md index 1ce41eefd..20fe4d8db 100644 --- a/docs/Create-Repository-as-an-admin.md +++ b/docs/Create-Repository-as-an-admin.md @@ -1,14 +1,4 @@ -This guide explains the _approval process_ and the _default repository configurations_ required for creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). We also cover how to _donate a project_ to the AsyncAPI Initiative by transferring repository ownership and becoming its maintainer. - -## Getting a new AsyncAPI repository approved -In case you want to donate existing project to AsyncAPI organization, or start a new project, follow below steps: -1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). -2. Create a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the _title_ that you want to create a new repository. In the _description_, specify the new repository's purpose and why it belongs under the AsyncAPI organization. [Sample new discussion example.](https://github.com/orgs/asyncapi/discussions/300). -3. Start a discussion with community members to initialize a new project for AsyncAPI, discuss the project ideas, specify if you want to use AsyncAPI CI/CD workflows, and volunteer to become a maintainer for that project. (At least 2 code maintainers are needed to start.) -To learn more about asyncapi `CI/CD`, watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) -4. The Technical Steering Committee (TSC) must approve the newly proposed repository. Make sure to tag them by adding `@asyncapi/tsc_members` at the end of the proposal description; this notifies all TSC members to vote on the proposed project. -5. If the TSC approves the new repository, then either `@derberg` or `@fmvilas` will take over creating the actual new repository. Next, they'll run AsyncAPI `CI/CD workflows`. -6. Invite new maintainers as repo admins. +Here are technical steps taken by organization admins while creating a repository for a project. ## GitHub Actions: CI/CD workflow Here are the steps `@derberg` or `@fmvilas` take when running AsyncAPI `CI/CD` workflows: From f84617e7f37ca27c5fe86792d56ddffa92ee25aa Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Thu, 16 Mar 2023 08:17:58 +0100 Subject: [PATCH 40/43] Update docs: moved donate-a-project --- docs/Create-Repository-as-an-admin.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/Create-Repository-as-an-admin.md b/docs/Create-Repository-as-an-admin.md index 20fe4d8db..02148638a 100644 --- a/docs/Create-Repository-as-an-admin.md +++ b/docs/Create-Repository-as-an-admin.md @@ -94,6 +94,3 @@ Checkout the following [`Codeowners file` example from the `/website` repository README.md @alequetzalli @fmvilas @derberg @mcturco @akshatnema @magicmatatjahu @asyncapi-bot-eve ``` - -## Donate project to AsyncAPI -To donate a project to AsyncAPI, copy the repository settings in the following [sample donated RabbitMQ template for .NET](https://github.com/mr-nuno/dotnet-rabbitmq-template). From 404d6f6588b49483acf9fb5922f6e61cf7d84ad9 Mon Sep 17 00:00:00 2001 From: Dule Martins Date: Fri, 28 Jul 2023 11:06:50 +0100 Subject: [PATCH 41/43] Merge branch 'master' of https://github.com/Dule-martins/community-1 --- docs/Donate-a-project.md | 4 ---- docs/Getting-a-new-AsyncAPI-repository-approved.md | 9 ++++++--- docs/README.md | 3 +++ 3 files changed, 9 insertions(+), 7 deletions(-) delete mode 100644 docs/Donate-a-project.md diff --git a/docs/Donate-a-project.md b/docs/Donate-a-project.md deleted file mode 100644 index 6935e5b71..000000000 --- a/docs/Donate-a-project.md +++ /dev/null @@ -1,4 +0,0 @@ -This guide explains the _approval process_ and the _default repository configurations_ required for creating a new repository in the [AsyncAPI Initiative GitHub organization](https://github.com/asyncapi). We also cover how to _donate a project_ to the AsyncAPI Initiative by transferring repository ownership and becoming its maintainer. - -## Donate project to AsyncAPI -To donate a project to AsyncAPI, copy the repository settings in the following [sample donated RabbitMQ template for .NET](https://github.com/mr-nuno/dotnet-rabbitmq-template). \ No newline at end of file diff --git a/docs/Getting-a-new-AsyncAPI-repository-approved.md b/docs/Getting-a-new-AsyncAPI-repository-approved.md index 8569721d2..629f0477b 100644 --- a/docs/Getting-a-new-AsyncAPI-repository-approved.md +++ b/docs/Getting-a-new-AsyncAPI-repository-approved.md @@ -1,9 +1,12 @@ ## Getting a new AsyncAPI repository approved -In case you want to donate existing project to AsyncAPI organization, or start a new project, follow below steps: +To donate existing project to AsyncAPI organization, or start a new project, follow the instruction below: 1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). -2. Create a new discussion by clicking on `New discussion` and selecting the `Idea` category. Specify in the _title_ that you want to create a new repository. In the _description_, specify the new repository's purpose and why it belongs under the AsyncAPI organization. [Sample new discussion example.](https://github.com/orgs/asyncapi/discussions/300). +2. Create a new discussion by clicking on `New discussion` and select the `Idea` category. Specify in the _title_ that you want to create a new repository. In the _description_, state the purpose of the new repository and why it should be part of the AsyncAPI organization. [Sample new discussion example.](https://github.com/orgs/asyncapi/discussions/300). 3. Start a discussion with community members to initialize a new project for AsyncAPI, discuss the project ideas, specify if you want to use AsyncAPI CI/CD workflows, and volunteer to become a maintainer for that project. (At least 2 code maintainers are needed to start.) To learn more about asyncapi `CI/CD`, watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) 4. The Technical Steering Committee (TSC) must approve the newly proposed repository. Make sure to tag them by adding `@asyncapi/tsc_members` at the end of the proposal description; this notifies all TSC members to vote on the proposed project. 5. If the TSC approves the new repository, then either `@derberg` or `@fmvilas` will take over creating the actual new repository. Next, they'll run AsyncAPI `CI/CD workflows`. -6. Invite new maintainers as repo admins. \ No newline at end of file +6. Invite new maintainers as repo admins. + +To see how existing project is been donated to AsyncAPI, click [here](https://github.com/orgs/asyncapi/discussions/223) +[Here](https://github.com/orgs/asyncapi/discussions/300) is an example of starting a new project under AsyncAPI \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index e69de29bb..d23ccf0e3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -0,0 +1,3 @@ +## Community Documentation + +The community documentation directory helps the community collaboratively maintain a collection of helpful community-related documentation. From becoming an AsyncAPI contributor to becoming a TSC member, and beyond. From 49b9bc88e174ecc8bf08be3f2ea684a2cabb4ec7 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Mon, 4 Sep 2023 18:07:40 +0100 Subject: [PATCH 42/43] Update docs/Getting-a-new-AsyncAPI-repository-approved.md Accepted suggestion coming from @derberg Co-authored-by: Lukasz Gornicki --- ...tting-a-new-AsyncAPI-repository-approved.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/Getting-a-new-AsyncAPI-repository-approved.md b/docs/Getting-a-new-AsyncAPI-repository-approved.md index 629f0477b..2245d7b51 100644 --- a/docs/Getting-a-new-AsyncAPI-repository-approved.md +++ b/docs/Getting-a-new-AsyncAPI-repository-approved.md @@ -1,12 +1,10 @@ -## Getting a new AsyncAPI repository approved To donate existing project to AsyncAPI organization, or start a new project, follow the instruction below: -1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). -2. Create a new discussion by clicking on `New discussion` and select the `Idea` category. Specify in the _title_ that you want to create a new repository. In the _description_, state the purpose of the new repository and why it should be part of the AsyncAPI organization. [Sample new discussion example.](https://github.com/orgs/asyncapi/discussions/300). -3. Start a discussion with community members to initialize a new project for AsyncAPI, discuss the project ideas, specify if you want to use AsyncAPI CI/CD workflows, and volunteer to become a maintainer for that project. (At least 2 code maintainers are needed to start.) -To learn more about asyncapi `CI/CD`, watch this [video](https://www.youtube.com/watch?v=DsQfmlc3Ubo) -4. The Technical Steering Committee (TSC) must approve the newly proposed repository. Make sure to tag them by adding `@asyncapi/tsc_members` at the end of the proposal description; this notifies all TSC members to vote on the proposed project. -5. If the TSC approves the new repository, then either `@derberg` or `@fmvilas` will take over creating the actual new repository. Next, they'll run AsyncAPI `CI/CD workflows`. -6. Invite new maintainers as repo admins. -To see how existing project is been donated to AsyncAPI, click [here](https://github.com/orgs/asyncapi/discussions/223) -[Here](https://github.com/orgs/asyncapi/discussions/300) is an example of starting a new project under AsyncAPI \ No newline at end of file +1. Visit [AsyncAPI Initiative Discussions](https://github.com/orgs/asyncapi/discussions). +2. Create a new discussion by clicking on `New discussion` and select the `Idea` category. Specify in the _title_ that you want to create a new repository or donate existing project. In the _description_, state the purpose of the new repository and why it should be part of the AsyncAPI organization. + - [Sample discussion about starting new project](https://github.com/orgs/asyncapi/discussions/300) + - [Sample discussion about donating existing project](https://github.com/orgs/asyncapi/discussions/643) +3. Start a discussion with community members, discuss the project ideas, specify if you want to use AsyncAPI CI/CD workflows, and volunteer to become a maintainer for that project. (At least 2 code maintainers are needed to start). To learn more about AsyncAPI CI/CD, watch [this video](https://www.youtube.com/watch?v=DsQfmlc3Ubo). +4. The Technical Steering Committee (TSC) must approve the newly proposed repository. Make sure to tag them by adding `@asyncapi/tsc_members` at the end of the proposal description. This notifies all TSC members to vote on the proposed project. +5. If the TSC approves the new repository, then either `@derberg` or `@fmvilas` will take over creating the actual new repository. Next, they'll run AsyncAPI CI/CD workflows to push basic GitHub Actions workflows to new repository. +6. New maintainers will be invited as repo admins. \ No newline at end of file From f0abbfd8524f69fefdf438797a592186f60d0fb3 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Mon, 4 Sep 2023 18:09:10 +0100 Subject: [PATCH 43/43] Update docs/Create-Repository-as-an-admin.md Same action taken with this Co-authored-by: Lukasz Gornicki --- docs/Create-Repository-as-an-admin.md | 65 +++++++++++++++------------ 1 file changed, 36 insertions(+), 29 deletions(-) diff --git a/docs/Create-Repository-as-an-admin.md b/docs/Create-Repository-as-an-admin.md index 02148638a..21b095231 100644 --- a/docs/Create-Repository-as-an-admin.md +++ b/docs/Create-Repository-as-an-admin.md @@ -1,60 +1,50 @@ Here are technical steps taken by organization admins while creating a repository for a project. -## GitHub Actions: CI/CD workflow -Here are the steps `@derberg` or `@fmvilas` take when running AsyncAPI `CI/CD` workflows: -1. Go to Asyncapi `/.github` repo. -2. Click `Action` to view all workflows. -3. Select `Global workflow to rule them all`. -4. Click `run workflow` and paste the name of the new repo. Running the workflow takes all the workflows from the AsyncAPI `.github` repo and runs those on the specified repo. - -The AsyncAPI bot creates a set of `pull requests` for a given repo. You need to `merge` them as a repo's maintainer. - - - Manage project automation independently if you don't want to use the AsyncAPI global workflow. - - -Repos that shouldn't get CI/CD updates must do the following: -Open a `pull request` in the `.github` repo. -Edit the`global_replicator.yml` in the `.github` repo; add the newly created repo to every `Job` under **repos to ignore**. (Example: `repos_to_ignore: your-repo-name`) - - ## Configure repository + All AsyncAPI repositories start with the same settings and restrictions. It is up to maintainers of given repository to modify settings if these disrupt maintenance. -## Adjust repository options +### Adjust repository options + 1. Under your repository name, click the **Settings** tab. + 2. Scroll down to the **Features** section and disable these options: - Wikis - Projects - Discussions -You can always enable **Discussions** as an admin when you want. + + You can always enable **Discussions** as an admin when you want. 3. Ensure the **Sponsorships** option is enabled. -3. Go to the **Merge button** section and _disable_ the following: +3. Go to the **Merge button** section and disable the following: - Allow merge commits - Allow rebase merging -4. Stay on the **Merge button** section and _enable_ the following: +4. Stay on the **Merge button** section and enable the following: + **Allow squash merging** option. This option combines all commits before merging changes into the `master` branch. 5. Make sure the **Automatically delete head branches** option is enabled. +6. If new repository will use AsyncAPI CI/CD then check in [.github repository documentation](https://github.com/asyncapi/.github) what special repository topics need to be added to the repository. + ## SonarCloud scans + Integrate each AsyncAPI repository with `https://sonarcloud.io/organizations/asyncapi/projects` for automated quality and security scans. -Add your project to the list via: `https://sonarcloud.io/projects/create`. +Add project to the list via: `https://sonarcloud.io/projects/create`. -Our `CI/CD workflows` fail if your repository has a `main branch` because we currently support only `master branch` in our projects. +AsyncAPI CI/CD workflows fail if your repository has a `main branch` because we currently support only `master branch` in our projects. Should you accidentally forget and create a repository with a `main branch`, remember to rename it to `master branch`. ## Branch protection rules -Branch protection must be added by whoever creates the repository. -Let's walk through the steps: +Branch protection must be added by whoever creates the repository: + 1. Under the **Setting** tab, click `branches`. 2. Change the branch name to `master`. 3. **Enable** all of the following settings under **Protect matching branch**: @@ -68,18 +58,36 @@ Let's walk through the steps: - `Do not allow bypassing the above settings` - `Restrict who can push to matching branches` +## GitHub Actions: CI/CD workflow + +Here are the steps `@derberg` or `@fmvilas` take when running AsyncAPI CI/CD workflows: +1. Go to `.github` repo. +2. Click `Action` to view all workflows. +3. Select `Global workflow to rule them all`. +4. Click `Run workflow` and paste the name of the new repo. Running the workflow takes all the workflows from the AsyncAPI `.github` repo and runs those on the specified repo. + +The AsyncAPI bot creates a `pull requests` for a given repo. You need to merge them as a repo's maintainer. + + +Repos that shouldn't get CI/CD updates must do the following: +- Open a `pull request` in the `.github` repo. +- Edit the`global_replicator.yml` in the `.github` repo; add the newly created repo to every job under **repos to ignore**. (Example: `repos_to_ignore: your-repo-name`) + + ## Collaborators and teams + The AsyncAPI Initiative grants admin roles to project maintainers. -Don't forget to add the `[bots](https://github.com/orgs/asyncapi/teams/bots)` team as a maintainer to each project. +Don't forget to add the `[bots](https://github.com/orgs/asyncapi/teams/bots)` team as a maintainer to each project. It is required for automation to work. ## Codeowners file + The Codeowners file contains the code owners' names; this includes both the admins and the `asyncapi-bot-eve`. Checkout the following [`Codeowners file` example from the `/website` repository](https://github.com/asyncapi/website/blob/master/CODEOWNERS): -``` +```plaintext # This file provides an overview of code owners in this repository. # Each line is a file pattern followed by one or more owners. @@ -93,4 +101,3 @@ Checkout the following [`Codeowners file` example from the `/website` repository *.md @alequetzalli @asyncapi-bot-eve README.md @alequetzalli @fmvilas @derberg @mcturco @akshatnema @magicmatatjahu @asyncapi-bot-eve -```