From c25d17719e3a528f6399cd2331db105ea98ed873 Mon Sep 17 00:00:00 2001 From: kt Date: Wed, 21 Dec 2022 12:05:01 -0800 Subject: [PATCH 1/6] mkdocs initial --- .github/workflows/mkdocs.yml | 20 ++++++++++ contributing/extra.css | 3 ++ contributing/images/hashicorp-black.png | Bin 0 -> 6857 bytes contributing/images/hashicorp.png | Bin 0 -> 10852 bytes mkdocs.yml | 48 ++++++++++++++++++++++++ 5 files changed, 71 insertions(+) create mode 100644 .github/workflows/mkdocs.yml create mode 100644 contributing/extra.css create mode 100644 contributing/images/hashicorp-black.png create mode 100644 contributing/images/hashicorp.png create mode 100644 mkdocs.yml diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml new file mode 100644 index 000000000000..0177f1f4f1b0 --- /dev/null +++ b/.github/workflows/mkdocs.yml @@ -0,0 +1,20 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: + - main + workflow_dispatch: + +jobs: + build: + name: Publish Contributor GitHub Pages + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Publish + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CONFIG_FILE: mkdocs.yml diff --git a/contributing/extra.css b/contributing/extra.css new file mode 100644 index 000000000000..5499fe3f0732 --- /dev/null +++ b/contributing/extra.css @@ -0,0 +1,3 @@ +.md-footer__inner:not([hidden]) { + display: none +} \ No newline at end of file diff --git a/contributing/images/hashicorp-black.png b/contributing/images/hashicorp-black.png new file mode 100644 index 0000000000000000000000000000000000000000..3aaa20dc795ce7c98f7e3ec2dbb3e8a0a7ea5c70 GIT binary patch literal 6857 zcmeG>dpy(s*W1ixa@!E*HXB7QBUHv1X2?B?Qsk0Gxx~sPWD*N=OC`ic7x@+{NjH?x zg>2=Ufbur^FHr$&ikD6KIgp8PP;nWii@H} zArOeTy&ZW61Oml^kCBKFfG`Zq^}z!gwZqm5QuRvdEBKLez{@_!$qBLvj71=VP!vRf zj{@EhC>kQTHikg9LlyrS?|^FljRS)~(t;uIzj5|}Cx58J|N7@Cz=HmpA`A8}Y$%o` z@Xy$YzizMi12lLbBJ6fYK_GfK{s$U!+2R-=wL93ui{|CzNC*fI)$XtM4Be>MFq&VC zZderV50QV-As>hehzyRP1&4=W_;mgJ!;jL4SS+8>Kd(P>(t?Bj%_%JE?`?q%;`uXp z13i8GKeWM8Gd`5y5*d5|aOTrDH!xen{4cP-`IzDP%>R=xe|EYC1zR;2HN*d-Hgi$O zCmVM|Ao8*HWJ`}2==epaWA9t*D7PmZEQ;wlNG}CC8%b87f8~F%k$dCd?6_*V%L{RO z^FH_)5wQ-^*GE1B=37V74?AGBpk&#Q(mM@P!lZ7K<(yJc4bxu}rq(c2P7+)l14Y=8 z{vOhE5k|Odi;<}e1L5fJ@gggp=GO|IH^H+MCL7)2FGz1P_?334JnOg3Z%=>dhz@-Z zB4zqI*SEBL+ABmIl}!laDr{EA&|xC9VR_#^CZZ+ap(mJV^nPhv?Hvf%D4@1!Tvhq7 z`Z}y6`k^nF`q*`3VLER?acxqH`b>@e!1r}^X|xjF7Bh(xNHE4K;gyio6E$Jm$Wwn4kF#LsI(tFrmY_zl#han+MG#@@BQ*>qe)7Ba6 z)Vi;8)YF*)(qKa1VL+kEBMPMfo`|{Q%QX(kRip2g+IBfzW!0EX7|{bfT%J$l{ZtIh zbZnC4Zc9>3b>eNMrDSeKtT^_Sx~2{F^vR!2q8RDCU972cjgRq_Fs&_jvKv&6@-6?8 zV$vQL!lc&!C^7KJ_J8xHK$VW$z9g&Bg$*FV(A-(SIx%kfiE`B(gK*f**Q-fAn!B1> zA#kIztJa6>=TI$aGa?E{kugs9h+{d^j$p+v$mgs3)6Cg#+l|IFq_hX4D{QYmi@`#f zREr1)=SjEtMKQ!-5vA$jt@&HR7wc8&lMAMg`fht~@@30)qiUx1i9GE8qTc!QT#|NK z_=Wz2tDjoX38X?PDKSK*CD`ApM}R8t`)z;KCg5-sbrv#VUG#Hr<@Du5a8|ZKpiG|X zvoR7K(_sX8q_GlfV*RrzGvS+rJ5Rr;6bW zRrw3EK)3`ZN-T$Ot{tGTPBh8)%79t^O?x#^@nOn?`-raU8D`{ zh{=c}zzFgs;GlfxzMHbP2!DEwso5WU%A6e$%AYw;>JMH~oUgFywymGhU226BYQVT)PLu&lqOZL5aYd#+U#U@?y0`YYxc_2)4Fn@jKv-~ ztf0B~s17M>`R?OV@$MSOHhaOu)GH*D9}DdAiWZqu#G|iL*Y#2l>)*+4Og`eKDmIg_ zU0rX}jb4{)v-f(HlHFYLUXE@c{FtA<%;V@1;Q4z-?WTy7JLEFX>o}rKxWseKxYy2Z z!*wR-i#g@iPbxyI29KwQWRM?Uo{vjcae7R3Vt2^2BoYs<1UgeiMeejKXtzsrqfb9^ z_%<)|s4$&-skBq@Qm1&9y+7nt!=Uy)8yRA$YK%R`pzxYCo!&-&`U$XzvH7f|OLv>Q_3rY@ zxifJdR&JL^jXa3x*nGO`uZ%xA87k;4< zz6SiF(i>9=Qi?2efzbfF_4(ynVS=srS|AxTf$v3*yG$lK5V~-DXHNpuOrL5ykGood zEToSCA<(qFUOXd#HUGn%2ryzq0Tq?2b?=1tSR@wOYGCN2QV}*Zi$@=0O?O$YuBIh; z0y23Z5aNRqhrb{QHpERtv?$d9|72yB=H&{Y-`1e0ir{Pzc(ycVxfljV+bXYx%X|mcIa#itF2VZlm%6cxc5j~>x%_bO zVxxXEER$_p zzHd3>j(d($l$DqKHq3ja!W-1|H}WY-%u^+}JIL~58GLC_F_}$DnLM0eYo!`-7uB*2 z9VsrbbdOc+v=i2eb-jgb3H6faEbWHR+>5c?iqed=@rZ0g=S^}B1=_LVKrZ`a0aJEw z^~up@HQ$bIbwp6fX@}ai+`)FZpRUk0Ao49qICP^+nfQ0zUNKGa#)GD35pbjxYtC+Ag6UGXo!Mh7!*;MJ5SVp(X4nI068=?vsmz9|jLsrO*ndy&|^ zz`-tp+JNA{5d`}>B!^LloT&%iN&wzUd+H1d&%-ztG88v_1Yx(I26Vz>Tm+TqTM7`G z^6WF<#{>MhNK-moy@m-qo|)4I9GMGrRgOCb1B(;^B}KJt2NJ9tlrt3D?{Kha3!t>c zO65FA;Tu^z-a05lTrMV;}64fHsmrun(P z?HW0{P^RYlo`M4Sm>LV&{pOJNSyCOK{r|-NC!NtJZ+EmmO~pn$CVgWInNDrf9yxww z(Bxtm4A>veku*Ed8UM8@O2YWVxT}DP^8kolFCSP0ZKQ7kdf!?54y%!~73h8PSHVSi zC5DCE$qmZLCk+6-KU@wthN?&gMzkr?-2saQt~E1}{mz~x3XCWlT4#qCb^=EHKO%Mj zxp@0JZT9&t+>5JnK|8k47Y`O?z0~u&|9y2d=|kG9it?Ofop_i0jSkT?UD=M%1108iF!|H+Dmv zHn*Ha)%(|JjO8A|fM6s6?+d=QQEHh~?V1r6sFagLp^@G?pVgqR<+l6eRyZ(A5#+vm zko91)<52JP-FJZ=!C180WoGrm@7iOM0{5$mt+#wRe(0Q&w&O4a9#-&KJcO&{NVQbf z_K2^?ZfZESzD59$OUEDP9ZQ>a*ml4^&#hBZL;ZoS?OJd+?+k<{bd{Ts9guz`{D^D& z6(J_o`bpb8x8|sGQsM$1e4k`e&b5L_NIMhDjjNj(s>*Q4;#LJ#n#yjxW41( zJ*sAzb+y~hPo=oZ$`7}-w)|0{Q5sKk2)*;571zv@Z24I8bkp&?an9Z!bmwaaP6ahe zl9`gJlsODqGLQn~f5kZ(6iYO|7@#L6P#L7kGjJU!BvRS}Or#hIEYAv?D1Elz(G=(^ zzm_N0W0#6f{_Z$Kiuc3MI*!}#zIbG3TF`Xw<`VKCJ;SI>xM}g&dT>Rs(lzR>7)!v6 zozMqBZVU<5xq+kq1Rc9hD5dQQv8;_3;|O!X)ePQ}NU#F8q`FhuYcUk$1s#)wQ~kny zCyOYx!a6Qzn{e2~bE6|CBd!Q0*MUvOvi)7mL9C6qfu^oC-G*XoZx!A>! zfV|U6$8vJU`B$eD>y{7Rw@V9*ewE@=;UVfZ?}V4g(}kRv(xi_HaX;s$qM5wHle%#y zhkio?>{#nz2W9%oeM7Wjk_i@@NBITP5_SU39ce1u*v3;@JuQZ4KTC4(BQ9;7k<@_s zrHDwLZgGm)Zne;wK#|!vP$tpR0vZ=h#Ue&BQK!vWxWG*7L1Ob3DpQ4-mPw6r>pY`D zu)JBjS>1IrUGRA{D2Ea$t=r&L@;_{8sbSF<{ELvGt#)Q6l<=Iphe-PAxEl4(DvzuI zN|^i)_?-${)3z!~twKb{8KH}yCe)Ck+Rva@)BA;CPehOzXYN*5BF2@M(Qb}X4mTuL z8Hu*3@JMw|P8YcG;&Tin=<8BLIb$Zx7A=e|v-4&qHXC_D3aDrFret*jjp>66Py$u& zvh?|fT%ec>X1&5_h2?oFNB%Vfd()einrP(-bW;FdFV;Xg!8*@x zfCx6Ll!q06YFrMZ;`)YTJI<_cK}`UW0P&Y6dmhIM9--a@6SiM0BSQCy$Q{gLMe1ltK!=;OuIro8BtS<=V-3d79B zS1taShLZ>(4-;u9^q}QCGQ>= z$n8AomW&L|bKx7>IN*6ODCK@jF;riJ*j?r3=9Y&HZED?d+mc_w9)nF=|5P&Op=1?4 z%3YZM=9~F64s-FEy;s*D+ z6|Qinscuj!{M9wxAGYD6UgZ>{wyHgEibYnO4Gvb6y1V)ImLU_Ip7x@iooupwEh4Zz z_L5=PdNj8_UU?sE8O88zOM~86cvLey>#!0<)|lNAjWDAO5`{rl+X*67Wnbvc3w$iR zTXv-wv*JaaH*EtPq!@>M*X~a@c6X28T|CVXM&4blluAiYa`y>1JYqjgu3fH(dsnz* z>$k5)W!K*aL>gj2{_-RB8de6^>@X^O>`KUiPiU;c&M&CUcl?%$$bKf73~yBfFyQ7O zQmU-;BxiG{3-~RL_1z^0qOiifyawf?Cw6U-A@0!|K`NF2Am2;Z_yYRhk|lBVw*wZfRE zAXd*_Bg||9t-8?{^LhQ~Krs?%WzDMj7?Lx5*j{Cdvm2&zXPh}&W4Q*Pg++xhO4Hu1 zq?nB!)p^H^MKVenEZabi=Xd0i^erU2r{z_9GCHdhG)qY<5y2d^0!lNBASDpOIw@k?=`mDok&Y;l4u=q(PV zweWQe0_HiA^?{o=6Dqv3vhHnXl84fUYW=HhuCdy^VJ;e+NWbjXUu8$z`At^UBA0e# z<6iv@>Vr4l(Wa!`w`zt7_FKT7&_AdC^kJ{x2SQ%AG{ZYt7XA6^2~YhGMzAy9t>5{# zZ!^+h!GbjUbq=9b8)!xHxqnBD-x4K=UjY84)_dtqS^WWqw{Uc# zJuB*S#%%FU%e5x&3FmQQFP`59Gdn|SoGGEdAQ|3S65}%(%vt`D z_aS2LK3H&HFJO?GAD-vk#2;##<~Nb+`kv&ABkV8&FkO>5UIRX~ZJEz}IV2tQ%G*s<#+zh^SUotTbgj8h0!n= zjLXc_=qL=vk_3K=k-Na1`vqcj@WB##)PxMH?ZeN5KN3#cn|WDSz!bqX62``YgRw$G zz<(HvFpO>I8U{PeBJ%I`Q5N}s#=v2)BwrZfpD~W$6S`D}e*OE&TEg;QE0)0jb2Lj* z3G2Vt#n8M1=XS=Sf=wMlVK7xG=!Yfhra=T)%E8yxKFr?2T*o6QK-Jwd=+tS|sDNN- z7ECuv2V4f64s$0&1^5Ss>O|>D?u^g@*U)V>Ny5&Murqp+_7>Iz!=RAU1TEFQs_K&Z zXaa$t8{+AubJWQApXuN)JxQOiuwWfEwaCaw)ksa%pb&304Q*|0HT6Aed-kY+5h|f) z1H;^-R02b#{$Aui*D*RB>Jj1_9OfGoNPyOLKNS=nrY9*0J?P(mf6E!>>-Aqx3Jm>c zTVR7~&^Kxts_JV0t_`N@LU(nnLVQnyCqwJ&Yv}Hb{2%xJd5*3c^zi>C%-=iRxeK! za9m~_LYnY@zNDriV>Z_UxT`hMx5DLl3{E@{n}b1G^E+%y9V_9VkZCOMq~=(@J}R>Sq529aBuuN0?tNr8vBiL&f_jCR^;X8*H35k3=Q zuU5zfH$wGNn-0nuR_4HkRo)WUdXMWOJo zKK76or=e}Gn#8?4!|mjD$MJ$#`F`G#ef&xM{c{&GUCX1DSx|gtaa;?0DNcktPM4Wq zFYY?wM6qAy;#oU!>{*bQM=mo5#W?tq;q|~HVC7rR%*cbFrS~WB@Nhci@fq==lR%fu zZp3hoV$F;0?xhPO-6>wfJn-}C{&}-RL*2x^1nTzwNk`Qy5-j^ltCR|P->XFAxziOA z?`QO1nBcIuatiiKSD&TJeG4zWz*6uEKP$4R=T#s^#V(9sgLGT6m&ZlSjrO0Lb_4uI_L1W5pB;BjqtP>F9p-chY6GjFN4wh(_QhG8Tl-Ji9-fzw|OI-DvilR0(l4 zanJ8d!-9TgbSKkqZ!)@(4+&T~)}a<|0s9ACQAwUgBubC`wUNYjS+-?A`64B5I@3tWklX-pO~1JODpHSNh-@H?u<`wnfMLG>Lb zN#_-*`pC{_-CE!7$(;D1Q5tHV1T5_Qa@_SNCyc^v--F0U1 zB{%zdNvb=l)9e}Bx2Nly^mmLS&5p$gz9fBLjP7pn)+(g|<#Q>IMWfEB&r$MRqZCyqlNIy)X2=Z@#N?9pQZfcL`85*AYB=tps z`V33YzQ!^B^oajHp}MdSX7J>WZ2O8IlH%pU8Pfu9ntjh!?8glQql`MQw7R;zJ)ueT znFXR3NsY&{=o6pXcW{a`)&=MmaBbiKMQ1HpKJvY&(`L&)qKs^3sW0@PB%aO&pr=j* zu@?N{l^R{Xvq788H=X(%f<(8y@bMGET)#6oq&O>E-ngMVGJImd7pWwsQW8&zfiun~ zZ#jng#bY0YgxQ1=VrtGVqta9JK=Uj}aMR5Z(Q;>Ruzp!>+##1Kfn$QZK79)T(BOq= z2^mg3ruG<1)8?hAuRj=YrR!WmNHdhc4r_b#^LB%U_ZmsWruOd0@g3|*v;t{Um8TDG z#_ZfA2!XMfqcr(NjV}so?(F>sZUXeC7V%o+qm5%u+ErbPXq&xNWC=l$8<>CHdSZy* zuVO{SR8J#Z7|5mzT+?LjXE-h2cRalC`4j~IvW6teTqZi9)GKO0V9U>sJsoo;4pCu3 zq6|yQ(c3jT`ZN~MPD`P5ptJK}ehOX!%^t>W!>D~7U*IA`pss=-7x}W{!r6fTG~~5gf0}(#1)g*cp3F)B`rFK_Hv zvxZm``n7+v3wK~RHhMEoCCOnl&$QNb`LIs~l$u%{e3Pyo4(0ygR* z@6e)^oxK)Y()(YTHAI+h>)}DSZ|`>nT!1{Bl_%}fe70qPNG;9Fv1YZ*#v0`Jy2AWS^Sk*oE=AxxMRTqiJb*pSn zon1`vNZi{*gt=kjL>4>p2+rrc5v}SgJn`6YnwNJqu^#bVa_M^T^ojm?d-pV13_>)V zCPO{xw&}qVJXXX5Ql1==?5v_3`7oLH2;n5$CPVN`SZj6RgETRv2 zi_9mmLGv=g2^NwHbx+<4a_#z~J@ENrGAs2hLZBgYoQuC?f%7n-HUF0|h)#9+h}}vF zqydj05Am)D*9<`;Jo1C!8RR0XKbCu#${$XNE>Txn+sg~Mrf4>c-RZaIs}MY+!2i& zPm4ms;Nr^!qp6rMt1uG$BQDBtZm53Z)bV1$=-ur2)H+wK;bwi&@LGWJP2{Z)T?!HV z0md7_PxI1$@2i!Jt~Obf#SpbRgz;M(DM!SdToGlpOYD#y3tGsU!YI#!gtakldwM5j zh^~{uYH2%+GpVirU5n9<4FN-g6A7Iv<<-y5RvLl`_kh=P*Tp8!OfEmMC=OD=Ajt## zeGYR12S&pVZps{*#044heJ*bqbO51@>}+lMVRbP`219QzJOmN17a61h{&avf|9D#& zvPJ5B;`!!4-f$&~+xIG^Q3ex0eks@d-d`YtBMyQjw}&hD$59Zpam=65h|NfPr~k!2 zZT`|2bAfQ0l59)&xc{E|^I4Khk89(e{>h0r>f7&tx-ZLkML)B)a(Z!L!MKi}eV2(# zsaL$y;+LjNx>uE{R#9KAeB}!CMRS=a5E!BG7k^^KHn)yx>MCJ4^E3%i{`D)Vld+oQ z;K5Ti=LFAWWpu+pTn8XqysaTlsJm`PY5W#-aQ638)|l(M)J9rZJfZV#`<@LSP5>}- zhXEB^?w_>LS+CPmz~Ik+-!s!@qi=eJX@bwFt57}4MQQ`UTg0>OKCvC{{erlh13Avj znOiS&3g7GoDWwVInfXr@+^?pqZ%LqE=*xy;P^Kk#_^YuKibgn^2bKGCKOxyHxfLhf$i+UqV+vL8v+OT$$YiH z3f^1;%KdJN1!yAa~{=!QOvf0s%%R7xIsMMG?^Fbafv$tcw?p0C`X#+eYN3 zRw*UOJAVnhwAb5MFnxIoKVqc`e|(kn2k8AzC_bDvyx#YiwkqXpG&OnsGpnWTke&dh?EIxY?T331Vnrg8FHZkAF5-^92^0%gF zK$F6bgp85_(<>X3h z!mM4}?96O*^m)(yGP3i$OQ~%8&kbW=Pne=}8)N>F1a+t7NP(EL~GiolRUMl3&^x zv@U8UxMOIIj!SEogV<4gBxZg`n^}5OyHFW6oQ*d1L`2*M07F);syc0oMMV5C!5i+X zy;U%_evYOyYt)d&b+AhCn8!DDkc_PbS-MIY2|+m3cI$pMKMq#~e|WDxt|t??t^3gi zE|d+?%YT4>t)Zxcg3Ba{0qy91A67scO~s+ee3%0kAKUD z{<5r1hCA>sjU0BU{JAlSO+1#q5AZQv*$mSXdms$o)o3Gk;~tLQCOFm~_*OqyxAKwa zPsK88o&os1S{MSz#<&g$+2D%VAD;n!2Ee{kXv6P9S}+u+Az;Ps#EiS>GIj4M?5=HB z_Z-f~D#RNQFy#f!-g+i{UU*KMs1<)XZm8Q}4|HqKD)+#UPNuz*KnERLak&8C#TPhb z#g&XZEeHA51f!yZ#>wxK%PsEbaldq=P01i$%0*rCQEg~1p1q*eRCMb*CfLPa6 zu&t}iMOA1n0*pa9>@$YQmI^>K73w<|Xf6tj!QJ&w-C>ddSRCQ^nxVNk5H2#F?*t(s z?n{>t?<2e-p}8`kqCDJlR|BGrK4w4@sNS#8+`}ODa{m9=!1{v(LYjsOe8R`~Y)u2M zCnL@dv+;3&4sqQuSpXr%a|mcl-$BRVL+&xDEXXF;fK7x-c_Hrt6Q(myTBZSb&LnvQ zy?Q5Df~lqi18^OytpyBBf)@cD7xCy&Azf}kndg5W@V_ehpI*eQ+n{+G31Qa@4|0wq z1~Zux4@DP=sMSNDP);ddSv8(~TWxo5T=s~6S&W_y%r&=2ARSTj7c=pl7_t1 z1$e6qO2-wNn+V2mX8V~!AaIf64y zWqNOM+1Sf|imd;ti0P^rXUeD}A#$87ue{6Q<)LUPx0j{+b1Z=|b)gFAuzQq|%;ic~ zZRsreu^bW^p+9xTS!FM3qoz6ofJjE%x-B67`Aj?GzB@|(FN2PQv2B4Yf;iTygTYE%%w2`sspc>n$e|jEx6~|0{cU1}UP6XEP-a*-_XxI~*j!tyq5J!mPDv8P`2ixQ*RX<^5vQ^MI+Wi==ay zyGO-ew!>JFmSs?$q)91_0cVxYw75ujQxG@;_#R8EM#P8?97=HSi`P1_YIp2X+wo&~$Emyb5V9t~B+Cy5 zqC>8yEn>^mJ7~fy)wf7KBYa5@I~Ucc^Vr7DD^*H+`zgLLR$qf8ie{cQFF!ULV(pR` z8=XJ}lHXko(9Eg~xuqP3H}DwNa(IoTIVW9$vIK-fZ#i2OKFq>hIQqVDU&t!A)mU{zLsGgHvb6ry>_Z{z6A1{dyT*bRS|krzqn@RO7cU=Z&S z+sRaDbUOkBlL~T5ytj$m{>XXemq|KJzOZh7rK5CknjtLu{Ni!lZC;K;cR@0|#6uGF za}I?1&pnLuvK15Ws;%mq_bmsgV5$$XH$PSw%0b9 zzfB?5;F;HU6)bOYE9bm`YUwyw{G^qy6@mLe#8lP>=tSuc&L790z|c;)^S^qfzQ6-| z<8I1ufN&4~Zbvb_$vUTA6?sISr#0|W?6s3_Xk{oZ;_iVBu>yYt;Qq5fO&t_qq%~HR zA6LRHhrPXr?|##YRK!dvTbk&d>g$kN)bxU)%M=E>RpikiP^T7%s(u`pfzaMSC1qS z&iW(Ki0Q9~yTl#|cKopEa_0}0mlUw$k+YY-2`mzo2rIJ=l@FA7e6AuztOE()FY_@1-+kSd4&sy~mE81gO4s7aw_0=XcJUwP_Yl5-gr% zq$k-|75kKYHUQU?MzSDnK4LqqJMk^Lu>L|9=!o(~Ny}iAN|=wIczV{C}Ex= z^$4EBrmFJu)dq*TdE1zN4Q{_w+Z9*3V_qYbknZB83B=an3WpFdB zeSj$lR1H+j>1E!vn?euq{g+kGcuQbd;-vQu7bcn5%RdAL$Yf>$^K=PCFkSBphD^EC zTuCF=OeP%l(7aykcG9kHvkqEC6t~_v3f$@HC~&7nPdQ9A!R)nU7LAq#+Epy5#dzj! zS-n$j+THms%IbrK?~)B+G7gdUFQLF|hMoc-9-IrJHjjW7`et6RU#O=FMrl~O?n(OD z*aX^}omKpg5WX7QE-Iu1$eFr3^Gq`i8_DYmG~`<{tYdffVu6aOm^rhSDf|L>qv}#w zr#oAGr)re5yST>A_u+`vkR|$gk3_8noljvkrW86N>qC`E;dgMn+X;dM_z(anj_gf^ zFG-lM-nsUHPF0l@({5RuIH3Ei=>vHE=K>^`x}plF6@?E0=Zl68y--n40kNNt}Y zz@a4O&nEa+qktz)rXrsXQHHTOV_;=zR80Ez+_lW_P&5IMi~-*1ny~4lV>84AdLk)U*A=msD!noDN6= zJ2k@`7fxFNo#pgdKn3Ri-cN-gA@;jupoCUGMIp$lC8Xy-o3R{q03x*9P)n7w;BXy2 z@#7ai;D=t2N(~}yf(FN2&x6C#U$UQLfTr!>x#rjlJ)gc2!e!pMw@klgxo!xAcLi%m z7)@0SITZOT!3XgV+dmONNoN9S^&mj267^N&!xy&6hP$IX($X{)3lJevK)0HU;1KD9 zfb-{Nc?`-^y{{^Gg}yg@lrC%|vUYeS1jnDZAo97q%4W*7N54FG zzZ)Vf9uQ&C`=~13!d55lMoIL_W)35!jXu(Ue$*ID{gS#61RedRk9;s*mH@|_TIr9w zr&C|bQcHnaKr3G?|5y6pF?<9fqQ-Z|oa=zsZ>hx>_OXqD6ofvG(sk}zOJk2Fmp!Ft zZ+(nuu01$|cru;Z2i{x2uJ@MLovkZ671?ah)P4%u?5Q2+8OJx6s`fSQ)4gCwD>CM^ zd#}N^eRy19ag5KY4a4;pa2X=Cd)cXU_s}`QG;}<*((^jOfn7 z^fvJNfKN6QGlH0?AmvUQ@Nz|IZ_74cc%jfKO-!L1rQ1g-nVkD5?@1E9`+_tgvL0@{OJ_K5KgG_}V*aE{*zuT7#jHZv>!lN%8 zu!LFmL;_Uf0Au!pHl9E1)_|(N09S}JV}YMD=m`y!P^ieK5&0OaAxPMOs~TV#>67hf4|P+t}%qgMJZ$U zx9nR`zX{-j1yybq_p&a!QK3TUkb$egB-ZZuN~~A70MwE}@w#aix?8kMghl*z#ryqv wQ2Y8?#ZK=MWDqFbfiX}r`M+E;S5aHyw^zl!7U8AWpjR!;4p|!2lHKC}14(c37ytkO literal 0 HcmV?d00001 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000000..da0e2462c012 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,48 @@ +site_name: Terraform AzureRM Provider - Contributor Guide +site_description: 'Contributor documentation and reference for the Terraform AzureRM Provider' +copyright: HashiCorp + +repo_name: hashicorp/terraform-provider-azurerm +repo_url: https://github.com/hashicorp/terraform-provider-azurerm +edit_uri: "https://github.com/hashicorp/terraform-provider-azurerm/tree/main/contributing" + +docs_dir: contributing +site_dir: site + +nav: + - Welcome: topics/index.md + - Contribute: + - Building the Provider: topics/building-the-provider.md + - Debugging the Provider: topics/debugging-the-provider.md + - Submit an Issue: issue-reporting-and-lifecycle.md + - FAQ: topics/frequently-asked-questions.md + +theme: + name: material + logo: images/hashicorp.png + favicon: images/hashicorp-black.png + palette: + scheme: hashicorp + primary: black + accent: blue + icon: + repo: fontawesome/brands/github + font: false + features: + - navigation.instant + - content.tabs.link + +plugins: + - search: + lang: + - en + +markdown_extensions: + - pymdownx.highlight + - pymdownx.superfences + - pymdownx.inlinehilite + - toc: + permalink: "#" + +extra_css: + - extra.css From 686a2f36190c56366e842b0a39b169fe153be527 Mon Sep 17 00:00:00 2001 From: kt Date: Wed, 21 Dec 2022 12:59:56 -0800 Subject: [PATCH 2/6] update nav --- contributing/README.md | 34 +++++++++++++++++----------------- mkdocs.yml | 22 +++++++++++++++++++--- 2 files changed, 36 insertions(+), 20 deletions(-) diff --git a/contributing/README.md b/contributing/README.md index 719733b9044a..9f0e3725f151 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -20,29 +20,29 @@ More granular documentation covers how these fit together - and the most common Basics: -* [High-level overview of the Provider](topics/high-level-overview.md). -* [Building the Provider](topics/building-the-provider.md). -* [Running the Tests](topics/running-the-tests.md). -* [Our recommendations for opening a Pull Request](topics/guide-opening-a-pr.md). -* [Debugging the Provider](topics/debugging-the-provider.md). -* [Frequently Asked Questions](topics/frequently-asked-questions.md). +* [High-level overview of the Provider](topics/high-level-overview.md) +* [Building the Provider](topics/building-the-provider.md) +* [Running the Tests](topics/running-the-tests.md) +* [Debugging the Provider](topics/debugging-the-provider.md) +* [Frequently Asked Questions](topics/frequently-asked-questions.md) +* [Opening a PR](topics/guide-opening-a-pr.md) Common Topics/Guides: -* [Adding a new Service Package](topics/guide-new-service-package.md). -* [Adding a new Data Source](topics/guide-new-data-source.md). -* [Adding a new Resource](topics/guide-new-resource.md). -* [Adding fields to an existing Data Source](topics/guide-new-fields-to-data-source.md). -* [Adding fields to an existing Resource](topics/guide-new-fields-to-resource.md). -* [Opening a PR](topics/guide-opening-a-pr.md). +* [Adding a new Service Package](topics/guide-new-service-package.md) +* [Adding a new Data Source](topics/guide-new-data-source.md) +* [Adding a new Resource](topics/guide-new-resource.md) +* [Adding fields to an existing Data Source](topics/guide-new-fields-to-data-source.md) +* [Adding fields to an existing Resource](topics/guide-new-fields-to-resource.md) References: -* [Acceptance Testing](topics/reference-acceptance-testing.md). -* [Working with Errors](topics/reference-errors.md). -* [Glossary](topics/reference-glossary.md). -* [Naming](topics/reference-naming.md). +* [Acceptance Testing](topics/reference-acceptance-testing.md) +* [Working with Errors](topics/reference-errors.md) +* [Glossary](topics/reference-glossary.md) +* [Naming](topics/reference-naming.md) +* [Schema Design](schema-design-considerations.md) Maintainer specific: -* [Updates to the Changelog](topics/maintainer-changelog.md). +* [Updates to the Changelog](topics/maintainer-changelog.md) diff --git a/mkdocs.yml b/mkdocs.yml index da0e2462c012..8966dc31a6f0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,11 +10,27 @@ docs_dir: contributing site_dir: site nav: - - Welcome: topics/index.md - - Contribute: + - Welcome: README.md + - Basics: + - Overview of the Provider: topics/high-level-overview.md - Building the Provider: topics/building-the-provider.md - Debugging the Provider: topics/debugging-the-provider.md - - Submit an Issue: issue-reporting-and-lifecycle.md + - Running Tests: topics/running-the-tests.md + - Opening a Pull Request: topics/guide-opening-a-pr.md + - Guides: + - Adding a new Service Package: topics/guide-new-service-package.md + - Adding a new Data Source: topics/guide-new-data-source.md + - Adding a new Resource: topics/guide-new-resource.md + - Adding fields to an existing Data Source: topics/guide-new-fields-to-data-source.md + - Adding fields to an existing Resource: topics/guide-new-fields-to-resource.md + - Reference: + - Acceptance Testing: topics/reference-acceptance-testing.md + - Working with Errors: topics/reference-errors.md + - Naming: topics/reference-naming.md + - Schema Design: schema-design-considerations.md + - Glossary: topics/reference-glossary.md + - Maintainers: + - Updates to the Changelog: topics/maintainer-changelog.md - FAQ: topics/frequently-asked-questions.md theme: From 08063f1f3a9c213b3989355f6e0df38da42bfbf7 Mon Sep 17 00:00:00 2001 From: kt Date: Thu, 5 Jan 2023 21:39:36 -0800 Subject: [PATCH 3/6] fix nav --- contributing/README.md | 3 ++- contributing/extra.css | 0 contributing/images/hashicorp-black.png | Bin contributing/images/hashicorp.png | Bin contributing/topics/building-the-provider.md | 0 contributing/topics/debugging-the-provider.md | 0 contributing/topics/frequently-asked-questions.md | 0 contributing/topics/guide-new-data-source.md | 0 .../topics/guide-new-fields-to-data-source.md | 0 contributing/topics/guide-new-fields-to-resource.md | 0 contributing/topics/guide-new-resource-vs-inline.md | 0 contributing/topics/guide-new-resource.md | 0 contributing/topics/guide-new-service-package.md | 0 contributing/topics/guide-opening-a-pr.md | 0 contributing/topics/high-level-overview.md | 2 +- contributing/topics/maintainer-changelog.md | 0 contributing/topics/reference-acceptance-testing.md | 0 contributing/topics/reference-errors.md | 0 contributing/topics/reference-glossary.md | 0 contributing/topics/reference-naming.md | 0 contributing/topics/running-the-tests.md | 0 contributing/topics/schema-design-considerations.md | 0 mkdocs.yml | 5 ++++- 23 files changed, 7 insertions(+), 3 deletions(-) mode change 100644 => 100755 contributing/README.md mode change 100644 => 100755 contributing/extra.css mode change 100644 => 100755 contributing/images/hashicorp-black.png mode change 100644 => 100755 contributing/images/hashicorp.png mode change 100644 => 100755 contributing/topics/building-the-provider.md mode change 100644 => 100755 contributing/topics/debugging-the-provider.md mode change 100644 => 100755 contributing/topics/frequently-asked-questions.md mode change 100644 => 100755 contributing/topics/guide-new-data-source.md mode change 100644 => 100755 contributing/topics/guide-new-fields-to-data-source.md mode change 100644 => 100755 contributing/topics/guide-new-fields-to-resource.md mode change 100644 => 100755 contributing/topics/guide-new-resource-vs-inline.md mode change 100644 => 100755 contributing/topics/guide-new-resource.md mode change 100644 => 100755 contributing/topics/guide-new-service-package.md mode change 100644 => 100755 contributing/topics/guide-opening-a-pr.md mode change 100644 => 100755 contributing/topics/high-level-overview.md mode change 100644 => 100755 contributing/topics/maintainer-changelog.md mode change 100644 => 100755 contributing/topics/reference-acceptance-testing.md mode change 100644 => 100755 contributing/topics/reference-errors.md mode change 100644 => 100755 contributing/topics/reference-glossary.md mode change 100644 => 100755 contributing/topics/reference-naming.md mode change 100644 => 100755 contributing/topics/running-the-tests.md mode change 100644 => 100755 contributing/topics/schema-design-considerations.md mode change 100644 => 100755 mkdocs.yml diff --git a/contributing/README.md b/contributing/README.md old mode 100644 new mode 100755 index 9f0e3725f151..4800209207ec --- a/contributing/README.md +++ b/contributing/README.md @@ -34,6 +34,7 @@ Common Topics/Guides: * [Adding a new Resource](topics/guide-new-resource.md) * [Adding fields to an existing Data Source](topics/guide-new-fields-to-data-source.md) * [Adding fields to an existing Resource](topics/guide-new-fields-to-resource.md) +* [When to create a new Resource vs Inline Block](topics/guide-new-resource-vs-inline.md) References: @@ -41,7 +42,7 @@ References: * [Working with Errors](topics/reference-errors.md) * [Glossary](topics/reference-glossary.md) * [Naming](topics/reference-naming.md) -* [Schema Design](schema-design-considerations.md) +* [Schema Design](topics/schema-design-considerations.md) Maintainer specific: diff --git a/contributing/extra.css b/contributing/extra.css old mode 100644 new mode 100755 diff --git a/contributing/images/hashicorp-black.png b/contributing/images/hashicorp-black.png old mode 100644 new mode 100755 diff --git a/contributing/images/hashicorp.png b/contributing/images/hashicorp.png old mode 100644 new mode 100755 diff --git a/contributing/topics/building-the-provider.md b/contributing/topics/building-the-provider.md old mode 100644 new mode 100755 diff --git a/contributing/topics/debugging-the-provider.md b/contributing/topics/debugging-the-provider.md old mode 100644 new mode 100755 diff --git a/contributing/topics/frequently-asked-questions.md b/contributing/topics/frequently-asked-questions.md old mode 100644 new mode 100755 diff --git a/contributing/topics/guide-new-data-source.md b/contributing/topics/guide-new-data-source.md old mode 100644 new mode 100755 diff --git a/contributing/topics/guide-new-fields-to-data-source.md b/contributing/topics/guide-new-fields-to-data-source.md old mode 100644 new mode 100755 diff --git a/contributing/topics/guide-new-fields-to-resource.md b/contributing/topics/guide-new-fields-to-resource.md old mode 100644 new mode 100755 diff --git a/contributing/topics/guide-new-resource-vs-inline.md b/contributing/topics/guide-new-resource-vs-inline.md old mode 100644 new mode 100755 diff --git a/contributing/topics/guide-new-resource.md b/contributing/topics/guide-new-resource.md old mode 100644 new mode 100755 diff --git a/contributing/topics/guide-new-service-package.md b/contributing/topics/guide-new-service-package.md old mode 100644 new mode 100755 diff --git a/contributing/topics/guide-opening-a-pr.md b/contributing/topics/guide-opening-a-pr.md old mode 100644 new mode 100755 diff --git a/contributing/topics/high-level-overview.md b/contributing/topics/high-level-overview.md old mode 100644 new mode 100755 index 75a6705f75a1..93affb57c417 --- a/contributing/topics/high-level-overview.md +++ b/contributing/topics/high-level-overview.md @@ -10,7 +10,7 @@ Each of these Data Sources and Resources has both Acceptance Tests and Documenta The Azure Provider is a large codebase which has evolved over time - but tends to follow consistent patterns for the most-part. -The Provider is split up into Service Packages (see [terminology](basic-glossary.md)) - with some other logic sprinkled across several packages. +The Provider is split up into Service Packages (see [terminology](reference-glossary.md)) - with some other logic sprinkled across several packages. At a high-level, the Provider structure is: diff --git a/contributing/topics/maintainer-changelog.md b/contributing/topics/maintainer-changelog.md old mode 100644 new mode 100755 diff --git a/contributing/topics/reference-acceptance-testing.md b/contributing/topics/reference-acceptance-testing.md old mode 100644 new mode 100755 diff --git a/contributing/topics/reference-errors.md b/contributing/topics/reference-errors.md old mode 100644 new mode 100755 diff --git a/contributing/topics/reference-glossary.md b/contributing/topics/reference-glossary.md old mode 100644 new mode 100755 diff --git a/contributing/topics/reference-naming.md b/contributing/topics/reference-naming.md old mode 100644 new mode 100755 diff --git a/contributing/topics/running-the-tests.md b/contributing/topics/running-the-tests.md old mode 100644 new mode 100755 diff --git a/contributing/topics/schema-design-considerations.md b/contributing/topics/schema-design-considerations.md old mode 100644 new mode 100755 diff --git a/mkdocs.yml b/mkdocs.yml old mode 100644 new mode 100755 index 8966dc31a6f0..0f23c3707fd1 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,8 @@ edit_uri: "https://github.com/hashicorp/terraform-provider-azurerm/tree/main/con docs_dir: contributing site_dir: site +dev_addr: 127.0.0.1:47000 + nav: - Welcome: README.md - Basics: @@ -23,11 +25,12 @@ nav: - Adding a new Resource: topics/guide-new-resource.md - Adding fields to an existing Data Source: topics/guide-new-fields-to-data-source.md - Adding fields to an existing Resource: topics/guide-new-fields-to-resource.md + - When to create a new Resource vs Inline Block: topics/guide-new-resource-vs-inline.md - Reference: - Acceptance Testing: topics/reference-acceptance-testing.md - Working with Errors: topics/reference-errors.md - Naming: topics/reference-naming.md - - Schema Design: schema-design-considerations.md + - Schema Design: topics/schema-design-considerations.md - Glossary: topics/reference-glossary.md - Maintainers: - Updates to the Changelog: topics/maintainer-changelog.md From cba69784883a98f31715408543ed414fe551569c Mon Sep 17 00:00:00 2001 From: kt Date: Thu, 12 Jan 2023 11:25:17 -0800 Subject: [PATCH 4/6] mkdocs - update permissions + branch --- .github/workflows/mkdocs.yml | 4 ++++ mkdocs.yml | 2 ++ 2 files changed, 6 insertions(+) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index 0177f1f4f1b0..a2d36253f354 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -5,6 +5,10 @@ on: - main workflow_dispatch: +permissions: + deployments: write + pages: write + jobs: build: name: Publish Contributor GitHub Pages diff --git a/mkdocs.yml b/mkdocs.yml index 0f23c3707fd1..d5bfcba7b0d4 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,8 @@ edit_uri: "https://github.com/hashicorp/terraform-provider-azurerm/tree/main/con docs_dir: contributing site_dir: site +remote_branch: main-gh-pages + dev_addr: 127.0.0.1:47000 nav: From 610f0f083121fa775534a3848a30d55dabfac72e Mon Sep 17 00:00:00 2001 From: kt Date: Thu, 12 Jan 2023 11:35:39 -0800 Subject: [PATCH 5/6] Update mkdocs.yml --- .github/workflows/mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index a2d36253f354..d3a3ba7be8f6 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -6,6 +6,7 @@ on: workflow_dispatch: permissions: + contents: write deployments: write pages: write From bfb4e462b33df7506ad53f88960766d18050c372 Mon Sep 17 00:00:00 2001 From: kt Date: Thu, 12 Jan 2023 11:36:44 -0800 Subject: [PATCH 6/6] Update mkdocs.yml --- mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index dfd9f8755099..d5bfcba7b0d4 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,6 @@ edit_uri: "https://github.com/hashicorp/terraform-provider-azurerm/tree/main/con docs_dir: contributing site_dir: site - remote_branch: main-gh-pages dev_addr: 127.0.0.1:47000