From ae0599e9970aeed7fcd896cfbbf6c333690f9fa8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 17 Apr 2023 16:12:33 +0000 Subject: [PATCH] Add inline icons to formatting guide (#3785) * Add inline icons to formatting guide Signed-off-by: Fanit Kolchina * Added space for formatting Signed-off-by: Fanit Kolchina * Apply suggestions from code review Co-authored-by: Nathan Bower --------- Signed-off-by: Fanit Kolchina Co-authored-by: Nathan Bower (cherry picked from commit deae166824f55e4a2876b88710591ac402b708b3) Signed-off-by: github-actions[bot] --- FORMATTING_GUIDE.md | 9 +++++++++ _dashboards/run-queries.md | 8 ++++---- _sass/custom/custom.scss | 6 ++++++ images/dev-tools/play-icon.png | Bin 0 -> 4112 bytes images/dev-tools/wrench-icon.png | Bin 0 -> 4918 bytes 5 files changed, 19 insertions(+), 4 deletions(-) create mode 100644 images/dev-tools/play-icon.png create mode 100644 images/dev-tools/wrench-icon.png diff --git a/FORMATTING_GUIDE.md b/FORMATTING_GUIDE.md index c39ecaf996..ac15540f4f 100644 --- a/FORMATTING_GUIDE.md +++ b/FORMATTING_GUIDE.md @@ -12,6 +12,7 @@ This guide provides an overview of the formatted elements commonly used in the O * [Dashes](#dashes) * [Horizontal rule](#horizontal-rule) * [Images](#images) + * [Images in line with text](#images-in-line-with-text) * [Labels](#labels) * [Links](#links) * [Lists](#lists) @@ -150,6 +151,14 @@ Do not place an image next to text or insert artificial line breaks using `
` If the image is under a list item, place it on a new line with a tab. For more examples, see [Lists with code snippets or images](#lists-with-code-snippets-or-images). +### Images in line with text + +When describing an icon, use the icon's name followed by an inline image in parentheses. Insert the image in line with text using the `nomarkdown` extension and an HTML image: + +``` +Choose the play icon ({::nomarkdown}play icon{:/}) on the top right of the request. +``` + ## Labels You can use the following labels: diff --git a/_dashboards/run-queries.md b/_dashboards/run-queries.md index ba0bf167d1..2f5577a1f1 100644 --- a/_dashboards/run-queries.md +++ b/_dashboards/run-queries.md @@ -39,7 +39,7 @@ OpenSearch provides autocomplete suggestions for fields, indexes and their alias ## Sending the request -To send a query to OpenSearch, select the query by placing the cursor anywhere in the query text. Then choose the triangle on the top right of the request or press `Ctrl/Cmd+Enter`: +To send a query to OpenSearch, select the query by placing the cursor anywhere in the query text. Then choose the play icon ({::nomarkdown}play icon{:/}) on the upper right of the request or press `Ctrl/Cmd+Enter`: Send request @@ -79,17 +79,17 @@ GET shakespeare/_search If you paste a `curl` command directly into the console, the command is automatically converted into the format the console uses. -To import a query in cURL format, select the query, then select the wrench icon and choose **Copy as cURL**: +To import a query in cURL format, select the query, select the wrench icon ({::nomarkdown}wrench icon{:/}), and choose **Copy as cURL**: Console tools ## Viewing documentation -To view the OpenSearch documentation, select the wrench icon, and choose **Open documentation**. +To view the OpenSearch documentation, select the wrench icon ({::nomarkdown}wrench icon{:/}) and choose **Open documentation**. ## Auto indenting -To use auto indent, select the queries that you want to format, select the wrench icon, and choose **Auto indent**. +To use auto indent, select the queries that you want to format, select the wrench icon ({::nomarkdown}wrench icon{:/}), and choose **Auto indent**. Auto indenting a collapsed query expands it. diff --git a/_sass/custom/custom.scss b/_sass/custom/custom.scss index b253d6d622..4a0f89b1ba 100755 --- a/_sass/custom/custom.scss +++ b/_sass/custom/custom.scss @@ -128,6 +128,12 @@ img { box-shadow: none; } +.inline-icon { + @extend .no-border; + height: 1.2rem; + vertical-align: middle; +} + .img-border { border: 1px solid $grey-lt-300; } diff --git a/images/dev-tools/play-icon.png b/images/dev-tools/play-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..80345f65bf01986eeb5a7a2684a04df1552dea07 GIT binary patch literal 4112 zcmZWr2{@E{)E`?IdxR@8NFie|l_4`?C`;C{CQBGgmcfiYYu0ed8jYQhEhNTP3>j_x60>`#k48=RLpQ@0|CX|MR@h8>6Rlmj%cN1ONam8tSSB6n~Xs zR~XJw?sw0^5&-~Uo)Z$Or-4L*^gJ>4PA+HwKs_ckjb0CB#uKs?0LcmmkqcyyfusW*%bHL%#sJ_kzDemFQid{v=haFJKhC%)w%|EkN_HXP<#-}B%WCaDn=5_ zl`T7yS~vt;FWP#p(|J68c4lNpXl7;w=&|?gOf&27^;{kNju+uVQ->JlduLt9XctE$ z)HE}I*%zBoco>n0;#VSCy$ozunWlQ5Yr#Qsc`L>NsNs85?BH>J2=+&W*bAnH$5cJ2 z?+V35MOb}AT#eA0h^n6iLgWe|CON zZh1kfI<`Y7>DZ4NQ%`8NOqv;yJspPRh)%x9;93${&4QaK>AuIuW^jm>#`o@RoeE)&8_mCpxTzN+uYes)1(@f8M^xux+U-01!ZX_TNOh)N=nUg9>*3V^uU;}R<3PM7_jhc--_ zoh6N$Rh`=DHmz~Um^BTFKEnFe1YJ)XLXUDeHPbnV4iRZ|EsXI+?+hr zAl-_@C>=cHIFDlmy#L!BYgtLQGUD+z^>ZrdLnRoqCH2+z-gy@o+YB(heQf(-17j<| zDk@+OaU`l32~Y*|JW4ppnY?JIN?{sNPv1PT%l-_uL>v>S0*wV$cFe757wZLmh7p|KeP1G+Ez-^md z*&UYc2iEk}3ow2i4u_ChB6%*~qq~8BntS@v1CdR|N+!9Gi^PQ;317};P6YeM4-Q}V zcF;$}BkYme574QI^3z<6*Oz@cY#69jr1HYuqutX6wRwf_v7@8?Rq1U&&$J$>P2VXO zeS03mK_A0;*(`~wJBI6y<`q{^Y7(D%x_W}fR$*b`o1*oiu%aV_Z$+9#ziV1NTT4Gy zO%u78{H43vPR8#V89-JfQ;`KCRECNh3~ahoajkJp%;xqL_agelGb}S?%reU(TykA9*SRN= zH74k&#cj`H&uq^J1VsWLA=Z=TdiYBuw%Eh*qEp=)tvAYk_~uYWEreOC-f8sX;vXep z_^>*a@OI4zU<4Ex_%u4dRai^L$m7LVna+TxIjN(m&ovc``ZZZJzi0}kEQ>cu?4>ZJ zTuco}Q7RiWQZzC!^e(wxrl{Xp!dG^#tWxhwnZL&OF-5Z9?|ZO4;F7?LLp>H_s4;$f}T zjeULa4X_}%+Bns?_*3}XQ11rsO7DULPJtv=)-@C*J)Ia{*TY{7!xRL)(iB zmluEw=2u?FR4~rkC1{L4UVr>2IgC8E7ogq!^4^H#i2q0sR1F$j`=HjocAN>v(;+!g zoom}BhrPIGxOac=F1IIlD>s3=f*S*l2g|2jNb{)>GqyDTR(`*H#`J~hUisnu+4{Um z+6k8$r&{tOXNPMwuCE2EN9tm0%ierLlb~U|=Da5B)dy||-_~`ff<0e*k#Ml3?WlrM z+ouacUGov=nEaTWd01gix2m&V;g9jF10DlP3Wo$o!fT6H7TJWg22YE_CRUmF=iPn8 zzHzrDH{tqZH^FIv>G6h~!`q6@aG;_Bd{L1I?}g|1I|YdPj|Ig0Px&tU<{Y*iACcF$ zSJ9=luyTb@B~@8le6!w4HC827gjr~?ZSb>TX8`})#n;fe9pM(WFtz?rP~wFK=(a|p z^5AZ+RhUPca@&Qrk4Q-s<0xGCuu6KwC7=KsmT8LnKx|t20sjoQa(r}rN$e5(Du)@@ zBu^dak@o0!$1%qsoE9_Uim-if--OM_&L(cQ51%`hx@OF6UfV4um1!BJzm$U4#x=&Z zto!ocl#<=lo96KbHD$uNKR&IB6I^V-dSfj;EeM^{9NC;z(Q+wsDS9c=_?46fsK@1Q z(bCJS7iP1p27;5b)|cn-im zrmfE85|Zv4C7K@7q@g771XeYxZD9Vcc3W*5u^O;pQatp?sj){F5*AIff4@%0?^ zoQl&Y6T6+vE9(4-Yo|B*ZWuY|)$KS>eOfK=HJ59c2{>tEDP$49=(d!(%)Qt;%S))f zp$o?Z&b;@TnH^i!T8`Zfkdt@&d)WXVw=P#6mv{9?C!)dZ#YBtbTJ;^-*64MfV*Ty8|OoAqeUq)KSy)ZG$g7t_ONC3VX)9@! zsMg}o_XW&#Pi+o*Lr3lxUmFm^PkN`}Zf>prL0HGyE=Md|S*SNl556tm80svE^_hAy zbqhkaX!M-?w%f^S-$l5lW1?f_)!@Izw{U;YYwDY}oQoU2*$KO6SM2IA0&X$~*Kc6z zy}|1WQyas9^S^gx_4=6kR2@pLtv2!mZ3SUmFtdT1C-d~BY%_{|{;(a#6WjHLu&c7V zn%S@56{lk>;~x-Htlh=A+wfAb}qf52Fs+sj5}r!zaTjMH5DzUuq=s3R&Y zK|+u%$ma3d5kJ|_(WaB3sAYBMa^ol zTl;Yc(Iu7@{=Hkk@%QhZWspxGUT3H$r6r%{a*lPS*l6=tVH5V0e^z6(sfN9_Hb8Bu-6axTgk|F{06n~y#s=3tvqE~Zi{*ABvBr2nj8X6Rjvh_rx-LQ@r z9FUVyoKkAk$s ze0+SQe4tVoPX~yMyu3U_S{5QJ3#Kr@SU)%1Ltn5PR^;y@|64~DjkWc3a>qGg+(19; zKD5Dj;o!o;KO6mf{r#S3U#I^%xnchqi!vbOCjya?l7{?Sn<7>GnN`qp@1sjPXOTO=#D+yHDa=9A-a&7ck6P!XTabs_O53{0aP0IAPg zPkh8TlxLfQWw*^YzcdBBn_UjtnmIh&>6Q;Yh{Hk@d%jruJM+T!OxL;21C)j0m5ralVL}9C;i$FfLG# z=$Wca&CPv+(7Jkun(K#jODAEHQwY`q3c2?^U^TQU%i=@RO6=X$dRRqyJ zI=oYQ`jhh3pUt>e#|%u__?&_d)*(M)8m`})2cX=i&9Gi9MaP>X$pgK(+~zQ^KRJ_e zn~PXYyQL%7;k#OMzJ|K7FARK||ER2Ru*ga0UKuXa-(9>+B863Rv8sAiBKIqorCM5t z%g{0~XnzfZMv_eLysx|CtjWh*@yTiy)1RJ{gK;grS7>Id(Sd1lZ&rpFpWCcp+53Q z5cgSB+rvx4^D=20x!_WtmU*WON?~vvH#??h`mx9_<8S-n_}KOp)cSxq+Wj zE*MRfotn$F@~zTqY{*+`C2i2@e^u?{hK=f3NvceU6BEIPz{!o~B6rfK_o~k~;{5D$ z9X>WTvIH`io$Fc*4bD;)P6Ve&71;At>RkeaRWvQTl;ycBDn*OKM0OJen+?r@QZ4&W z$WRfsqLAGxra;4mK)$Cf4;M07#~m{xSk3%MY?iOUv{6RB$}B_aojI9G1-rTO?2Zg= z9!f`6NoHnOOwe@Smk_Tve&~ihH*n`4E?o$o`WT})cL}eaw!cZH*RT=@t_tl%{`_)j MsOhLys#u5p4+Xt|j{pDw literal 0 HcmV?d00001 diff --git a/images/dev-tools/wrench-icon.png b/images/dev-tools/wrench-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..bb7dc988cf8a0c480cbb116bfb36a4f3d5ab0419 GIT binary patch literal 4918 zcmZ`*2Q-}P(_cM$FHvH(L|dy}ElPB&E*mXsuu8CtRThaBElLPN#Oef5qIZIg5IwpO zHj#+3x@b}Ua{u?c_nz-N-+RuyGtbQY=J(7z&pGe=1Zt>FO~Fn9005{VIvOTdTI{!6 zBfWZ?w}{9B02KLd>grI4x;hZ*gLHQDfCB(JPoAffL1C7xVcWsr>_|Yq9(f1(I5|+@ z09s^jOb!Wys!b!M(2@|j-6tI;o4}kW2695g8g(!CY3$-=-#&*>KM0CK!5b8M$6_1o)KX;yF z`K8$M5kR_l`-Nfe>CEM&sZ&ck6%7DNH?X@vWyn5oYwRb6j|ol~cDKMkn>n*bNI9vt z{Thhwdm9WRhsDA;Rj_ui9`&d#5On3)(D!>Z3ep2=*&md+cr$#I`xYgbMcMq2U;y@0 zp`^GNWvrY~%d^g>5h$$8cLDZhxMY#CWk?-1Oxw{1PpIwST&}_9$}dKjkC#%?g>#1U zlf-;d`fm|Wjjv{YHi8_bRs%zfaiaSz6BiR0{zLLyxM6hgkSJ>IMo3CWS^SxceE4>6 z%DWFvQNxm8tdwuM<{D3mH92pC36*{E=+tTy+B#w;QkI~pFHE3 zQtC5*OJtcUL#XZRrgu5dn1$!Ep4j%cbf~6C={x@-9hSUCnBGNm41nF00`z~Y9Kt;4 zQL<^)eP^UUP$cznrnj(;n6vK0R}ZBp0(iB!K4gk!l{_cq>8(RG9^5;iNGe1+^kG1q zY+)-80cqSLbG}D}cZP}b$`bil;KQ@xFm6#Gfp9XJ@ExL60CsJ_Bb?8RB&Um&I6|C` zI-QV4htTZ~v02!ZJyAbdl>O~ll7VhzC=pErACAqHw4|HF>$){rlPWEm__Pa%CfDkg zdl3e_Mr#aYFCuhP3rZ$;B9{QV^fT_osO7l|(&$DKC$rt7_Kc*+=Pl)Y9kHI5n-3c! zSrwinQ3^ZFr(XpfT-UOf6s0Z4p6(F7AdtGRB1dIQc&lgdi-#QTB1J~e)Xx28@=kzV zOfXLQSU@ovph01*QBMbp3~%NO*P%)Yi%o9OAux%!%SWvvG9JF5dYWwBe~XGn9XlrR zicLF#_9iE`TePpD*P}blk;dVr_~wh-FG7X{S2)rmOtCNRxvE7ym}KbN2(ywv-CKP* z?`(Sx?a6AE6Oh*GOT;AgVsf^7bJ8hv{6|(SL#O%31!-5N?5+Ei1Ntuc!_73Q?E6L z$9&)MIrYi$v2IapVQ-1|A(D=KrH(4`cI9wusMo7k4aBsEE9xm*c0w;=AC{bzMqnZu z)FOLyqbQ=JC?3Vd7IgCJNtk+PeU<19j>~;M`TT{hV)3vpweDwK?zA65ZNmF$lxZB# zgVR*X$4nJXP44=aN|!4d_m;Akla^OOKbHqVeoiT#1U}uD+oxFJ$~uBln@O2b8V?$m z8@J`lysFCIsua5mhP^Gl&{a3an(|o|S}a$*kG*LyVVU~IvLeuMpTs77q^M+EZ*B9y z81x5-8&qTV+^l3evN7Dh*}uxa@Q{%!g+~3BYKcXOfy-TUnCzW^21Lh}x>CUnbua|k zWE-9LxO6 z6w6jOtDjVoFF7SaW**`n{yK>`nc5FF`0z@9LUbZ%B1B44DzwhJ&be-e(wFs}=xj}% zW4A1dWB=~{y?t#KAC^v*7M4mDBq$LipU#{fP$_6;Yqn8wuVT?6%VNLc=-yIO{v7eF zN3C1k$pd#6ky_7cu9}I4_`34?4S2s)1e+C`Ilkr)akzmunh*7<_UreRTiJ;zEOU%o z=IQ$qMM@b+>CQ?c=XSd$`!(hivo_*AqM~rr;@VPe^V%k-Wxd(Q=BSNEBJstCA?(l$ zVgOMU_!SAfW z%j)DR6sAkxWN))C`K#30mD;r|NrgIwJ_~gRaN;tm1BU|_ zLS(7f4{lbK4MEuTi$8|`Fm=yw*ma+uUaJ_il5JiLKJTV3q88#nti1fe^1XA3t)=D< zBPHac#jb$GrKul!KjQa-W#ti{j+9n{FOIUaDrGV}FU-0?&1SB)7AD7VN|(U~ZqX3I z^ZP#TJ<}tejq`_yK2KJUw@p}hUpMbu0lpwSo8Wd<+*&V5?{)xa-ml?ZtJ4x<9I?CA zX>vK9F8R536K*$8@(J|wP#47)M6!lB_vj1{7R@RX15Tplk>Cx8t7qT+iMa7{Yxn0+DNBnZcElDHY zoYzW~7gMV<@0I5}rOt1h%jQHW2TONdN1s@|N7|9@=fH9@sN86#sI6#nZ|t(SoIC8s zcW3luFuvIf%{cGaYxuIk7}|W{?I``gcPDXm_}e^a`|cta8hPI7De8(}Lw`Dc7ZZ^r z%uO5O@NoT@^CZyKp_lb6WBiSloz>fuN5P7jGV(%B@v{?!fCw=;9)hqYGC-aN(VaGG zfZOhns1j&w=uE``r?NZLt^{fXOdb%@r4xl+8UO|cJ{q$m8YPkdW8*$?5qQ7_EbCC) z2MNjoE7Yr;`?o1(y52s^JUIvZUBVuhl}_VwPmRQAi3`@`W}UD8S#9NU?+92zOdR}o?JKC_Z?6K>4Gs6O)Nu2> z8qXDnvb2oipXvW6@DJg?fENEB@Lz%d4Kzi;ebkYjSA@RG|D4NTtp5)F1ylt8?)zVJ z`0tSa^j=L_nL-i#_lYS}kbYl(4giqSKr~eEx{_>K8o63)vR(QwA@oaS`0b;J86-$F z9V=!zeP+?)X4UA4SfSDwQcuGR5?HrhFukIw9_9FB`cy|9n#K-K8Uh$J6=dc{LGD>Z z&sZ>HHX39!!XD$6&JVH7NB1dY#$hGeO;_U)Mcz8CVC}giPW8Fdf`RhmkUFM&r7PqiIDl^xOx4D>~ie8TD#3Q-?$AHiohiq z2SsIlaVee%-LW8@Eh$~Zz-{paOAw+!kof|9WjKLOzCW}7XYo0wXBL0BIa z9c~W3EVA>#5A*pJ{DN9`8sGK_%;044zz9^mqh#h`R+%am<$ic5vVAzNI_)?%hK|;9 z$sk(3UnDzPRQh;IGm&F(>{Lrk9C1XQK&x^Qe4u8pUdwHCrYm^P#H>h#!uWC4kF?Ta ztI~_e!+6*f*T1q^++DQYlgyyDGWMcI6xvfHS~C%jH5uT|c%E9Qw{zvjzGl8i6n!oGX~B)J2Fa(>afDr8T7lR3VLC7LaguIK)sie=@ZvX( zBffEKzw1zDFHS>0;rIP}H_Hz?T;432wda{Qh`i1pi05ji-;AE66QQ0$n=O3rkB?D; zJ~QDw#tGlo7jPn>Az}a%*o3b2&`y`K$?yOYYukukT8`!$3`cm$vH7@f4 zTX`l>Cp~&yP?3$dv50hCb+8x2gpOiavef~;?Hvbgw@xM>d=lB)q?PaQA0Rs;O==WE zj!%R@>&S2)PMAGoSJ5YBF>B)+pYz4&BnZN(h&x%;zjix|jfzO$V)qh{d`g=*JaMpD zprU2P)-96AxiPMFLx$y%arZWRvwnh6+$2*D={%!M4{zYgc_&n8J|~{A(*buuzAKPE zy;XjPIG6ip>aUajb3>dvsrAh?pOPnVYm4jevBU_!nEMIXQ=Hn8JrR+nAL>Cbyu$Nb zk^k4hs1*!nzm+RDq@CMQd&ek854OZA<$KoS=ik;Fbq(Fc7oIE&p@UHu>kWrLMl$Ur zAGEkrvQu_Fa`f=)N*s`hofD(QlkW)PG+POYi#1@A^c_a&{sa7N8f{}a1bxK!Q?#Rn zekHL{uF)Je7QTi^!iu;;_M#!7Na`(u8^q>9E%6$CyG==gKf{U$TI(8`_XQ?imW#Wk z`izD<7Wm-uX;RcEfpz+Ii;tZ|M)C77Q;Ay?Fb))ElD=3VZ!YCcD*+i$1&t4xOJK@_ zzoBmpRrp!jo+LJPfwu53)t;_)(9*`(W1P;TdAkn>~&G0pA#^)I1)p5MnB`= z25!e3ujB885XazA>oAWM`N~AA@p~EJw>F45?+B~{=hGf?U)|g2pyLkxr{TA6dWk<{ zB*&j3JrE{`OBi94d`9&i)J21>xi8X`<*6>G?HYe7%^xz-&DPJT{ z9^pbBOM4b->wvPnunZc|Iw5C_>n;P0_Vcddkr3T|cU*JdTwKt^_)7-ACR}MDrB1tT m5ulb|LM5`4f7lPlcuM;r4XS-K60`aH`wr1G)TmOkkN6Lf5(f