From ddf8fd7999e2c9e49f6763ed7ef65ad92b1b67ac Mon Sep 17 00:00:00 2001 From: anaxceron Date: Wed, 13 Nov 2024 15:33:54 -0500 Subject: [PATCH 01/10] adding powershell troubleshoot doc Signed-off-by: anaxceron --- .../cli/PowerShell_developer_setting.png | Bin 0 -> 20834 bytes docs/troubleshoot/cli/known-cli.md | 29 ++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 docs/images/troubleshoot/cli/PowerShell_developer_setting.png diff --git a/docs/images/troubleshoot/cli/PowerShell_developer_setting.png b/docs/images/troubleshoot/cli/PowerShell_developer_setting.png new file mode 100644 index 0000000000000000000000000000000000000000..e25f909823276ea3a792a439fee994934a3338ff GIT binary patch literal 20834 zcmd43XHZjX{4T1}R6tPN(u<-X3PgGjvgu6(R6t4u1Pl-msi6cB6%gq?lvpUD^b$I# zAfbgoLJv(!kPZpO5CV6x|7Y%(`{B-=IdkTIfSD|kEY@3}-&5Y0`}g$O&-0x>b?Owm zp@ELYsZ(dhPn|k#dzKlva%w7h0Qh~{*Fyi_Q)T@E%fJgpH!V}GQ>Q8uSPvbUfY;}q z8`$`sI(6m7$YJhAWv`XyEdYOr$4pvDle;9JpwKVXFe(lONCf)EIav zDA$z^yhqhFQR?J_egC^Z$hY)^MYx32mzDCCeevDxGJ{pk!>#sJ2@mY+L*Rz&PXBXX z&rYUsb7LDm5)K8)eg5;@uwdY%Ij9uzWmjYVz1-K9y$KIH74p$5R_QMeLBHPw8=m~L z&_}~h%N<%88@!xdL*q!{(~h1=Dv&39=`RJMx~rYG%K6{~>L&?YRDTj&Fal5PTuY{rAr|P+s?^ z-p$*cJC8q?HElFjB0XNMek*TPRj7=SRVR0eelwPC$PeCVSnBLC2fk_w>CXZ7s>Uh~ zE46ON9oRpd3LwIUySfbM_eLE;V0^*>V~!H_UfL=LOuEU}p}~EPBK(Zej7cAI(IZvr zK<_Cw+weYJns{a84lV93&`);VyuQ{r~K_m&sW5=clIZJaq@bMZ)6gt4IY&~PIE8d{bMgGwD;LV z?bU!C<1fb4g4u*wMUE@NVLO8d!;gn1J7uE;UKsGPyt*f(!w46(z5#g;=NO?cg2Gi= zyeNYS2ziB!7@XYJebFFgdH3q^&al04H+*epDhILNbG*tOi&TJWq`JuuUoBUEX7dwW zg)nik1tyPcfy1oa=foRtZy2W!S&j^|ree}pnP9s^NlCh~SK>@JnId`FtHqmP?|e2}B8PK3-*`Q0;Jl`b!OGeE+|Y7n~+eJ|7rwqf#;T72MzI+voh`xZ24&B`zn6=(?_nH`!uDV@k zVVX5x9k1(u9rf8}R4jWolW#)(dndt6Gq>|ly#346#*$JvMTwy7?Hu<^-}DZWWx$-s zrxm1rJxeo`CjxvL=D=`B?gfpOe_i>`z#*`|_)$eC7?{v{d`h|%>KAu5F8&B$L=PQs zoUb9ef24KSr9}xD6M5P{{5M-lT|E;`Eg4=d^UR&rLu&1?9wA%eYQ_i&w3%ZBpS~2;FIogHdlo%j`0SGQhuqPBfpxl= zA6T!vj%;@kuoB+_Ax)#{;MLND;l^tQ@vdz03?I)i{(uf86FgYH#Kq+qe2VD??v~Mc zW9TMVDhJ<2<7(Lf*VHEs|Ga={u@;X*zWWns(jEJgo~rrS*GResL+o0GE5t#M%vTWQ z67IRiSkSXr6W_N%12V{WI$ReQj{TEeuMJ+wBHh9&60*Hp;qG@k9ldk#cRs;vek&;<^m?3d@Sl&B zd^;AwLqGL{fd$rJo?VLEH2lc6z{iRVYoYHE3D&^KwyYjx9G9Pub`>&Cm*m|aaN;_? zq#i7xLR+gQ)Jq)QP(3Yw8cuQ4)8V+*7d{)of?vgl!x>u&UIq-%k5t$c<_>N5yRXgU z58@O??d0~pFKMv|rgqvthWs~5En)Iniqb7R_y@5@rwq3Y?&Pu%hm5#hlR-azgv)xa z#=Opx;p{~Z-{%VDs?gjUbA~>qw5h*MF$2R(py#LlUbG{@=M@Og_URp5W1%f-jK@`mMvC2aDgT9Oq z;CWYyJ=mLs#TrZ7Nhb?|_QV(WDy{VwJLd#B_Lr;afjgRwW(=W93P(o1Wanot1CpBbI(Yn7B)-%deZ7F7u70SxgWb zTD!@?-%Q6#&Q_iKTmQTdrP-GEX}N>x;LGQDqjFH&A$es$o5QsH29&dG7#ndn_SAFd zb2VcZ(BikQk$-@`CjSIJ*+yUYwmLyckIEhFHFk$AcZcFwxLu@2oHObp5XriEnV zuSrQs?#J}~@}j;_w;Uh6iASb=Cv$TBpDPp+))+FtdqwK;gO;O%)!~Mvylh0;ymB_S zo@Kp;a1R<%|F$DQ+OGc2RFS-c)hKb-XVS<%ds|CUftfJ`MVnm0zscr;Ia7egdzhek z6h!xG51ES*#|L2q15KQA?;cWcMNhI7Ks_udBQh(_Mm4(CymKBx5UybmEvvaYad(N*8$KQj#hHSP3))Kv%hApobdv>yn z&m5AJ2xdPIhx`CsT7(iLo`E6W<(mrpHO!f~JWUy3;s{V6GT_xCsgk{BFH6KHhS>?B zk$k-A_GnKV4VUJi%#zX=;}R4~(C7PUmiMJ?63EjXq2y7}6sf8`ROO?9_0dMt=Dp2% z3Y>DLCvp8MZ=Sro$;Pd$4kAH(jzGu>;#p!-(`N$y7c?ziw;QYspK59Sd=^5 zOo;4!jhjfYQzQ=@3M~HGZdZTn7+(;2>{HU|mJLl=QeVGW9W!U$OK?1v?}Y+5*LEp0 zUvdlq&gOT8Fc->{m%jgG2Q3>IlJxCtF53GiNoX-^-Z!NI!G<5PdkM1xANt~FZkq2#DwL6jPtrfGOW!UuDmxM&FeBF%A74Uzb8qQEDu7d z%|(lL7An-$!pr05(QwGMsk;t;=eQ_HYKmg!v}s`H<68HB;`a3(l~|jb@$zOVc~5u! ze8ajLI4=mGZYUMNa|MgRN_p}fJ4~!shK%DMH@t8`-V1JFbvqE~1vxY;w|JNFn}}-c zNPqw3#{hqp9X0&TDxnurg1V}606*f9%Z27A*|vsKt%XEO4K&T_UX!2jk_CI^?g*|W z+{{ofuT)=5cNQYdQ=(3efd%5r zo2<;~y%}!dX<$MJIO|$Bja_|LJzEG_<9X!{9bIO}$O*4oO41wbei^ zUOTlgE%5@pYqWiD3(QT8S$Ao$PWOq1Nv2tu05E!?Ql9c6#)abRH{hc-z8YNv?)xL6 zCM~T}=<}~aq;bc&$LD{lWMyT{+@BNc7-+t`#JwQUTb1{{F>|EPEI+rroSmB?UCN#( ztN;6(>)fdBB44fRI8P5Qxa;)o@@5M&DEH#nWvG1b`R%Mwek0;Pi^-5v&W|N#WI!NF z{kg@PQT1n+Tz(>;_in==CLW}#BQxrS6Fsl?C2@(~frgCoSkMcsbBuo_mdbvmJ>C1s zbdHMeJBktXR}HBV=#Y&_>sEMQbtoc|&7{}6@S~qsMxq14?ln5}B^>55aM{IXLI|w^ zQKH?MX;t1pu4Z+$J{?D|pH0FzzFOlveb3U}Ar z^(stk;kq`9*QOjdhi?`{*2e=-U2Qkj92;uD|FcnljqRr)vH6rfX9~pg-<;P4DY3DS zDf#iNR?F8C&i{=lP2{q2)`iV_o94#hKzuE1NmBbI#F`;y4yNU9orI;LT*k~F_QE#HaH(&t4 zN1AAt>DqM~kU5KYy18yl?rXLah-{z!W^TmdW2X@52^Gt%gjGS!bZM)f6TppmvhSiy zgT){Cuh))_SdKhg`6qJkWlQXXN~Kr83iA=6aPrS(bb7bZ1Nbro00N;nP6&qatr1+a z&ncXQU3^wPa+#Rvjic|+pgMtlWZjxr!}DooHNzoTB2Ikeca-ow=LvjThxXk;xo#bx zMAmq?d1m7ABVbq7=hFmmGPJKMT73|auot{mJ|C~FIlri z_Iz3oa#sZaE}>GpF1SWpvbN#9f8{ZfmP&um4GB$BGYi%bM9&~-Kv`WG=i@a1&XxUi zXlw+{37m!(*S##8ICQ!XzDvY922+05KW%Vrkh2S3E`Vl*q6TA`!AIK(Mb29XtL4Ih zCYaU*09 zZJ=U0>JMy9=`4u7CVpA_Xlw9}Sn%mFr&y^KEBZwf-_!3|ABJlE9m9arr^`V;=8er8 zb+z)%`z@QMy(U9Ikz>=g;vn?>LL|SqQuNvLbFSaH^Xe~RDu2W^uZ9;A9@;!te=#X} zf=aBz+8CT&tUIq(}5Pnu-a- zy0~fi4@fc#XL-iV7()c2uw|2Pr!t~lqFR{!9Wz(;C9EZ(>BM*c+_u;cpk_?%!l%vh z*TmmFp#k8?*tsz+$MXX>Mw)2RBiw#cd8cQ6jj;kTS4 zSWEi={w2`S#w{A<9>U#s!1dX>bw+GgdSD*mA zq`jTSNj`GVG@f}#4?Zwz6E3q|Q|k`{XDcz>O&z~uibgIH#n5%Jq-*s4h!~ML#~#?g zi-qiY1yE#n-hO+!TXeH&{<(kUeY@(4XM(dS6MI(K786`k_ja20gJ|i}6asE3fj>AAz#Jx|QBAYAXsfEAHd;kW@O~a-1 zZ|C%71u?bFW?#O#k8j@`4m^GBZ<#&#Fs@xkAav^oR9(=Xd%bD16)JGdUM1mv*Jx4A zU~?|Z{n&`cZU&}4;tD1 z;!to>mb_OZm6W||)&BWP>O2yaH(sX9!kk7kxkwY+dr0_jXvu0|Dz4x@c-dL@(_Z}y zc(#5vRPgD5&$!#zB*7YSX)A_YvK_6g^*!^>ffPdaJS- zvj62?Kdo8a&{x%DCj(#T7(caKakX57tHp`~KkTow((|6J>fEEc3HNV1a!>fZp5#Pt zr#Nl^1YHTF^q(+uR4BO{nj?C%KU|D~+vjNc`zPJ@+HYc-hlc@E{-Xu^HSp{&__!C> zoN~GC{RUOJLCC6sJ+CSy9E7y68$Oe^QCmDTF3bL z(xLt!YkItWd>yGl!KT33{n}_=naPer9I4W#hp1C7im&;o8X^``$lVfas!I6)K?8+X_259HqD(uIYoFXyZcYH-1r6s$5THOla~2ih&$HfxKAMC_u@~JD%im>2J16 zh0D#De6~Z;37>PJoYYpHb25~z*-M&WCTTVi zDz>NKf|2>5zGt5=OiOBJ2Udm>C5Z6ig!%<48&OEJEi$azY|C6MA5&igBKFtatmbs- zJ#gm5d)&r7W9DAoqH;nNaN6V_+#KZM)EAeeDVg9kl@7&3?!qNnj$c-%%ta&AW?id5Z{?Kv1-6omtGMF|j0lCe z2TwJXM#fgy!&Q>S3zwi#=y^p{=l4}tJ|8=!>yWzf#U> zFz9%Lj94@h=jOgf@|Bg!zzc{RhR@v&YKrDGXXQ;Ae``HW&6c0RM4 zVysfpiVw)RqltHoo|oq6In&#@{p(<>SB%qZq+A>I7jF0}xJpQCp=_V3QK2 zdn5{~T+`_nL~HaURP}21%Ct8YCWDQZEBe)Q$EGc8I>;*N`~i>)A+1Rm>$f|~N=7b1 zzz~Ujazh@c?U2%0G0FiZOp*}DRncSmh|)Mks6AbSGWOOY5xZ@|M+HM~ix$eXHM9*V zmN(#d>((ixC0Z#6bEq8XBxtF^oHc^RIcqeWt&%7|w9XeW-d{-s@nfV2PHp;pSjwb` zEq{-|(awd|xPLc0Of|VLG#MW5bhaTk>@zKFH;X@M@T|)$_ZwzQBOVoLJlSN%!!6Us z-;plwTpnub-i0xXLFe`Ni`26#F1``A7<|9}(;NK}06=HY)zm`gl{1yR^G*kl_K4nQ z^BkeG3{Xi!d}qH%lPKhHj+^jztr~aF8HW7w%b_KBmwDOVweZuG?5Ls(YHJk|8kfZY z?ZC-5NkX3cH^tAp!*YZ1Vk|f4p8ZwmJa?OQNBCz(d+$NH@2{9xEtD*>`GWBuSZn{B zzu?!dhdr8X@U|1oC&e^BH850F~_TNOvr`<yt{W&Vb|5(|Xn+ih4eGZ)i%2}E;sKd z?zv{e6s2LC{&+E-r=Y`8+Xvy4@qH`E@mAZ{BEQH}b4ZUe-X@vF_CqRVwcxtpsxfi* z?|Zra|IsXq$2U9qy(PWAo!;2_)caeb^~i~SkE@cv4f&$j_D6r1QhwyC;WA%i$TZG4 zHlw10(RI}aliQW6Z5AYWmCu8>!CbU$0q^q`Pz{Hmv3 z2%`Ysm~0rv7Z`s7IF7!9yV*U0@ta&`>M|{^w6S{|TGJt7n?FM!hCk%A{J=S(tH)NL ztL$zm=c*{DXupMzn-A6t!XdaUzB6l)9AM=Z2Y@0uUsc|Eu(ATEqK2nO0Em-T2%YaV zr2(Abml&04-4MzvhKG$ZlRlPKENEWV!xSz#;R23MrZ8lBLPzn`(P$VbZ75;S?9?i z?`dDRP3smq74nVbO#!V)@E4h0>&h!Tm5q!{KfDzvkeFsx>3Q#DTsBbX`; zTe=o)BKDi0b_f5Ma_#R%IhaN42@5xyoawyNftn^=?DfFiuT7Qt7=+8)27AO0{KS5L3Y&RBiKgLuo%3)>ac$|VM0?4!Y zzB;8n+iYb`XImbneHgLwj=d2!(L#AUC(FH$LvwP9@w_TgkKu79vAn-!CsWbGe;)+O!Dubt8IDHp7*=)l$ z-%8u~20r}FVRa%ryKC#yRNNodcgtTCxo?S>hA$PkP}#6t{pysy;F#@`>eI?heOu>o z9!eX^5i(@1U+U|)p!a-0i{;^orfjW7e#6TBNIcii!k>aw8Z|EcrJH#uWm9!siW_!Z zf7bH0eBYZq|0>DVzPhL<(V;AbzFOW#IkYTXXdzO`+hKPchd}4a26KIQ|E%oC5>I^u z&^Pdu_+3iY7&CJ-pd>=oFQN{HiaNn&t=C$@_NSCgJ=(FUVLuUZxaR_u5a`TI^WZD; zjm^m?HhERz6>h?1Hr0g=?iJ#wP}wjs{KxmyDg$0c2JIf`{#2mZ{GkoQo-m>4l7R*D zny3zMg<01OzzZloB3P@Id9~5^DoXn})j77%=}RU%9zz3~KRPQ-At_ z_cYCQOk@X;1&uMX5eE5M@MJx?F}@KUfT(c}!}_2251^p{SzqK6v@@tr_!})6Z!jP8 z1X7W!9{yA13eosOmr7r=82Tfe-MNqUy|x%GIS_!9C$<{+!^UKb{=HFl)l_EvgqxV( z0!rch?IeAntj?5%bo@???A+g{-^Del-ST2m@ez(D3)AfyZ~aLaMOqxaL56u^^N9QN z=-Zf))+0}M9H-e#C` zI|GaY6Lk1OUGGnKTeTwaw`&!OV)R=Dh&qTfl&qst%#6vV8NE83#}+-)%n6(Jm5GB{ z*B^>Q)c^`xqV7`R()tn{tC)^wAsPi!$!l#;Iob9HOB%%PimkV(_lG;EV|^n^`SFq4 zFBh_-Y_L*9(lnF%LT=!6aS0QiWQixJ{%cW5?nsmM zsHNU7)evrq58MTg{@4JXu2yG2vA3{#`cMr})W{v_1<{u5uKLhOoZ{#x>x)j)6Vh0< z7hpx*z2ux|PWJCZB3yjv~FG_?YbHV&V z0j%2`Q9$pb_PF_C$ty)Q?0=Z@p{k=gIt>?WNo!VM)Mg-n;bjy2w0-$pbb?_RQ-`SZu2f! zW^3+GB6)|cZ>|KoY*Rz&C7-DcnypK1`HPuCz1v7=Gcz1pgxQnZ$>w%)kS>&QeL|i0 z4w6V?CzOZn>;`w6C*fS-Rq6!fa&@Um>|vr}uL5Bm-)Mzme}5+WcbIXWFqP5<51FiS zd>g|&#+LGf=`}0%>8mx1m*0QAhZnFyE$xB~K^5Jw?lXv~MzPiG*W!sG&si zWDYsj>)h(Xzb5wwI^JaOE^;p%Iti6$E0v$^FjBfQlH$#I#YOyuRGf4DOr-(B$<|PS48hSQ7m0;_4p{t=f@pX>~h52cqn5KR?WCiw1Vwo z^HSYaeC(`@S@s9CO6hC=>d6E?Vrn?=lMowFuVRuWY0>2p@$vZwG;HikRc-=uHJ*Ic z;6jpFPjN%SO_p>VAwkyZnDp0^La|2IaPc3^tGPC(8v>C;$lyL+;PTde8(Gm;Pu{Q#1`tuYHm@w?5;$ZK;g%F6<88 z!W)AMWHeFx@zj+>?F)vRN|zCcjVVssrW&Gif(HKYxEsoJ{yW(7U6@8vo~aQ=2qdt|<*T1rv8!iH{{)|=j3M%#Wl<7CK$(K0 zm!tB)&t6@`JdiJnCaL&LWv$iLKqx|FZJXUQL_aSbLas%1isPn+fZ0Mpsy;d1q8dFO zA0=2$r$g?w#0*USu4~PuAV+fE?_1`B%Lbk7YX8ucyOUy+$(*d;3kQeqFI0D%Uf$%6RP~32RvV6ZZx6 z%(q9oQ{A4GtM(c)$EdDv3VgIS$i@|2yXJ~5AtH~x23!gFT1-M zS+e3E;z5dQfoCkv{671AK9+sGavc5l)8Mb#8urz~+nRV0O>T!EM-8{RvA~6x)B!*=K(!{^0we2un6z&kZlQ*mw2S28xMopw^!0G0t|l z$eSAV@yt5Ad8Dc7>Dqq@)Kgt2v}otIN2NyGxId9Ro%gxn!dNG;Ssze$Ges57BfqszkfUSAvhicxODDI%bI*> z`G}0p0UVG}6EkkukC_J-pIEG3*7SJWZ1d~s8h{m{lUJ-2LbzkH^@~T79CZ`;4^uVR zdQzv=&R+3q*&Vs897^qllr6=-3ulx!0dWKNh1~YNX!D68b1vn7JUO%gU0!>WZw$Va zOQ`pN)z)tl0!uPx*YU;?)oa};02Pq4SFm9Nl{^YR8T08nl!!mP zq9%)OJ6agO;zSBU_;>@n2tV=)qC--@GfE)X_F5v2!=NlZ)HohSimHTStpNHKR zY%`f><$&i&?g^${f{hmM4%g0^R8m3rr0hNw|2s`;T-Nu{D-y1mpD4V<*sn=n3bcsZ z?P;UIcRzYgZxHEDUw_2!jR}vt)C7cBGxppz3xOPXr!Ppj|N5*K+UOBfA}n`y$0&!6slcN5zAM`MoHo3RGsyVW<4@XrN#bM-`<*t! z>NR$y$;5PQoeKJ@m*=F24Tno&MsJ#xgGyPtw7%4pu%`sHP{(-M0}ij#RadS zl1SJhvy!0lJqkHtw+dULbl;%{0!!z1o{og@h(+#J3HY|IW-lB4Y!`Cf?o2tWJ@inF9@JylEdVoul`7mDY$Fxu^w!gz|*e$buxRqUX? zaIQntGffk!uIb9tnsp@y%CFb+sxz7}j4JVGNC&r2|Na=qdtPRG@<3X5x=QUPW3?UO zS_SiRrD-a>xENT|ECvv{^BFkZJPFF*f848<#0{dtu&urO3Iq!1GC$XWt27hLB&3X+ zQAxNkJNh&D&SQc}N{XvC%b7_Q$RYfE5Ji!AQJFGu9czjRJertrKjU?#d$VP$x)s*q zTL6m%arn;cY8Lp^5L@>Kl}4!l-Yr#ec|h*O5wqKOvXyMiuVhTOc`ZIFw&8$#d*MRR zJX5Ga&4U_)u=jl;gX>1b#6TSP+x5conL7{ttcIGh-utuv8fdy(un|ixn>g_Ic!0#X z8P)}A2^pt&I!U3aKvW9Rf- z|BoQPTY6T(xFvS2M!|OAK-W~GrEY+gnL`RIb|`z79Rm8oLvztiZqzZ|tP=_sRcQZ^ zEBB?P@Ep@rk3vX`h{MM#S$PJ?3DP!%%R6*sz4Gxxye1i-7;}$5!rs*mhVK9vpeQ5#e8=dZX3T?3*kT#f13W4VHwq--|xImML`1esl6fJx2RWjbRZ9p-Rle^#DPS ziDR!#sc$oMQux;*lQ^xtpl!>IgWxR#g0~{exKKiJzT=?pdGgC}?Mww&Rra&bQx9L3 zZvT%Yl1jUl-pI-EJ?u9tMy=*Y;^K$vAocRWif8C%6%S=#O>K(Abp@Nbi*+0qMg3w#YTzAfhl&rr=yC$M6&sQ0#q${H=pxt z8I?tOm4<>oJHVnvLI88$d`#_-8dJ;Tzn(9zOALtR?vb}=1fd@E?=y7uS{w=0KOnyM z)-}<-+7yrq@N0JiUzr^(pgM*689C$-K}%TM*7C;twdy{B<6dkr|cr0 z>8M@8#aMH0W#q(dySEI4a~_*z@ha-Hy3YA@w!Enlfuu&|djSzCJlhpW1v%nn^zqoi zkfqtMu_2dsML57A7K~;<5O9Bh$SxdBZgk$fmdz>s6-8fj`vwZ9_6{G>HX&xYjUHtU zg^lE%+uwlAy*2Ms_Xn}S?YUpeGm}ckqM{L3j>dQE7`QRH z0(`t2AmQqQNp0N?zF=g_KJJRRb?&(YP7|(ECZ9%wzZ+nXdGF zn`qKC!1TM-8-E>ppLyJ}BT^Lbt?paf8VX%=e9UF4P%nW`m-V*fC9@FcPG@D}+~6q9 zznNyA?ZtY@c@gS&G&`zJs)?`LspU?om1((_2VVJDL<}FswKWKb zI8BS$XQLu?BydX8LCydRXr1nItpz-8tn?4jv)YvIu0CQ2uXJGE3nBUd zMl^C!voS`e4?9H>nFM~U#{OgqscsxFnh>f^yw#hc zShKJd%ViA%Utoj@XDGt2!wNH`C+MMv^TNVSD$RiH1gdV6|I4g!jg`CuNMQx^tQkh* zc<{j=`PLJgmU0KpwZX^N4J80fv1Qi>|2EtQKhe~+soH!|ppFWfix~!-N-Hxsdp|XmX!z71p0ejVr~4XByiuwntlPAhPlDj&m?9t>UCz#R_Fd&db?|i|Q9IPh~ zZHXN+*ko2B_p5CVS?cYc`Fb$iWw1%qc$figQ1BQ5l3l}1UkVouQg92`;-=pK)Jgzf zI|pJbGI-_7!*7q``f}Bj3ex5&Eh65zJ3y*155LUh4j3+}0Xu}IKSemD%9e%CHS017 zA0Z8l_=FlH)k$daWOlerH6@K$>gi_fd6n#@%93p#$M2`AP{vrU_9&q`X|AnCG!>n^ z>{ZWRxn4^Ls;YK=nlOt@X})|p#KHKjMyK`L-Ngy?8^Ec0Lc|YQ>L>UXDkL-=X7>If z!{HqbvV-zt{Q|uh85vI-h1&IOfEX^V?(c$7#`IF>0Xt0cG^VP6B8T@X%h<=#xd3Ab zJYiM0&BMM}pxcAk$bjKOZ8D7jPZA2A>9lCg>{LAvbb}*A%L{Ni2h<(BkK(wz(V`qM zyXC#d=1U$hKfBG+;YNl-$<)Io&9;6tC65K2dE6zMFl0${ zwm}y9?SAM7I5zt>KHY|WuR{h8tL~6Z*XsTkYtHWAi?!>2m|hlhM@t94j7GNI?~$YB z>}JHX?|8j~{!hl?;Lf;n$qc%~XPV>-Hybxgbb$Bu+f0N))fg~+jgX3e0 zKarG}0SCM$edmF3cDY=CLoBGZKCcQemgT0AGywPIa#$OM0?Y~iZ_7E-1s+omt?Y*% z$FHp(Hs68+WF#STy=R+BQY00=$VnO{xy_9>M+qa8<5-}^k&srhe7d9!{xP^93~X-M z5U}-Mi}5}+JFQ8$*oD86fU-Bv?AP@f`@RJ{c?pEwElM!prlQsuU?#;Yd#Ta|028Rh z*@Yr7;=CtXAy2aLiZ)Sky{cClI_c>^c>5ha6Zhhi5$&~NG?w45TOUkLsTS30WGa;Q_>vOtkNuOd%rzOsXST{mL{C6!+Wl5L7s^X&zH7@D zEw9XcGaSi~mWt10L*DJUONjwi;YS&EFAOyTALRI+(54gpq0!(Z2w)AB7xF{Aurn>f z2dh|(p?g*>=b!GS4k1k;)G$7~|^7ATK+uad;nN#98k&1gH zd^pQOQ1&va18l5g8K=%{eesFi8)Fd)dJ^0QHmNN=@H=@juDSx~*vqi5dU|^JyU(%Q zS0=U;8Tyr%zW8|ZPt&IN3te32sNK8C&Yx2^d6=mLO*)}+3H%I$&3L1QLj>i-A=wv2 zuwo~BD9%~^K{c@P`uToHhu-2y^Iyzz%PWSkNAX#>Pn|p4pmp&&ne)C??F2u+yWiN1 zIe!;>?kwNMmzJ@6e?BJ^jt)KdUQzFC)Z$`|S36@NbV;(CHsp1I3mT8U%6U11EZF`5 z!bJU7pZyr{{AS$Jnu{RCfS*bkTDl}oT|^*5*D5g0;< zsspUvMcWni5k8S~#tce66R>+DKt?;K6Q)%6_gckjSySQmgVdhDuL|3d_ir1kd5&n$ z@2GJ2)bqv?NoE=Be?*sUGo;Xi#i+dAbiI74gia;ldkqZQj#p_dI?KUo3Ns7Aw+6v_ACm8Ou61XCb33TH&Th&4q| zzUY+~(xY@5sM*>14eGA;&C{t%C{$~zNsVAI*AHnWJSkx7$)ex8fX$Mq^)8RGzj)my zPj@fk#C>$uiWz$Q&eP?wQ*G$kg%q=U&N@<|a|YDsZbExBnGZyq0WlY37Nu*M{ZOMJMJ=TC6fT@wfE3l9!;D4EKar)YGZ zl`I3C9S`EEGCI>d2fGIq;K5Y};?D-|MNl& z#XW%sly9GVh;F6c?K~V)yjh_FjU5ENeayMqM{sxW4#FN7k1`c5EnT3!S)3SA8}=>b z-nl|x&re&Dz{8r*B;~xD30j!YHrQ%l&f;?Fp2tmWwh5m=Bo@x4(tiNG&0w-HagmsY zicHqS{x;iW9F){9y;{rL!fF@HV=!^qJQgFzS>8-GT0wh>eL^EyHiIJuQnU3+&4x}{ z`Yua3t^177&Lq0GxP2NA&N1Yd%Z@cb);>e2dQUg=^8bCgA-EmE5h@a=K_4EE7~=( zCN~&mmp}fFWqR&vDNoQ?Y*dij`F;$EAyB=Zn}exek1q6{$OF$YTtO=Q&q)`aDgPf1 zwea{{0i3q*5FkJOcmE4m0!A}Mf&X=M#*rM~!;{qFE&z@n{#S#z5L|2wlJljlQ%c>J z@dd;D-p%H1#2T9`KvX!d^{e_?5lpe_zunrS@5qBJ#Imi(V&aotnCYU(z7 zy2ZkhktB%t`+K?iJscMqYGvo6i^MU6$-6vxoS#xIj@b#dVI~jQfkz?%vw4W;xV5-7 zXw#W!kWvFVISV7^2uXD{aX>n0cv>w)j-C|3EgciGPUBrPAYhq7S|nZ~L$R>>*;lL< zs*ageA|N_h+%WmFCjh+|2UrB2->nVWo*U|$1qwtnf>oKF&3fDMkwhkVyMyan`vtWU z)xWcmgl5261Y+`GBrWCm-a|6KLc=Mff>Bm(>5`N6cZHPgT_zNMxLqSz?gPYFA9}Y^ zUHwl^+&BqG0>V>+do~PhNa0+4I{isE)Mjqb`)T5nf(B2Qg-}x1Aze$?%Ke)n3DFRa2^nRn*Uta3<8as7OmLW0ny~YK z^>U?AO=MYE1($Z|sCY!c1{E4a$7a+317U}tX$VmfMG$eJfkYOCAhHFC3igp05F`+U zxBwAB0S%&}M1>X+140OBXqIjPLqdoF!k%PqVW0We=giDG-GA#;y?XVk-mQDT`+Xne z$O6yyADSP;2rtF(6jbsXPc6yODai8$!0|Y$(d*>Y@*3aEY%j%87@OgfVy90SHr6yP;YG7Bd7?1z>w(PlGc$D=eOEcZsCU36h+P z2Y;E{+P)zbSlyH*@rYoc!gzH>6U=1?Ef++!3^eHC+5E=_!f>tqt8ZA0HaqaIAn?eM zr>PM+nCLK4jgy{eA7&U32um6rsX_HGm}wVAh}mnFWGwPulPtycfnLpx7Z{v^=dT7x zhyo=wPBWaN6Q+lVlsND9_c??s zN{VsFEZVsEJM#PY&okWF;NQTZm|y36V73Xm&HQU@5{~t5#F0dRRWXryjX6}RD%)(1A*PL#5j z(;s~r`_bu!A4vwWEFjGme=Bbs>G*i0?bZaX*bYa(m5SI@2)$`Xb!7VOn`EqJo4 zc*PDsVavs1_B_gyRXitA6H0SbvxL0N+oxt3(#lnmwvle0Mp`?k?{C{2e(Sl_c@WrV zIF6$?W*5e2I&Mk8@+pj@#CNYWqR}jouB4zSJ8Brp7}K<%ywn)_9ml4YKxT8@h#YmK z$!=z-VzG8ZbchB@-4Zkgksv?oq%(h|YQB3xJGvXlZ}s<5bWgnY z#NOK(`qI#E#HBm5<^v2QnL6^4tvgUs&Wl}=TP!FS|Vkc-yb&Z!T| z(I3TCXR?g5ekL#Ozx_l%c_23Xz!t;0*of`42gcIfjD+_?)fmpTg)A0`e;=bqBAjGy zUd)axfG36INdtq*mMu!{-SC+yUJh*fa|ZRm98S5fzO*3=CjOThD*gEc{wfQn|Mrd_ zuBYcuD^kB8UKnKs@^PS6B5du}cYz4f`*+z;#TjyrzNCs#>MtlsG)XZZunh*Fkl zzp$!)eWbfBSSaCgx11lkQtDlCYns+GNfQ?`j@$)Ouz|o6HZ8|=$D837i2Sb$3M&E5 zByWExRJsC|@*_(S2@mr11b?N#-wTOymCbfD`w<@M(#OcvgUHn^^%RTU8w&_UDPs_ys*7&SKowvXLa+x2OOrVTp z5GnR;cOQoMO06XUHTc7D=cgyqY_Xbb@UBVp{O;6?`Gd+brLe5f*supG)7BXa@JPWW z$z*DkjQt{x;diFEMsY8^a(wAXt%0iCS~D^l7MEPZZxQTY9q%Vb>J9TsIb%(r1 zeee>*SD?g0BwePLcr5{%96?wl@GaWQ+5ynqtIHt0{N_b&CGT0#^bLLd6>ISwG^HXAa5oK(FNB1U7RQLFC#b(S~E*a^Q)KincrLZUdcoZXS&j+rulbfgS67sE0_NCyf z+e;zj7s0;)3Au-*X0e|v4KXDH-2vixqu+Xu7gW5yckJpy=URHSH+CN0(? zPCIVs9?C)$5;-MBXCS~u-)EO9=;}$jqC}3QS!jxS2K2z8!LOVs!8=|7SHPp$7@0`E z-qk~mLLmM07c|%aF-4L9_vGyFHZlU(!G^z@g7KndwL!gyaAa68>#~i{h zsT^!OhawGZf&<0d-*jJy|BUIubt#da_napj(Ry7#cwcbXtJ#)c{VbKy@Xm;_Q@ytXR~W=+8sQ#Z{G;6X-yLyw4zpUojSlxP@Bbd+ mKcxoJ8~Zy<{XD%CY7J?)kHfJr)n@QToQK1DxZHO-O8qxOthZbM literal 0 HcmV?d00001 diff --git a/docs/troubleshoot/cli/known-cli.md b/docs/troubleshoot/cli/known-cli.md index 705dfc7a37..aaa651b249 100644 --- a/docs/troubleshoot/cli/known-cli.md +++ b/docs/troubleshoot/cli/known-cli.md @@ -211,3 +211,32 @@ When the `zowe zos-files search data-sets` command is issued with the `--mainfra **Solution:** Issue the `zowe files search ds` command without the `--mainframe-search` option. This returns results that include data sets in binary format. + +## Error message with PowerShell scripts + +**Valid on Windows** + +**Symptom:** + +PowerShell users on Windows can encounter an error when they try to run Zowe CLI with certain execution policies in place. + +Example of an error message: + +``` +PS C:\> zowe +zowe : File C:\Users\user\AppData\Roaming\npm\zowe.ps1 cannot be loaded because running scripts is disabled on this +system. For more information, see about_Execution_Policies at https:/go.microsoft.com/fwlink/?LinkID=135170. +At line:1 char:1 ++ zowe ++ ~~~~ + + CategoryInfo : SecurityError: (:) [], PSSecurityException + + FullyQualifiedErrorId : UnauthorizedAccess +``` + +**Solutions:** + +- Update developer settings in Windows to enable running local scripts without signing: + +![PowerShell setting](../../images/troubleshoot/cli/PowerShell_developer_setting.png) + +- Run PowerShell as an administrator and use the `Set-ExecutionPolicy` command to change the execution policy to a less-restrictive setting, for example: `Set-ExecutionPolicy RemoteSigned -scope CurrentUser`. From 186d047725a376dfdec114ed98eaa1cfd8f0f6a4 Mon Sep 17 00:00:00 2001 From: anaxceron Date: Thu, 14 Nov 2024 16:12:25 -0500 Subject: [PATCH 02/10] initial draft https://github.com/openmainframeproject/foundation/releases/download/zowe_conformant_zowe_v3_20240910/Zowe.Support.Provider.-.Test.Evaluation.Guide.Table.pdf --- docs/whats-new/release-notes/v3_0_0.md | 2 -- .../whats-new/zowe-compatibility-statement.md | 25 +++++++++++++++++++ sidebars.js | 1 + 3 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 docs/whats-new/zowe-compatibility-statement.md diff --git a/docs/whats-new/release-notes/v3_0_0.md b/docs/whats-new/release-notes/v3_0_0.md index a081b1d56b..6c98afa05d 100644 --- a/docs/whats-new/release-notes/v3_0_0.md +++ b/docs/whats-new/release-notes/v3_0_0.md @@ -233,8 +233,6 @@ For a complete list of enhancements and bug fixes, see the following changelogs: - [IBM z/OS FTP Plug-in Zowe CLI](https://github.com/zowe/zowe-cli-ftp-plugin/blob/master/CHANGELOG.md) - [IBM MQ Plug-in Zowe CLI](https://github.com/zowe/zowe-cli-mq-plugin/blob/master/CHANGELOG.md) - - ## Conformance and release compatibility ### Backward compatibility diff --git a/docs/whats-new/zowe-compatibility-statement.md b/docs/whats-new/zowe-compatibility-statement.md new file mode 100644 index 0000000000..bcaa7943b1 --- /dev/null +++ b/docs/whats-new/zowe-compatibility-statement.md @@ -0,0 +1,25 @@ +# Zowe conformance and release compatibility + +## Backward compatibility + +Zowe V2 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V3 and therefore may not be operable. In general, plug-ins/extensions which leverage V3 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. + +**Recommendation:** All V2 extenders test with Zowe V3, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. + +## Forward compatibility + +Zowe V3 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V2 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V2 functions are at minimum risk. + +**Recommendation:** All V3 extenders test with Zowe V2 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. + +## Conformance compatibility + +Zowe V2 conformant extensions/plug-ins are likely to require changes to meet Zowe V3 conformance criteria. All extensions (regardless of V2 conformance status) must apply for V3 conformance and satisfy all required V3 testing criteria. You can find the V3 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/releases/download/zowe_conformant_zowe_v3_20240910/Zowe.Support.Provider.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation +All extenders interested in earning V3 conformance review the V3 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V3 conformance. +::: + +## Need help? + +For assistance with reviewing or completing the Zowe Conformance Zowe V3 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the `#zowe-onboarding` channel. \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index a59ee2b523..6b1b598ad6 100644 --- a/sidebars.js +++ b/sidebars.js @@ -41,6 +41,7 @@ module.exports = { "whats-new/release-notes/v2_0_0", ], }, + "whats-new/zowe-compatibility-statement", ], "getting-started": [ { From 39be38ca1b822f7130db2cb13e882732b5ca0cc8 Mon Sep 17 00:00:00 2001 From: ac892247 Date: Fri, 15 Nov 2024 09:52:19 +0100 Subject: [PATCH 03/10] validate oidc method in zaas client Signed-off-by: ac892247 --- docs/extend/extend-apiml/zaas-client.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/extend/extend-apiml/zaas-client.md b/docs/extend/extend-apiml/zaas-client.md index 29c3f3c216..2fca121a59 100644 --- a/docs/extend/extend-apiml/zaas-client.md +++ b/docs/extend/extend-apiml/zaas-client.md @@ -33,6 +33,7 @@ public interface ZaasClient { String login(String authorizationHeader) throws ZaasClientException; ZaasToken query(String token) throws ZaasClientException; ZaasToken query(HttpServletRequest request) throws ZaasClientException; + ZaasOidcValidationResult validateOidc(String token) throws ZaasClientException; String passTicket(String jwtToken, String applicationId) throws ZaasClientException, ZaasConfigurationException; void logout(String token) throws ZaasClientException, ZaasConfigurationException; } @@ -88,6 +89,21 @@ cookie or in an Authorization header. You then receive the `ZaasToken` Object in ZaasToken query(HttpServletRequest request) throws ZaasClientException; ``` +### Validate the OIDC token (`validateOidc`) + +Use the `validateOidc` method to get the validity information about the OIDC token. + +Call the `validateOidc` method from your API in the following format: + +```java +ZaasOidcValidationResult validateOidc(String token) throws ZaasClientException; +``` + +In return, you receive the `ZaasOidcValidationResult` Object in JSON format. + +This method automatically uses the truststore file to add a security layer, which you configured in the `ConfigProperties` class. + + ### Invalidate a JWT token (`logout`) The `logout` method is used to invalidate the JWT token. The token must be provided in the Cookie header and must follow the format accepted by the API ML. From b7bd20d50a6d56ec2e9c678005b902c0799a8a19 Mon Sep 17 00:00:00 2001 From: ac892247 Date: Fri, 15 Nov 2024 10:02:52 +0100 Subject: [PATCH 04/10] update status code Signed-off-by: ac892247 --- docs/extend/extend-apiml/api-mediation-oidc-authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/extend/extend-apiml/api-mediation-oidc-authentication.md b/docs/extend/extend-apiml/api-mediation-oidc-authentication.md index dec5a517fb..465157b7b9 100644 --- a/docs/extend/extend-apiml/api-mediation-oidc-authentication.md +++ b/docs/extend/extend-apiml/api-mediation-oidc-authentication.md @@ -259,7 +259,7 @@ Use the following curl command to make a REST request with the OIDC token to the curl --location 'https://"$HOSTNAME:$PORT"/gateway/api/v1/auth/oidc-token/validate --data '{"token": "$OIDC_TOKEN","serviceId": "$SERVICE_ID"}' ``` -An HTTP `200` code is returned if the validation passes. Failure to validate returns an HTTP `40x` error. +An HTTP `204` code is returned if the validation passes. Failure to validate returns an HTTP `40x` error. ::: :::note Azure Entra ID OIDC notes: From 1750859a5aad8d4b3d37a7c8d3f2326f8a8439f0 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Fri, 15 Nov 2024 12:43:38 +0100 Subject: [PATCH 05/10] create collapsible content for Gradle and Maven commands Signed-off-by: Andrew Jandacek --- docs/extend/extend-apiml/zaas-client.md | 92 ++++++++++++++----------- 1 file changed, 51 insertions(+), 41 deletions(-) diff --git a/docs/extend/extend-apiml/zaas-client.md b/docs/extend/extend-apiml/zaas-client.md index 2fca121a59..2b5448e670 100644 --- a/docs/extend/extend-apiml/zaas-client.md +++ b/docs/extend/extend-apiml/zaas-client.md @@ -140,65 +140,75 @@ To use this library, use the procedure described in this section. 1. Add `zaas-client` as a dependency in your project. You will need to specify the version of the `zaas-client` you want. `zaas-client` versioning following the semantic versioning format of `major.minor.patch`. For example, `1.22.0`. +
+ Click here for procedural details using Gradle. + **Gradle:** - 1. Create a `gradle.properties` file in the root of your project if one does not already exist. + 1. Create a `gradle.properties` file in the root of your project if one does not already exist. - 2. In the `gradle.properties` file, set the URL of the specific Artifactory containing the _SpringEnabler_ artifact. + 2. In the `gradle.properties` file, set the URL of the specific Artifactory containing the _SpringEnabler_ artifact. - ``` - # Repository URL for getting the enabler-java artifact - artifactoryMavenRepo=https://zowe.jfrog.io/zowe/libs-release/ - ``` + ``` + # Repository URL for getting the enabler-java artifact + artifactoryMavenRepo=https://zowe.jfrog.io/zowe/libs-release/ + ``` - 3. Add the following _Gradle_ code block to the `repositories` section of your `build.gradle` file: + 3. Add the following _Gradle_ code block to the `repositories` section of your `build.gradle` file: - ```gradle - repositories { - ... + ```gradle + repositories { + ... - maven { + maven { url artifactoryMavenRepo - } } - ``` + } + ``` - 4. Add the following _Gradle_ dependency: + 4. Add the following _Gradle_ dependency: - ```groovy - dependencies { - compile 'org.zowe.apiml.sdk:zaas-client:{{version}}' - } - ``` + ```groovy + dependencies { + compile 'org.zowe.apiml.sdk:zaas-client:{{version}}' + } + ``` + +
+ +
+ Click here for procedural details using Maven. **Maven:** - 1. Add the following _XML_ tags within the newly created `pom.xml` file: - - ```xml - - - libs-release - libs-release - https://zowe.jfrog.io/zowe/libs-release/ - - false - - - - ``` + 1. Add the following _XML_ tags within the newly created `pom.xml` file: + + ```xml + + + libs-release + libs-release + https://zowe.jfrog.io/zowe/libs-release/ + + false + + + + ``` **Tip:** If you want to use snapshot version, replace libs-release with libs-snapshot in the repository url and change snapshots->enabled to true. - 2. Then add the following _Maven_ dependency: + 2. Then add the following _Maven_ dependency: - ```xml - - org.zowe.apiml.sdk - zaas-client - {{version}} - - ``` + ```xml + + org.zowe.apiml.sdk + zaas-client + {{version}} + + ``` + +
2. In your application, create your Java class which will be used to create an instance of `ZaasClient`, which enables you to use its method to login, query, and to issue a PassTicket. From cbba4cb69543ee11899f68328706c96f3a49a58d Mon Sep 17 00:00:00 2001 From: ac892247 Date: Fri, 15 Nov 2024 13:26:45 +0100 Subject: [PATCH 06/10] same status code for v2 Signed-off-by: ac892247 --- .../extend/extend-apiml/api-mediation-oidc-authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-v2.18.x/extend/extend-apiml/api-mediation-oidc-authentication.md b/versioned_docs/version-v2.18.x/extend/extend-apiml/api-mediation-oidc-authentication.md index 22e4f5ab71..bb6bd63d1b 100644 --- a/versioned_docs/version-v2.18.x/extend/extend-apiml/api-mediation-oidc-authentication.md +++ b/versioned_docs/version-v2.18.x/extend/extend-apiml/api-mediation-oidc-authentication.md @@ -242,7 +242,7 @@ Use the following curl command to make a REST request with the OIDC token to the curl --location 'https://"$HOSTNAME:$PORT"/gateway/api/v1/auth/oidc-token/validate --data '{"token": "$OIDC_TOKEN","serviceId": "$SERVICE_ID"}' ``` -An HTTP `200` code is returned if the validation passes. Failure to validate returns an HTTP `40x` error. +An HTTP `204` code is returned if the validation passes. Failure to validate returns an HTTP `40x` error. ::: :::note Azure Entra ID OIDC notes: From 3a8bf87726b7e88e0a54af63e37e9537e1b96d7d Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Fri, 15 Nov 2024 14:43:43 +0100 Subject: [PATCH 07/10] minor language clarification Signed-off-by: Andrew Jandacek --- .../whats-new/zowe-compatibility-statement.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/whats-new/zowe-compatibility-statement.md b/docs/whats-new/zowe-compatibility-statement.md index bcaa7943b1..27ca8cd0cb 100644 --- a/docs/whats-new/zowe-compatibility-statement.md +++ b/docs/whats-new/zowe-compatibility-statement.md @@ -4,20 +4,29 @@ Zowe V2 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V3 and therefore may not be operable. In general, plug-ins/extensions which leverage V3 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. -**Recommendation:** All V2 extenders test with Zowe V3, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +:::tip Recommendation for backward compatibility + +We recommend that all V2 extenders test with Zowe V3, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. Testing limitations should be clearly documented. + +::: ## Forward compatibility Zowe V3 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V2 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V2 functions are at minimum risk. -**Recommendation:** All V3 extenders test with Zowe V2 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +:::tip Recommendation for forward compatibility + +We recommend that all V3 extenders test with Zowe V2 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. Testing limitations should be clearly documented. + +::: ## Conformance compatibility -Zowe V2 conformant extensions/plug-ins are likely to require changes to meet Zowe V3 conformance criteria. All extensions (regardless of V2 conformance status) must apply for V3 conformance and satisfy all required V3 testing criteria. You can find the V3 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/releases/download/zowe_conformant_zowe_v3_20240910/Zowe.Support.Provider.-.Test.Evaluation.Guide.Table.pdf). +Zowe V2 conformant extensions/plug-ins are likely to require changes to meet Zowe V3 conformance criteria. All extensions (regardless of V2 conformance status) must apply for V3 conformance and satisfy all required V3 testing criteria. For more information about V3 Conformance Criteria, see the [Zowe Support Provider Conformance Guide](https://github.com/openmainframeproject/foundation/releases/download/zowe_conformant_zowe_v3_20240910/Zowe.Support.Provider.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation for V3 conformance -:::tip Recommendation -All extenders interested in earning V3 conformance review the V3 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V3 conformance. +We recommend that all extenders interested in earning V3 conformance review the V3 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V3 conformance. ::: ## Need help? From 53bbd1dcb06f1ba5baca8caf95d8f2318c516517 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Fri, 15 Nov 2024 16:46:59 +0100 Subject: [PATCH 08/10] remove consumer header in V3 OH Signed-off-by: Andrew Jandacek --- docs/whats-new/zowe-v3-office-hours.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/whats-new/zowe-v3-office-hours.md b/docs/whats-new/zowe-v3-office-hours.md index 221719ee40..146e698bd2 100644 --- a/docs/whats-new/zowe-v3-office-hours.md +++ b/docs/whats-new/zowe-v3-office-hours.md @@ -6,7 +6,6 @@ Zowe squads go over their upcoming projects and answer your questions about Zowe Missed a session? Catch up here. Office hours are recorded and made available with videos posted to the [Open Mainframe Project](https://www.youtube.com/@OpenMainframeProject) YouTube channel. -## Consumer focused Office Hours | Date | Topic | Link to the meeting | Link to the recording | Links to the materials | | ------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |--------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| From f2ef92ca2f7a63c9eef75e9dfc9b34b42c0c4e2a Mon Sep 17 00:00:00 2001 From: anaxceron Date: Fri, 15 Nov 2024 14:05:48 -0500 Subject: [PATCH 09/10] reworked draft per squad feedback Signed-off-by: anaxceron --- docs/whats-new/release-notes/v3_0_0.md | 22 -------------- ....md => zowe-compatibility-statement-v3.md} | 10 +++++-- sidebars.js | 2 +- .../zowe-compatibility-statement-v2.md | 29 +++++++++++++++++++ .../zowe-compatibility-statement-v2.md | 29 +++++++++++++++++++ .../zowe-compatibility-statement-v2.md | 29 +++++++++++++++++++ .../zowe-compatibility-statement-v2.md | 29 +++++++++++++++++++ .../version-v2.15.x-sidebars.json | 1 + .../version-v2.16.x-sidebars.json | 1 + .../version-v2.17.x-sidebars.json | 1 + .../version-v2.18.x-sidebars.json | 1 + 11 files changed, 128 insertions(+), 26 deletions(-) rename docs/whats-new/{zowe-compatibility-statement.md => zowe-compatibility-statement-v3.md} (74%) create mode 100644 versioned_docs/version-v2.15.x/whats-new/zowe-compatibility-statement-v2.md create mode 100644 versioned_docs/version-v2.16.x/whats-new/zowe-compatibility-statement-v2.md create mode 100644 versioned_docs/version-v2.17.x/whats-new/zowe-compatibility-statement-v2.md create mode 100644 versioned_docs/version-v2.18.x/whats-new/zowe-compatibility-statement-v2.md diff --git a/docs/whats-new/release-notes/v3_0_0.md b/docs/whats-new/release-notes/v3_0_0.md index 6c98afa05d..c9c21ac365 100644 --- a/docs/whats-new/release-notes/v3_0_0.md +++ b/docs/whats-new/release-notes/v3_0_0.md @@ -232,25 +232,3 @@ For a complete list of enhancements and bug fixes, see the following changelogs: - [IBM Db2 Databse Plug-in Zowe CLI](https://github.com/zowe/zowe-cli-db2-plugin/blob/master/CHANGELOG.md) - [IBM z/OS FTP Plug-in Zowe CLI](https://github.com/zowe/zowe-cli-ftp-plugin/blob/master/CHANGELOG.md) - [IBM MQ Plug-in Zowe CLI](https://github.com/zowe/zowe-cli-mq-plugin/blob/master/CHANGELOG.md) - -## Conformance and release compatibility - -### Backward compatibility - -Zowe V2 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V3 and therefore may not be operable. In general, plug-ins/extensions which leverage V3 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. - -**Recommendation:** All V2 extenders test with Zowe V3, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. - -### Forward compatibility - -Zowe V3 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V2 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V2 functions are at minimum risk. - -**Recommendation:** All V3 extenders test with Zowe V2 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. - -### Conformance compatibility - -Zowe V2 conformant extensions/plug-ins are likely to require changes to meet Zowe V3 conformance criteria. All extensions (regardless of V2 conformance status) must apply for V3 conformance and satisfy all required V3 testing criteria. You can find the V3 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). - -**Recommendation:** All extenders interested in earning V3 conformance review the V3 conformance criteria, determine if technical changes are necessary, make appropriate modifications and prepare to apply for V3 conformance. - -**Need help?** For assistance with reviewing or completing the Zowe Conformance Zowe V3 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the `#zowe-onboarding` channel. diff --git a/docs/whats-new/zowe-compatibility-statement.md b/docs/whats-new/zowe-compatibility-statement-v3.md similarity index 74% rename from docs/whats-new/zowe-compatibility-statement.md rename to docs/whats-new/zowe-compatibility-statement-v3.md index bcaa7943b1..87e5b86c78 100644 --- a/docs/whats-new/zowe-compatibility-statement.md +++ b/docs/whats-new/zowe-compatibility-statement-v3.md @@ -4,13 +4,17 @@ Zowe V2 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V3 and therefore may not be operable. In general, plug-ins/extensions which leverage V3 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. -**Recommendation:** All V2 extenders test with Zowe V3, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +:::tip Recommendation +All V2 extenders test with Zowe V3, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: ## Forward compatibility Zowe V3 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V2 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V2 functions are at minimum risk. -**Recommendation:** All V3 extenders test with Zowe V2 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +:::tip Recommendation +All V3 extenders test with Zowe V2 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: ## Conformance compatibility @@ -22,4 +26,4 @@ All extenders interested in earning V3 conformance review the V3 conformance cri ## Need help? -For assistance with reviewing or completing the Zowe Conformance Zowe V3 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the `#zowe-onboarding` channel. \ No newline at end of file +For assistance with reviewing or completing the Zowe Conformance Zowe V3 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/sidebars.js b/sidebars.js index 6b1b598ad6..aaad3e4a69 100644 --- a/sidebars.js +++ b/sidebars.js @@ -41,7 +41,6 @@ module.exports = { "whats-new/release-notes/v2_0_0", ], }, - "whats-new/zowe-compatibility-statement", ], "getting-started": [ { @@ -106,6 +105,7 @@ module.exports = { }, ], }, + "whats-new/zowe-compatibility-statement-v3", "getting-started/cli-getting-started", ], "setup": [ diff --git a/versioned_docs/version-v2.15.x/whats-new/zowe-compatibility-statement-v2.md b/versioned_docs/version-v2.15.x/whats-new/zowe-compatibility-statement-v2.md new file mode 100644 index 0000000000..29a848f747 --- /dev/null +++ b/versioned_docs/version-v2.15.x/whats-new/zowe-compatibility-statement-v2.md @@ -0,0 +1,29 @@ +# Zowe conformance and release compatibility + +## Backward compatibility + +Zowe V1 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V2 and therefore may not be operable. In general, plug-ins/extensions which leverage V2 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. + +:::tip Recommendation +All V1 extenders test with Zowe V2, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Forward compatibility + +Zowe V2 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V1 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V1 functions are at minimum risk. + +:::tip Recommendation +All V2 extenders test with Zowe V1 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Conformance compatibility + +Zowe V1 conformant extensions/plug-ins are likely to require changes to meet Zowe V2 conformance criteria. All extensions (regardless of V1 conformance status) must apply for V2 conformance and satisfy all required V2 testing criteria. You can find the V2 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation +All extenders interested in earning V2 conformance review the V2 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V2 conformance. +::: + +## Need help? + +For assistance with reviewing or completing the Zowe Conformance Zowe V2 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/versioned_docs/version-v2.16.x/whats-new/zowe-compatibility-statement-v2.md b/versioned_docs/version-v2.16.x/whats-new/zowe-compatibility-statement-v2.md new file mode 100644 index 0000000000..29a848f747 --- /dev/null +++ b/versioned_docs/version-v2.16.x/whats-new/zowe-compatibility-statement-v2.md @@ -0,0 +1,29 @@ +# Zowe conformance and release compatibility + +## Backward compatibility + +Zowe V1 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V2 and therefore may not be operable. In general, plug-ins/extensions which leverage V2 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. + +:::tip Recommendation +All V1 extenders test with Zowe V2, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Forward compatibility + +Zowe V2 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V1 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V1 functions are at minimum risk. + +:::tip Recommendation +All V2 extenders test with Zowe V1 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Conformance compatibility + +Zowe V1 conformant extensions/plug-ins are likely to require changes to meet Zowe V2 conformance criteria. All extensions (regardless of V1 conformance status) must apply for V2 conformance and satisfy all required V2 testing criteria. You can find the V2 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation +All extenders interested in earning V2 conformance review the V2 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V2 conformance. +::: + +## Need help? + +For assistance with reviewing or completing the Zowe Conformance Zowe V2 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/versioned_docs/version-v2.17.x/whats-new/zowe-compatibility-statement-v2.md b/versioned_docs/version-v2.17.x/whats-new/zowe-compatibility-statement-v2.md new file mode 100644 index 0000000000..29a848f747 --- /dev/null +++ b/versioned_docs/version-v2.17.x/whats-new/zowe-compatibility-statement-v2.md @@ -0,0 +1,29 @@ +# Zowe conformance and release compatibility + +## Backward compatibility + +Zowe V1 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V2 and therefore may not be operable. In general, plug-ins/extensions which leverage V2 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. + +:::tip Recommendation +All V1 extenders test with Zowe V2, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Forward compatibility + +Zowe V2 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V1 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V1 functions are at minimum risk. + +:::tip Recommendation +All V2 extenders test with Zowe V1 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Conformance compatibility + +Zowe V1 conformant extensions/plug-ins are likely to require changes to meet Zowe V2 conformance criteria. All extensions (regardless of V1 conformance status) must apply for V2 conformance and satisfy all required V2 testing criteria. You can find the V2 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation +All extenders interested in earning V2 conformance review the V2 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V2 conformance. +::: + +## Need help? + +For assistance with reviewing or completing the Zowe Conformance Zowe V2 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/versioned_docs/version-v2.18.x/whats-new/zowe-compatibility-statement-v2.md b/versioned_docs/version-v2.18.x/whats-new/zowe-compatibility-statement-v2.md new file mode 100644 index 0000000000..29a848f747 --- /dev/null +++ b/versioned_docs/version-v2.18.x/whats-new/zowe-compatibility-statement-v2.md @@ -0,0 +1,29 @@ +# Zowe conformance and release compatibility + +## Backward compatibility + +Zowe V1 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V2 and therefore may not be operable. In general, plug-ins/extensions which leverage V2 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. + +:::tip Recommendation +All V1 extenders test with Zowe V2, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Forward compatibility + +Zowe V2 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V1 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V1 functions are at minimum risk. + +:::tip Recommendation +All V2 extenders test with Zowe V1 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Conformance compatibility + +Zowe V1 conformant extensions/plug-ins are likely to require changes to meet Zowe V2 conformance criteria. All extensions (regardless of V1 conformance status) must apply for V2 conformance and satisfy all required V2 testing criteria. You can find the V2 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation +All extenders interested in earning V2 conformance review the V2 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V2 conformance. +::: + +## Need help? + +For assistance with reviewing or completing the Zowe Conformance Zowe V2 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/versioned_sidebars/version-v2.15.x-sidebars.json b/versioned_sidebars/version-v2.15.x-sidebars.json index 6dba58eaa8..7e32875c2f 100644 --- a/versioned_sidebars/version-v2.15.x-sidebars.json +++ b/versioned_sidebars/version-v2.15.x-sidebars.json @@ -108,6 +108,7 @@ "className": "ToCitemcolor", "id": "extend/migrate-extensions" }, + "whats-new/zowe-compatibility-statement-v2", { "type": "doc", "label": "Zowe learning resources", diff --git a/versioned_sidebars/version-v2.16.x-sidebars.json b/versioned_sidebars/version-v2.16.x-sidebars.json index cdff456095..dc6ee7d552 100644 --- a/versioned_sidebars/version-v2.16.x-sidebars.json +++ b/versioned_sidebars/version-v2.16.x-sidebars.json @@ -109,6 +109,7 @@ "className": "ToCitemcolor", "id": "extend/migrate-extensions" }, + "whats-new/zowe-compatibility-statement-v2", { "type": "doc", "label": "Zowe learning resources", diff --git a/versioned_sidebars/version-v2.17.x-sidebars.json b/versioned_sidebars/version-v2.17.x-sidebars.json index 2996581ea8..9aa06a6076 100644 --- a/versioned_sidebars/version-v2.17.x-sidebars.json +++ b/versioned_sidebars/version-v2.17.x-sidebars.json @@ -112,6 +112,7 @@ "className": "ToCitemcolor", "id": "extend/migrate-extensions" }, + "whats-new/zowe-compatibility-statement-v2", { "type": "doc", "label": "Zowe learning resources", diff --git a/versioned_sidebars/version-v2.18.x-sidebars.json b/versioned_sidebars/version-v2.18.x-sidebars.json index 268a0626df..fef86e4c45 100644 --- a/versioned_sidebars/version-v2.18.x-sidebars.json +++ b/versioned_sidebars/version-v2.18.x-sidebars.json @@ -113,6 +113,7 @@ "className": "ToCitemcolor", "id": "extend/migrate-extensions" }, + "whats-new/zowe-compatibility-statement-v2", { "type": "doc", "label": "Zowe learning resources", From 621ce6b902a494c5649621c967b3a034ebada95d Mon Sep 17 00:00:00 2001 From: anaxceron Date: Fri, 15 Nov 2024 14:58:46 -0500 Subject: [PATCH 10/10] fixing broken link Signed-off-by: anaxceron --- docs/whats-new/release-notes/v3_0_0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/whats-new/release-notes/v3_0_0.md b/docs/whats-new/release-notes/v3_0_0.md index c9c21ac365..028ca3bafe 100644 --- a/docs/whats-new/release-notes/v3_0_0.md +++ b/docs/whats-new/release-notes/v3_0_0.md @@ -5,7 +5,7 @@ Welcome to the Version 3.0.0 release of Zowe! Version 3.0 introduced breaking changes and a number of new features. - See [Important updates](#important-updates) for a full list of changes to the functionality. -- See [Conformance and release compatibility](#conformance-and-release-compatibility) for V3 Conformance Criteria updates and compatibility with V2. +- See [Conformance and release compatibility](../zowe-compatibility-statement-v3.md) for V3 Conformance Criteria updates and compatibility with V2. **Download v3.0.0 build:** Want to try new features as soon as possible? You can download the v3.0.0 build from [Zowe.org](https://www.zowe.org/download.html).