ClementTsang/bottom
1
1
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2024-11-09 12:58:21 +03:00
Code Issues Projects Releases Wiki Activity

Deployed a94a8059 to nightly with MkDocs 1.4.1 and mike 1.1.2

Browse Source
This commit is contained in:
github-actions[bot] 2023-02-03 08:05:46 +00:00
parent ff116f270b
commit 80a4fe761a
8 changed files with 78 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
nightly/assets/screenshots/process/process_kill_linux.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.0 KiB

BIN
nightly/assets/screenshots/process/process_kill_simple.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.6 KiB

36
nightly/contribution/documentation/index.html
View File

@ -863,8 +863,8 @@
</li>
<li class="md-nav__item">
<a href="#how-should-i-add-documentation" class="md-nav__link">
How should I add documentation?
<a href="#how-should-i-addupdate-documentation" class="md-nav__link">
How should I add/update documentation?
</a>
</li>
@ -1044,35 +1044,43 @@
<h1 id="documentation"><a class="toclink" href="#documentation">Documentation</a></h1>
<h2 id="when-should-documentation-changes-be-done"><a class="toclink" href="#when-should-documentation-changes-be-done">When should documentation changes be done?</a></h2>
<ul>
<li>Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: <code>README.md</code>, changelog, etc.)</li>
<li>Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where
appropriate (ex: <code>README.md</code>, changelog, etc.)</li>
<li>New methods of installation are always appreciated and should be documented</li>
</ul>
<h2 id="what-pages-need-documentation"><a class="toclink" href="#what-pages-need-documentation">What pages need documentation?</a></h2>
<p>There are a few areas where documentation changes are often needed:</p>
<ul>
<li>The <a href="https://clementtsang.github.io/bottom/nightly/">extended documentation</a> (AKA here)</li>
<li>The <a href="https://github.com/ClementTsang/bottom/blob/master/README.md"><code>README.md</code></a></li>
<li>The help menu inside of the application (located <a href="https://github.com/ClementTsang/bottom/blob/master/src/constants.rs">here</a>)</li>
<li>The <a href="https://clementtsang.github.io/bottom/nightly/">extended documentation</a> (here)</li>
<li>The <a href="https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md"><code>CHANGELOG.md</code></a></li>
</ul>
<h2 id="how-should-i-add-documentation"><a class="toclink" href="#how-should-i-add-documentation">How should I add documentation?</a></h2>
<h2 id="how-should-i-addupdate-documentation"><a class="toclink" href="#how-should-i-addupdate-documentation">How should I add/update documentation?</a></h2>
<ol>
<li>
<p>Fork the repository first and make changes there.</p>
<p>Fork the repository to make changes in.</p>
</li>
<li>
<p>Where you're adding documentation will probably affect what you need to do:</p>
<p>### <code>README.md</code> or <code>CHANGELOG.md</code></p>
<h3><code>README.md</code> or <code>CHANGELOG.md</code></h3>
<p>For changes to <a href="https://github.com/ClementTsang/bottom/blob/master/README.md"><code>README.md</code></a> and <a href="https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md"><code>CHANGELOG.md</code></a>, just follow the formatting provided and use any editor.</p>
<p>### Help menu</p>
<p>Generally, changes to <a href="https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md"><code>CHANGELOG.md</code></a> will be handled
by a maintainer, and changes should follow the <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a> format, as
well as link to the relevant PR or issue.</p>
<h3>Help menu</h3>
<p>For changes to the help menu, try to refer to the existing code within <code>src/constants.rs</code> on how the help menu is generated.</p>
<p>### Extended documentation</p>
<h3>Extended documentation</h3>
<p>For changes to the extended documentation, you'll probably want <a href="https://www.mkdocs.org/">MkDocs</a>, <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>, <code>mdx_truly_sane_lists</code>, and optionally <a href="https://github.com/jimporter/mike">Mike</a> installed to provide live reloading and preview for your changes. They aren't needed but it'll help with validating your changes.</p>
<p>You can do so through <code>pip</code> or your system's package managers. If you use <code>pip</code>, you probably would want to do something like so through a venv:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Starting from the repo root:</span>
<p>You can do so through <code>pip</code> or your system's package managers. If you use <code>pip</code>, you can use venv to install the
documentation dependencies:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Change directories to the documentation.</span>
<span class="nb">cd</span><span class="w"> </span>docs/
<span class="c1"># Create venv and activate</span>
<span class="c1"># Create and activate venv.</span>
python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>venv
<span class="nb">source</span><span class="w"> </span>venv/bin/activate
@ -1082,9 +1090,11 @@ pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </s
<span class="c1"># Run mkdocs</span>
venv/bin/mkdocs<span class="w"> </span>serve
</code></pre></div>
<p>This will serve a local version of the docs that you can open on your browser. It will update as you make changes.</p>
</li>
<li>
<p>Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to <a href="../issues-and-pull-requests/">Issues, Pull Requests, and Discussions</a>.</p>
<p>Once you have your documentation changes done, submit it as a pull request. For more information regarding that,
refer to <a href="../issues-and-pull-requests/">Issues, Pull Requests, and Discussions</a>.</p>
</li>
</ol>

