From a94a8059da0c523b4bebee2a99fc071a99689bcc Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Fri, 3 Feb 2023 03:05:18 -0500 Subject: [PATCH] docs: add docs on process kill, update docs on updating docs (#1010) * docs: add some documentation on process term, update captions * docs on updating docs --- README.md | 4 +- docs/README.md | 47 ++++++++++++++++++ .../process/process_kill_linux.webp | Bin 0 -> 8176 bytes .../process/process_kill_simple.webp | Bin 0 -> 4698 bytes docs/content/contribution/documentation.md | 31 ++++++++---- docs/content/troubleshooting.md | 10 ++-- docs/content/usage/widgets/process.md | 18 +++++++ 7 files changed, 92 insertions(+), 18 deletions(-) create mode 100644 docs/README.md create mode 100644 docs/content/assets/screenshots/process/process_kill_linux.webp create mode 100644 docs/content/assets/screenshots/process/process_kill_simple.webp diff --git a/README.md b/README.md index e8655979..b111350e 100644 --- a/README.md +++ b/README.md @@ -73,8 +73,8 @@ As (yet another) process/system visualization and management application, bottom - [A process widget](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for: - - Kill signals - - Tree mode + - [Kill signals](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/#process-termination) + - [Tree mode](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/#tree-mode) - Cross-platform support for Linux, macOS, and Windows, with more planned in the future. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..33d89d17 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,47 @@ +# Extended Documentation + +This is where the extended documentation resides, hosted on GitHub Pages. We use [MkDocs](https://www.mkdocs.org/), +[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), and [mike](https://github.com/jimporter/mike). + +## Running locally + +```bash +# Change directories to the documentation. +cd docs/ + +# Create and activate venv. +python -m venv venv +source venv/bin/activate + +# Install requirements +pip install -r requirements.txt + +# Run mkdocs +venv/bin/mkdocs serve +``` + +## Deploying + +Deploying is done via [mike](https://github.com/jimporter/mike). + +### Nightly + +```bash +cd docs +mike deploy nightly --push +``` + +### Stable + +```bash +cd docs + +# Rename the previous stable version +mike retitle --push stable $OLD_STABLE_VERSION + +# Set the newest version as the most recent stable version +mike deploy --push --update-aliases $RELEASE_VERSION stable + +# Append a "(stable)" string to the end. +mike retitle --push $RELEASE_VERSION "$RELEASE_VERSION (stable)" +``` diff --git a/docs/content/assets/screenshots/process/process_kill_linux.webp b/docs/content/assets/screenshots/process/process_kill_linux.webp new file mode 100644 index 0000000000000000000000000000000000000000..26fbb78eef61c97ad256d29df1ed518bcb9e8528 GIT binary patch literal 8176 zcmd^kgiJsde<9!Z&g_tnRR*q(3F-?)=(DI!Uq6=0ld6%00B%u zR#H+q6CL~upl8|`+d5*30e~&U399;1fK*1v}?{N$F;5hUFJVh2~A8LjR63S0hACkwud@__$`R}VNUkfI1$8T#uo2PKwJW1 zb|~0E5KmmwjsD{8YixdlZ-OF&s;NqXv5|pv2J?TzM*oJ5Euglb3@<42z{C~;+DF&= zi%qVv$2GRKaR&Q#)2<`DWeQP$1KuBi*InQxAPXo0%3xZJ0B67wumPL^4)6{EDUN_D z$d~vJ`ZPEC%Al4JsAUNlgBntR9bgN*yU_=(#{iT8+rM(_XvV{RLqfYH0RULDDAW-% z0N}&|z-1H)_4^YFb(sYK7&8FS3i+45T_ykso`CeIf6*Rf006N+0MvH=i)NGn0Cj-? zKs9Oq4*KrK4+i*)Ze|7mhxq_Ns0{$5LjZuU`!{bO@0t%}{{#RvFjorw0Faan04(O9 zZN2{xH!i5~-+BAL%KRgLVC5<>(g6UMcMl<&I`L9%_}!$-geF(6IW|TX25-65Nx#IZ zr&8408mv9e1<%VqSkp81TufH!qFSt`aeG=rIAc!1^xw5bHEI|E8|27g=(b9)@p**Ek zLhk+j`{#5iMh0kHIanbK&!~sD<^$?J&<;>gnfN=EOS%okQ5ax#N)chzcft_?{wA!Q z5@kNvCAW%=^c#j2#9|(dPW?7q@|>=4@(1o(l$|KAzF{aZYahRjccG@ zZ#Pjj+~nJo3YCX%q0F1EwCN{m#T$CNagXZo!|%-*<$Q+vSyaOIU-@EXFer!XontPT zv|A3-TlT7{Jxy(mBs-*Q7i!bE7ZCeB4c7aL=^Q|dBy%#aYkSmT(J%TO2UnxmUfw`t zl6zv{RU3whhNvdnB#su`x7v2s@Nn7|AIyj3$yW&KQD*c5*_gN?<*w%{zxR;N&L!ps zob31$fB63dqW0;pI=p`oqZUN}-~O|IVPoP;r8-3)7jb`IEhIe#=SsN)9G5u=x?&p&C-~c8qp)% zB@K#5p0dRt%L#@jl#sa&3YyTj6yJ8sryPWeQK@DqR?4=4-Imd6Ekh%DzM^t8sWqbw zwD(EstUu8$s$IlPd1Q>edPvSc0<(^!xWpXa9ebTh=86a!xmUYZ(9OcSX|R4I&m38x zJ6?vS9?|EUAe7++bGTJ2?(dUmYWkA7BoooA=@iL?)=to@>SQwKtRT#3jhB|D8osG> z(+|r(Sasml`sE5Y(i6Mc*)3UdbUllmF8dKXGdgU}6g>F{=am1|_}9?*Db?>8y4!9s zBi6wKLPTD69pN@x*eUL!wLdTKMF=N<;j?K_VWw85v<%bUsl^TQEl@E=+dgIa=|x0q z$E(5~J$Yg=-BZqg#1}H2du4|l9Gd;(6^wr2)wyKYM`9ZJ1=4F<%M(d9EZen_LKBo| zeZpTz6UT2Y_cZGird3MUh-ntNM57uq%^o4%(G=E#@g>c1Z44(}X$?E(@xnlHzem@( z!@y6I-gBr6;_h^n5}BEdyDE8MGOY3E2CgDB;mhm;LTjm2>p2V; zEZB^z$uP6=84ryNqwTjk?)a@$rveY%aLRX0D0OhQthq(wMaz_)_}H-7m%C3+Xd{e5 zm!lg{l0>>WXd1LcTmvKVuvg(cw+9P;rp|0&zUA~*dMm8%2@u+}X}Lq!NYy%a#OMdD zI#WUfg_LNumQ^pgqSVID=3SVcluRZH ziOQC;#Lv}=4G6wY=eNZGkiNfUngZN-2=i*;g*X#ON5ZXb&zKpfwp~&^!V9GveWrb1 z%-W?t|7>xl7U>O(c<;IzE$KY+>G$d_sR2IEtb(RC1@zB?y*N_;&NuMA zi~1%kOpL{1#)Fr&d_AH<1ep^Hm~U;rJ!3g>T)fv^hxxMT%aN+Wqa8IY zTGP}nNyEFk5S04d7?rsJ-`zwf&1`|lLAcnLzDV_)jxkD!9?e{;3w|aq)d&no@dEzE>$AieQiye`&3)a$A%+nV$)MCs+htCC* z3UT3lWM*xF^uNlr5c^GDT3pfKoNA#<0Rj$n5}RC-_|}{pjv#sBg0RkE{Ds+Y<1omXxQ<)&VW)UC)FG`h-~4K-1Iy-zFPo(B&?k{w;BJli5UDjZmYup(K3G8Ha_SmGAAMC%u^A zF^rOze@fOo%iI3h75!odjrjxM7Ng`0%Mv>i@>TW~x7}svM>un9&-7_>9*HP#ui4>S zp8bUoo8C;EL|~VMG(sm5BW|XEP{~_l_Q|saIhm zG(~NW$;4z#y|_S`Eb(9h_UHw{;&B{X#R-a1PpHM(YTIE!q;)I;@0_^Zd!qRrL>*BW zu6Z3qCYKN1n>=W7SXCJF#oqpS#-{YBqC*&Zs#__NjK1vhS^eizQ4{F50qm%sD}~KD zWl62!m1InqiTG8??-nBnxR%*UmX3WigZTst*v4}?>*q|W)N1$!veXCHP1*x%2AsJE zM#y{M>n-akcbAUKR(k?Uk~~=GM2Rn`T40+J6Tga%hu_a0#8H>J9ovd-pVrxA*G}WK zk#Efi7PR+60YCty%mk>^UL3g6Cioil)_CMAExwYbqfB3;D<-!u{~D7h5bT8*21llX z(V#K6;Zpae10#Z8e?@JHzgc-kZN3p=EPrfxtQc{C{D~d4hWKD#$hzkXg+ezafQsv-;3Cwp7*BT)^jNUjL4Q@P$P#betKs)Gvmp^x9ly zMiWs0vw`ju^qW*@k7U(oXz!bjRi<)XVWkldRY(Q()?PPdncF2x} z3^^H@+UtY3yVApIM#;F+8eecww=kp5_{B`D0Y*0OSj~f_M?a$PzJAap;NUL?Mo=uF z5N$>&cUP0)nzGqk_5PDl1yu&y$F&I0q0sb)GnY3H3B`qpExide`ck1kpw{y`vzmEh zCNIc$4Iju@GjCXM2oRO7c$&(Q%VF4;Z5>jKe@G25cQwQ-%&+oDYObmu_p+m|h)>$H zQkc{J!=2ToA$k;SdNHuLmT_Skt$wCy*{ab=%qNdqvN>ypP4(8Q$3N@w(O1bPDycc` zXAFk#RMbCxlBs25(nG>1&W<9iF|h7t6#<1bZ;F2pEH>|H*k)F9)NPN7YzDU@y?>QO z_@TJ33}G76Yy7BAQ71*&`zJV09_)5X^JSWfhhKg&;rWF)o zSF;xcxnry&urh`Xh%%8RB1xh?!dtxkku!sX z5_Yo75zNH8c4bO(aq!2sA-HI<;5T7+IP7PCLV`cJJ6ERF6c1W;180Yd5DV{ zLHg95y`y#ysQ5hce46=UC{`FAU}bU#YhrFKt^4L7vqc9FVaU6m$?u5m zhIm)Qri<2z-pQTu^)kyBrzVMKsF!fdbIB7olY#+$BDG6N*kEuLWdPAqRL#D#tEgcl zep&YX{<2URyxs$b;Jp4 zt1f#D`+(D4pMIV4=>ck;^De*{uU_6VC>;Lx(B~X$wRdFkHDH^YO+jvhXM`l!rK)qp zmDL|MiR1cV`giy5sPEL$&Xzhksm2w`h^|%7vXY_jjVyb|%DsdERg}u+r zi#gG1ilQ~(&WO;(KvqMa5#L*ZBen`Pwccu_0k>I*>kUigJ@K`GB|5GI7Ifv(tB*ps2!uKl24bw7fxdX6f+5pRpJdl1rQJduf?8N1hT1^}t(D{v%@I5IYu_=yI zdB?}({4KCAfTj0vZUB>z$B{P0aZ|LCG;fbR4cY^)w}Wn3_J6nV zGRPu?R4CdVqO^|gB#_m~A5B`bwi<-B4pDTi3r?L75isvMMG5J?nYCri_dsgDbB9FO z=GF$M9y*(2?I47@HSEUHOxmp#-0?e_C#E zGETe}(OBnAFyrW$MUmNfnFD(H10FK&)vv8eafqFD9}$BYMn^5QOyOPiE@ud5N24v@ zgU;cdG&r^_>`dj;4$V-9-(on+{H^rxakP5GXBCX({}xhbuKZrXXC>xn&dcpHBe^U5 zNzX^?byCdd{8R$a&Th+||E#{}(8mzaK-6!g0+$nUp2z%uB^!&0r&KEbI!gnEqCyC7 zgw}UAKM>J^K2-klkXS*vM%H6Ks{lsY+q{$h zlnKi_F@%{lYOCsy4_fu8mq4E6DazIfp4Ttt9R?U9=x}o;A#mjE?fUl?D^Sv9cOkcO zX0(Ti+#i4`m_{GDiDg|17Qn@Z$?%)LRaE{V_VH8c!R9JPjIU|nlrXxtzptAY^T{sH zLgfvvCvpMYvcD(9Cc0EvR6r$Ugs6#m=Ia;>qp;SMs#B!Geh??>nK=%DyB)tk zWQ9qS{uH)lB1jzzFz&*P5(cO1$(N-pytQh|9es4M^FU8rMplOft*2Lxa_n;MF)AjPxm<`SUbfnbkXB<0(Ruer zL*Z0wu4LHQB_t@nDq@b^bFMdyV6g z88@f9O~zkb*(hgoX`Cqc0r?v5m|jH<1K5v!tXQGB98bUDCz1cb|P%q>@>HaK^T(Q(;YBc~}>7K9B1FJ0_- z)1aJR!S3TRuqWj2YIVFUJ6|>T==O>M<0BW-@+%V7SYX}3XZkG*c0&Pp_XvWlc*fEq zjPw}+B}m1zn&{IT+<<nn zu~u{iwM4DwXeq_Cj1Y*>24lYT6L3`i;6O@CzQ`wkMC}_^jdmRm<`G%l>lCK`9Z@A1 zA)dcuzv#D}H%Iv0mh@$ki;#`HcdMUhj2xZTua~vuTpamRVag^$rP9BO!eaQhpB#;pAVv#dBrxcLl!Kxa6xU zG*`pB@;x}A5B1dUDp8XJjFz_0`Vy82Wt@j6#rK$>qBblJ&c_?KoC`-e zKM^?k_2azHve4B|Y5yZe@w+^jkN z`f{z(Kw7t<{BwXv*~-P&XX$^^3XKQGKWeBwP91h8f|u?p&Q><3OxUd$#tdu<#*#Qw z^qkkU4=;|^rB5By3dMi<_3E4DFc%${Z1-sRpq&@o>#NHeWFwa=m(cQc8bqJirElUe zD5X^Af{8dI9ov1|$#-T@nDh6!p{SLFt@|!^ZY>I$;dQm=&AHFI)pUSC88|ZdGIG#* zyXK1UK?ZC~^HJ_nKmu`EzZc%=nQQ(5J;jp*uzC{OT6VR->BNMs2gr8?9VI^SUpLO=HhwPw4qQ{;%LQem@ zwt-!kac)I`tB42`i4Zn9ZIb z%xEb>Q;MqH>vgqs(QItX($2d{!%Ebe3Y8Zqs`B^kB>k17!-+LdTc6$k7vF^b^Vcs; H0^q*@c-hak literal 0 HcmV?d00001 diff --git a/docs/content/assets/screenshots/process/process_kill_simple.webp b/docs/content/assets/screenshots/process/process_kill_simple.webp new file mode 100644 index 0000000000000000000000000000000000000000..c349c2ae11f33168a97d6aac8dd9cfb8175ef17a GIT binary patch literal 4698 zcmeHJXIN9qx*kNTD2hlC*i=D6RYZzP5d>6FASU!02rWbmO^Sx1^e(U!q>51~(t8I5 zsRAMpLQ&~m1f+)Ch5O#K{c-mFb$*`jnKkpyH{Uxm-@Dd&X7sOXXy~&5U~uiKE>c(C zkP!gD2R(Q?Aa@vCS5wnXKLmBbp>zz&+4Zmr0M1x9oWAB&K0_m8KDrrj2v7q$@CT5y zLbgsAAME`sHIRK~*Mm|X#%=PbM{?U8X#?}=D02Ln;p@MS3xk1t!yBi3t@2_v_S|D9r&&P!ixvk?ic=*6f5qIz8aJpE9B?1`wd(FhEeu7XDH?Z z6eDEgjD_YuWcU}hIl#UL*csyv?d_KxWXNQTMZlp}2zt1ICb$lCfG#AfHE;(G00Z2B z1k_?7k1NoJ#;^VZ|MV}uF2u5iSPlRMG1S3b;0&yO@xj46fMOu~TU%GO%=up~DyFLd z(2P+iYi9tUdjbGChCWWf`3=Y)^S4hZ4FKjx0F=G^+h_eJ z0Oi2|a1dRra8|$8p@!;1XfyynUIB2_2!NA405F>Tr5iMMFb-Y}0&oY?O1leyXGs7E z+d*@i{zKmM5aD0C{l78)s~_~`YDX{wAcb!|N`+u1l|>4LlFMuH-t6k{4zDB5aIey) zh;9ZIaWFlk?QJVtDt#&cjDP02YqtVa<>G>1GrH3UJ;&i0<8kX1HN(L%r>@a&0Xro_ zA#71JtS&k0Im+ z0TJge`_aH|nEFZFv7BJi;MR(>F<#jpEFjl8lggIr8G~YlM2}89{1H%nX`S~NNh3}O z>4x9Ub}HUwWGBW_EJ_9KE;U=Cf3uN4#}sB#eeydOwTxOz{0GsRHJ~lMKLcs0rGTqV zh2=Li-zW|1#`bxHsl`5HtsV2@)DQ0DKBun6Wq&P?p^I~dskz3V{S7OTm_<8f)-L=R zrcGUKAA)A6Wsu4D6G#xq_fyS)?;|%DX$2me`@bdnaHO7+w~i8qUvfhlfX@xpVcO2Uo93RZCC<$)10MJVWpS-IRxyR4lj*_i z6`M2hd~f#HD672xE&nkEGMY?@U89=f!?8H%=r1@EH|x|?&xK*M~cc~ zV5mv+-m_YU_83w{#JM$847H&lrHP|>kTgKpmZrm;;#$m3C2TA|s+~TJG8B-O!IrlM zv8`E8cVWGT=Z8`(;2)J_q{>9v@l0TGEO1 z)MYPMgs5NXi%|IB#v|%@?hgoSPoxC)Gx@8M;hg*p1I~kEPG|s=QhF6UQ1ewn6X8r4jr1sCd`Dn04* z(jxh*XBQabUpaCyT$fiZzi_6w25D^5{oGaK=SCMpCMKq)pDQW0M1Eb~|wH zTvQMlnwO1p74COWIT~lz>`HtaU4<*@kQ7?$bQeFJo0CD`)9vH2&sWoL9Etfr8;Z_r z)>#?5SaEjB!}Cx}KK+QRm=>#~=v30#joES9JxFkS z`MjzN5>O$nEJOwF@^)%P6+i0EgjT*BD0Y<=#qnH%o~6^+jz>aH+5K!tB#k(1jW|8% zC49q7$A0)~(h1?nlSw^U!!hup#2}bW_PT4>Brq;gZR&r1PG+BMc=xh&zekH!;Ea2a zaN02OL>qR?`ql;rLqP=4ys1DnjQH{2jo!7Q6;&;^k zx}77=z0E2tC&X`)LlvgXZ6WtnoV{m!nKcF=78fHOYv zu4C{=df1hf3c}D@*rZl=B=@wsp!t+u+slbuo9<_dW${FeOL`sb47t6`d*j(NzP3au z%Trw}pWpX*Y0e}|a-FOpe+zL9>GeM+CQMi;X()m}pu4;l(-1AAwr=25c^bsk2$*wb zdbhuGT*UOxIIPS27AB%A2ks%=o@|D5-+OK)6?T)yZmz(fHSxJcf=(%F@pyT#2T5VK zfAyuRy+fZN@{)n6x|szcj*ETdN9&)TvoRfgriPzb-is&R(kxl;KOVOg)37N2={$Wj zbEl=S=F@w(`3gyl1~LzNOLF^tBvH3twz-zQ78^Xh3VVUeo5;2Q=_KmBCTzMQe*`9C zXV2{8j%nLQ5bs<%c7Olu?JEelLVcgCjL{86{L&GEg$~^GU1nW&(e)g3t7O2#4{0SZ zQc*mrn>zb`+>anzl<&_VrNti=ywdTN8@clEqoxB942MPV)8>!2?ap|Ze03y9Rb~Hh zW=OI{D4O&qI7Qx1(EF7>Jzt>|aoh~r1!&OVF_|BG{SJd9!>?R6H!YgHU@YS$(QBua zrm=~X>eEsD?))WQqz6hp?rvCVuDHUm6fGGQ=q_ie6B!pQ)9llAP1zY+t3v3wdHm{t z#K`&uUbfIKWJS_KxQ2uQzmB4>TBCq|t``!ywRhXS;x{p7t^B!N5uS?OxIQhm?Q4l- z_R%4xfK(;HlX#a|hXAKL3o)0z_d*M2a2;;A|G0dnajDs?%ssEJa_LDHm&A%}-TfC> zR1DGKaZX#E{b$^%ri#F`hU#G{wzGJhVPa$E+Y#q?IT7tu6S)J9)^%U?TaAvj7ktQ{ zTkiVEk}kL6-BkTF+t%Z*(yM-;NGmI`0Y-+Ij%u5F?Fv2&;oIYS-&=2LJiKq<@_D0T z485D_W4V#03eL@I^qsJoj{ZCo^2|Cu(AL!L0Jb*UYzf zVyhaHDe*TINcR$lIS`uobs5LF+pR`r&>uc&U;|&i-y2Q1SLjlj>ft=^(tUA8S3+RW zz&85*CJ&_uw$HK=P5xdZ=j^!brC^$2Gf7a3x_AX_Zq4?qm}k}4j)rvrj2m_g3-5VD z*vVXb(3<%qQV^~Y*BwV;d=*}WD?E|k6{EamQ5j#%V`s$uddGgR4S!pS$Bvkdx*2N` zt5Z2~lle&hv$L8VH#_e$IS%Kr>Gd1f27mrI>RA0`VhEY`C;PPf;VvwzgYSe}`r6LI zwi>lG?qSv{c$E8UY^viTO^PGJ!us1asVaMQLWGd>dU8`@H=FwuTF|_H)7OY`zwT3S z^B*ddfF_k=-`Kf3@pNmy-B$U#1J}p3q5EqBddX~&;5Cu=jbz)FXYOgrD$+Psm@Tku zRZqm$xV~_Z7cIK=BUo%BM|XQ88W!rNj!Rvn8x-^O_S>IUezRoa4pVQcMIo+VZrBT7 z{G2$d$di~v*#9EYM{>!=o6Pd1C2gzv#8>YQ)qnNdlis{`YbS6ntz`do#f|E)kda!H zEix2AzMlZ!BfSHXviT==S$E_6h^eS5_6NQq6f;ap_|p2ZJmHrUFV-rGFYlU-4Awi< zlFNFwcAo@UCK!H>mNT(U{kWBWg7;!>$%mgGH$`8{)a=4Hi}1sFeG+Bx_tT-4D~64* z!fam2q9}f81)(c1gB&d6x0wk$Jwt`?2j6o#BE`(|%!)_f?TM5cmBaxW-c`p>+g7X1esj-X-`fZ k_kPts;J2gf|IW0aqZw<)36=@t-=O2}zvVxqfEp|KA5ZHV)Bpeg literal 0 HcmV?d00001 diff --git a/docs/content/contribution/documentation.md b/docs/content/contribution/documentation.md index b39ca709..5a1a6ad6 100644 --- a/docs/content/contribution/documentation.md +++ b/docs/content/contribution/documentation.md @@ -2,43 +2,49 @@ ## When should documentation changes be done? -- Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: `README.md`, changelog, etc.) +- Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where + appropriate (ex: `README.md`, changelog, etc.) - New methods of installation are always appreciated and should be documented ## What pages need documentation? There are a few areas where documentation changes are often needed: -- The [extended documentation](https://clementtsang.github.io/bottom/nightly/) (AKA here) - The [`README.md`](https://github.com/ClementTsang/bottom/blob/master/README.md) - The help menu inside of the application (located [here](https://github.com/ClementTsang/bottom/blob/master/src/constants.rs)) +- The [extended documentation](https://clementtsang.github.io/bottom/nightly/) (here) - The [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md) -## How should I add documentation? +## How should I add/update documentation? -1. Fork the repository first and make changes there. +1. Fork the repository to make changes in. 2. Where you're adding documentation will probably affect what you need to do: - ### `README.md` or `CHANGELOG.md` +

README.md or CHANGELOG.md

For changes to [`README.md`](https://github.com/ClementTsang/bottom/blob/master/README.md) and [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md), just follow the formatting provided and use any editor. - ### Help menu + Generally, changes to [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md) will be handled + by a maintainer, and changes should follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format, as + well as link to the relevant PR or issue. + +

Help menu

For changes to the help menu, try to refer to the existing code within `src/constants.rs` on how the help menu is generated. - ### Extended documentation +

Extended documentation

For changes to the extended documentation, you'll probably want [MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), `mdx_truly_sane_lists`, and optionally [Mike](https://github.com/jimporter/mike) installed to provide live reloading and preview for your changes. They aren't needed but it'll help with validating your changes. - You can do so through `pip` or your system's package managers. If you use `pip`, you probably would want to do something like so through a venv: + You can do so through `pip` or your system's package managers. If you use `pip`, you can use venv to install the + documentation dependencies: ```bash - # Starting from the repo root: + # Change directories to the documentation. cd docs/ - # Create venv and activate + # Create and activate venv. python -m venv venv source venv/bin/activate @@ -49,4 +55,7 @@ There are a few areas where documentation changes are often needed: venv/bin/mkdocs serve ``` -3. Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to [Issues, Pull Requests, and Discussions](../issues-and-pull-requests/). + This will serve a local version of the docs that you can open on your browser. It will update as you make changes. + +3. Once you have your documentation changes done, submit it as a pull request. For more information regarding that, + refer to [Issues, Pull Requests, and Discussions](../issues-and-pull-requests/). diff --git a/docs/content/troubleshooting.md b/docs/content/troubleshooting.md index 3015c969..c9fd5852 100644 --- a/docs/content/troubleshooting.md +++ b/docs/content/troubleshooting.md @@ -8,7 +8,7 @@ render braille fonts.
Example of a terminal with no braille font. -
Powershell shown missing braille fonts
+
An example of missing braille fonts in Powershell
One alternative is to use the `--dot_marker` option to render graph charts using dots instead of the braille characters, @@ -16,7 +16,7 @@ which generally seems better supported out of the box, at the expense of looking
Example of running bottom with the dot marker flag -
Example using btm --dot_marker
+
Example using btm --dot_marker
Another (better) alternative is to install a font that supports braille fonts, and configure your terminal to use it. For example, installing @@ -41,16 +41,16 @@ Let's say you're installing [Iosevka](https://github.com/be5invis/Iosevka). The
Regedit menu showing how to add a new font for Command Prompt/PowerShell -
The last entry is the new entry for Iosevka
+
The last entry is the new entry for Iosevka
-5. Then, open the Command Prompt/PowerShell, and right click on the top bar, and open `Properties`: +1. Then, open the Command Prompt/PowerShell, and right click on the top bar, and open "Properties":
Opening the properties menu in Command Prompt/PowerShell
-6. From here, go to `Font`, and set the font to your new font (e.g. `Iosevka`): +1. From here, go to "Font", and set the font to your new font (so in this example, Iosevka):
Setting a new font in Command Prompt/PowerShell diff --git a/docs/content/usage/widgets/process.md b/docs/content/usage/widgets/process.md index 3285a7a3..5b157019 100644 --- a/docs/content/usage/widgets/process.md +++ b/docs/content/usage/widgets/process.md @@ -50,6 +50,24 @@ is added together when displayed. Note that the process state and user columns are disabled in this mode. +### Process termination + +Pressing ++d+d++ or ++f9++ will allow you to terminate the currently selected process/process group. On Unix-like +operating systems, you are also able to control which specific signals to send (e.g. `SIGKILL`, `SIGTERM`). + +
+ A picture of the process kill menu on Linux. +
The process termination menu on Linux
+
+ +If you're on Windows, or if the `disable_advanced_kill` flag is set in the options or command-line, then a simpler termination +screen will be shown to confirm whether you want to kill that process/process group. + +
+ A picture of the process kill menu on Windows. +
The process termination menu on Windows
+
+ ### Tree mode Pressing ++t++ or ++f5++ in the table toggles tree mode in the process widget, displaying processes in regards to their parent-child process relationships.