2
nightly/search/search_index.json
View File

File diff suppressed because one or more lines are too long

54
nightly/sitemap.xml
View File

@ -2,137 +2,137 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://clementtsang.github.io/bottom/nightly/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/troubleshooting/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/data-filtering/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/flags/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/layout/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/theming/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/documentation/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/build_process/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/deploy_process/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/dev_env/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/logging/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/testing/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/support/official/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/support/unofficial/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/basic-mode/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/general-usage/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/network/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/process/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/</loc>
<lastmod>2023-01-27</lastmod>
<lastmod>2023-02-03</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
nightly/sitemap.xml.gz
View File

Binary file not shown.

10
nightly/troubleshooting/index.html
View File

@ -1114,14 +1114,14 @@ example of this is seeing a bunch of missing font characters, caused when the te
render braille fonts.</p>
<figure>
<img src="../assets/screenshots/troubleshooting/no_braille.webp" alt="Example of a terminal with no braille font."/>
<figcaption>Powershell shown missing braille fonts</figcaption>
<figcaption><sub>An example of missing braille fonts in Powershell</sub></figcaption>
</figure>
<p>One alternative is to use the <code>--dot_marker</code> option to render graph charts using dots instead of the braille characters,
which generally seems better supported out of the box, at the expense of looking less intricate:</p>
<figure>
<img src="../assets/screenshots/troubleshooting/dots.webp" alt="Example of running bottom with the dot marker flag"/>
<figcaption>Example using <code>btm --dot_marker</code></figcaption>
<figcaption><sub>Example using <code>btm --dot_marker</code></sub></figcaption>
</figure>
<p>Another (better) alternative is to install a font that supports braille fonts, and configure your terminal to use it. For example, installing
@ -1144,18 +1144,18 @@ and ensuring your terminal uses it should work.</p>
</ol>
<figure>
<img src="../assets/screenshots/troubleshooting/regedit_fonts.webp" alt="Regedit menu showing how to add a new font for Command Prompt/PowerShell"/>
<figcaption>The last entry is the new entry for Iosevka</code></figcaption>
<figcaption><sub>The last entry is the new entry for Iosevka</sub></figcaption>
</figure>
<ol>
<li>Then, open the Command Prompt/PowerShell, and right click on the top bar, and open <code>Properties</code>:</li>
<li>Then, open the Command Prompt/PowerShell, and right click on the top bar, and open "Properties":</li>
</ol>
<figure>
<img src="../assets/screenshots/troubleshooting/cmd_prompt_props.webp" alt="Opening the properties menu in Command Prompt/PowerShell"/>
</figure>
<ol>
<li>From here, go to <code>Font</code>, and set the font to your new font (e.g. <code>Iosevka</code>):</li>
<li>From here, go to "Font", and set the font to your new font (so in this example, Iosevka):</li>
</ol>
<figure>
<img src="../assets/screenshots/troubleshooting/cmd_prompt_font.webp" alt="Setting a new font in Command Prompt/PowerShell"/>

22
nightly/usage/widgets/process/index.html
View File

@ -606,6 +606,13 @@
Grouping
</a>
</li>
<li class="md-nav__item">
<a href="#process-termination" class="md-nav__link">
Process termination
</a>
</li>
<li class="md-nav__item">
@ -1208,6 +1215,21 @@ is added together when displayed.</p>
</figure>
<p>Note that the process state and user columns are disabled in this mode.</p>
<h3 id="process-termination"><a class="toclink" href="#process-termination">Process termination</a></h3>
<p>Pressing <span class="keys"><kbd class="key-d">d</kbd><span>+</span><kbd class="key-d">d</kbd></span> or <span class="keys"><kbd class="key-f9">F9</kbd></span> 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. <code>SIGKILL</code>, <code>SIGTERM</code>).</p>
<figure>
<img src="../../../assets/screenshots/process/process_kill_linux.webp" alt="A picture of the process kill menu on Linux."/>
<figcaption><sub>The process termination menu on Linux</sub></figcaption>
</figure>
<p>If you're on Windows, or if the <code>disable_advanced_kill</code> 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.</p>
<figure>
<img src="../../../assets/screenshots/process/process_kill_simple.webp" alt="A picture of the process kill menu on Windows."/>
<figcaption><sub>The process termination menu on Windows</sub></figcaption>
</figure>
<h3 id="tree-mode"><a class="toclink" href="#tree-mode">Tree mode</a></h3>
<p>Pressing <span class="keys"><kbd class="key-t">t</kbd></span> or <span class="keys"><kbd class="key-f5">F5</kbd></span> in the table toggles tree mode in the process widget, displaying processes in regards to their parent-child process relationships.</p>
<figure>