mirror of
https://github.com/ClementTsang/bottom
synced 2025-02-16 13:18:28 +00:00
docs: try switching over to Cloudflare Pages (#632)
I would prefer for the project to not be under clementtsang.github.io/bottom, so let's try out CFP.
This commit is contained in:
Clement Tsang
GitHub
parent
feb6d9db2f
commit
8e5742d636
8 changed files with 101 additions and 97 deletions
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -6,7 +6,7 @@ labels: "bug"
|
|||
assignees: ""
|
||||
---
|
||||
|
||||
Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://clementtsang.github.io/bottom/nightly/support/#known-problems) to see if your problem is already reported/known/fixed.
|
||||
Before you report, please take a look at [Troubleshooting](https://bottom.pages.dev/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://bottom.pages.dev/nightly/support/#known-problems) to see if your problem is already reported/known/fixed.
|
||||
|
||||
Also, **please fill in all fields if possible** - if the issue is too hard to reproduce or vague, it may not be fixed!
|
||||
|
||||
|
|
|
|||
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -11,4 +11,4 @@ assignees: ""
|
|||
Please describe what behaviour you are looking for, the motivation for it, and use cases for where this feature would be helpful.
|
||||
Try to be clear and concise - more details are usually helpful, but don't ramble on too much.
|
||||
|
||||
Also try to see if this feature already exists first [in the documentation](https://clementtsang.github.io/bottom/nightly/).
|
||||
Also try to see if this feature already exists first [in the documentation](https://bottom.pages.dev/nightly/).
|
||||
|
|
|
|||
6
.github/ISSUE_TEMPLATE/packaging.md
vendored
6
.github/ISSUE_TEMPLATE/packaging.md
vendored
|
|
@ -13,8 +13,8 @@ What is the issue? Please be clear and concise.
|
|||
Some notes:
|
||||
|
||||
- If the issue is specifically about an existing package/distribution, consider contacting the package maintainer
|
||||
instead in the appropriate location.
|
||||
instead in the appropriate location.
|
||||
|
||||
- If this issue is about supporting a new package manager/installation method,
|
||||
please do consider maintaining it yourself and sending in a PR, and I'll be glad accept it!
|
||||
See [the documentation](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/) for more information.
|
||||
please do consider maintaining it yourself and sending in a PR, and I'll be glad accept it!
|
||||
See [the documentation](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/) for more information.
|
||||
|
|
|
|||
|
|
@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
## [0.6.5] - 2021-12-19
|
||||
|
||||
## Internal Changes
|
||||
|
||||
- [#632](https://github.com/ClementTsang/bottom/pull/632): Migrate documentation hosting to Cloudflare Pages.
|
||||
|
||||
## Bug Fixes
|
||||
|
||||
- [#627](https://github.com/ClementTsang/bottom/pull/627): Fixes `process_command` breaking process widget sorting.
|
||||
|
|
|
|||
|
|
@ -24,13 +24,13 @@ If you want to directly contribute documentation changes or code, follow this! T
|
|||
4. Wait for the tests to pass. These consist of clippy lints, rustfmt checks, and basic tests. **If you are a first time contributor, skip to the next step for now, as GitHub Actions requires approval to run.**
|
||||
5. Ask a maintainer to review your pull request. If changes are suggested or any comments are made, they should probably be addressed. Once it looks good, it'll be merged!
|
||||
|
||||
For more details, see [here](https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/).
|
||||
For more details, see [here](https://bottom.pages.dev/nightly/contribution/issues-and-pull-requests/).
|
||||
|
||||
### Documentation
|
||||
|
||||
For contributing to documentation, see [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/).
|
||||
For contributing to documentation, see [here](https://bottom.pages.dev/nightly/contribution/documentation/).
|
||||
|
||||
### Packaging
|
||||
|
||||
If you want to become a package maintainer, look [here](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/)
|
||||
If you want to become a package maintainer, look [here](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/)
|
||||
for instructions on how to build bottom and add installation instructions to the README.
|
||||
|
|
|
|||
34
README.md
34
README.md
|
|
@ -3,8 +3,8 @@
|
|||
[<img src="https://img.shields.io/github/workflow/status/ClementTsang/bottom/ci/master?style=flat-square&logo=github" alt="CI status">](https://github.com/ClementTsang/bottom/actions?query=branch%3Amaster)
|
||||
[<img src="https://img.shields.io/codecov/c/github/ClementTsang/bottom?color=%23d9634d&logo=codecov&style=flat-square&token=IDD43CO0FP" alt="Codecov">](https://app.codecov.io/gh/ClementTsang/bottom)
|
||||
[<img src="https://img.shields.io/crates/v/bottom.svg?style=flat-square" alt="crates.io link">](https://crates.io/crates/bottom)
|
||||
[<img src="https://img.shields.io/badge/docs-nightly-88c0d0?style=flat-square&labelColor=555555&logoColor=white" alt="Nightly documentation">](https://clementtsang.github.io/bottom/nightly)
|
||||
[<img src="https://img.shields.io/badge/docs-stable-66c2a5?style=flat-square&labelColor=555555&logoColor=white" alt="Stable documentation">](https://clementtsang.github.io/bottom/stable)
|
||||
[<img src="https://img.shields.io/badge/docs-nightly-88c0d0?style=flat-square&labelColor=555555&logoColor=white" alt="Nightly documentation">](https://bottom.pages.dev/nightly)
|
||||
[<img src="https://img.shields.io/badge/docs-stable-66c2a5?style=flat-square&labelColor=555555&logoColor=white" alt="Stable documentation">](https://bottom.pages.dev/stable)
|
||||
|
||||
A cross-platform graphical process/system monitor with a customizable interface and a multitude of features. Supports Linux, macOS, and Windows. Inspired by [gtop](https://github.com/aksakalli/gtop), [gotop](https://github.com/xxxserxxx/gotop), and [htop](https://github.com/htop-dev/htop/).
|
||||
|
||||
|
|
@ -23,26 +23,26 @@ As (yet another) process/system visualization and management application, bottom
|
|||
|
||||
- Graphical visualization widgets for:
|
||||
|
||||
- [CPU usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/) over time, at an average and per-core level
|
||||
- [RAM and swap usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/) over time
|
||||
- [Network I/O usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/network/) over time
|
||||
- [CPU usage](https://bottom.pages.dev/nightly/usage/widgets/cpu/) over time, at an average and per-core level
|
||||
- [RAM and swap usage](https://bottom.pages.dev/nightly/usage/widgets/memory/) over time
|
||||
- [Network I/O usage](https://bottom.pages.dev/nightly/usage/widgets/network/) over time
|
||||
|
||||
with support for zooming in/out the current time interval displayed.
|
||||
|
||||
- Widgets for displaying info about:
|
||||
|
||||
- [Disk capacity/usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/)
|
||||
- [Temperature sensors](https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/)
|
||||
- [Battery usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/)
|
||||
- [Disk capacity/usage](https://bottom.pages.dev/nightly/usage/widgets/disk/)
|
||||
- [Temperature sensors](https://bottom.pages.dev/nightly/usage/widgets/temperature/)
|
||||
- [Battery usage](https://bottom.pages.dev/nightly/usage/widgets/battery/)
|
||||
|
||||
- [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:
|
||||
- [A process widget](https://bottom.pages.dev/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for:
|
||||
|
||||
- Kill signals
|
||||
- Tree mode
|
||||
|
||||
- Cross-platform support for Linux, macOS, and Windows, with more planned in the future.
|
||||
|
||||
- [Customizable behaviour](https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/) that can be controlled with command-line flags or a config file, such as:
|
||||
- [Customizable behaviour](https://bottom.pages.dev/nightly/configuration/command-line-flags/) that can be controlled with command-line flags or a config file, such as:
|
||||
|
||||
- Custom and pre-built colour themes
|
||||
- Changing the default behaviour of some widgets
|
||||
|
|
@ -51,12 +51,12 @@ As (yet another) process/system visualization and management application, bottom
|
|||
|
||||
- Some other nice stuff, like:
|
||||
|
||||
- [An htop-inspired basic mode](https://clementtsang.github.io/bottom/nightly/usage/basic-mode/)
|
||||
- [Expansion, which focuses on just one widget](https://clementtsang.github.io/bottom/nightly/usage/general-usage/#expansion)
|
||||
- [An htop-inspired basic mode](https://bottom.pages.dev/nightly/usage/basic-mode/)
|
||||
- [Expansion, which focuses on just one widget](https://bottom.pages.dev/nightly/usage/general-usage/#expansion)
|
||||
|
||||
- And more!
|
||||
|
||||
You can find more details in [the documentation](https://clementtsang.github.io/bottom/nightly/usage/general-usage/).
|
||||
You can find more details in [the documentation](https://bottom.pages.dev/nightly/usage/general-usage/).
|
||||
|
||||
## Support
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ bottom _officially_ supports the following operating systems and corresponding a
|
|||
These platforms are tested to work for the most part and issues on these platforms will be fixed if possible.
|
||||
Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust.
|
||||
|
||||
For more details on known problems and unsupported platforms, feel free to check out [the documentation page on support](https://clementtsang.github.io/bottom/nightly/support).
|
||||
For more details on known problems and unsupported platforms, feel free to check out [the documentation page on support](https://bottom.pages.dev/nightly/support).
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -232,16 +232,16 @@ The release binaries are packaged with shell auto-completion files for bash, fis
|
|||
You can run bottom using `btm`.
|
||||
|
||||
- For help on flags, use `btm -h` for a quick overview or `btm --help` for more details.
|
||||
- For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation](https://clementtsang.github.io/bottom/nightly/).
|
||||
- For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation](https://bottom.pages.dev/nightly/).
|
||||
|
||||
You can find more information on usage in the [documentation](https://clementtsang.github.io/bottom/nightly/).
|
||||
You can find more information on usage in the [documentation](https://bottom.pages.dev/nightly/).
|
||||
|
||||
## Configuration
|
||||
|
||||
bottom accepts a number of command-line arguments to change the behaviour of the application as desired. Additionally, bottom will automatically
|
||||
generate a configuration file on the first launch, which one can change as appropriate.
|
||||
|
||||
More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/).
|
||||
More details on configuration can be found [in the documentation](https://bottom.pages.dev/nightly/configuration/config-file/default-config/).
|
||||
|
||||
## Contribution
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
There are a few areas where documentation changes are often needed:
|
||||
|
||||
- The [extended documentation](https://clementtsang.github.io/bottom/nightly/) (AKA here)
|
||||
- The [extended documentation](https://bottom.pages.dev/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 [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md)
|
||||
|
|
|
|||
142
docs/mkdocs.yml
142
docs/mkdocs.yml
|
|
@ -1,7 +1,7 @@
|
|||
# Site information
|
||||
site_name: bottom
|
||||
site_author: Clement Tsang
|
||||
site_url: https://clementtsang.github.io/bottom
|
||||
site_url: https://bottom.pages.dev
|
||||
site_description: >-
|
||||
Yet another cross-platform graphical process/system monitor, inspired by gtop, gotop, and htop.
|
||||
docs_dir: "content/"
|
||||
|
|
@ -44,60 +44,61 @@ markdown_extensions:
|
|||
- pymdownx.inlinehilite
|
||||
- pymdownx.keys:
|
||||
# Override to make it case-sensitive
|
||||
key_map: {
|
||||
"a": "a",
|
||||
"b": "b",
|
||||
"c": "c",
|
||||
"d": "d",
|
||||
"e": "e",
|
||||
"f": "f",
|
||||
"g": "g",
|
||||
"h": "h",
|
||||
"i": "i",
|
||||
"j": "j",
|
||||
"k": "k",
|
||||
"l": "l",
|
||||
"m": "m",
|
||||
"n": "n",
|
||||
"o": "o",
|
||||
"p": "p",
|
||||
"q": "q",
|
||||
"r": "r",
|
||||
"s": "s",
|
||||
"t": "t",
|
||||
"u": "u",
|
||||
"v": "v",
|
||||
"w": "w",
|
||||
"x": "x",
|
||||
"y": "y",
|
||||
"z": "z",
|
||||
"A": "A",
|
||||
"B": "B",
|
||||
"C": "C",
|
||||
"D": "D",
|
||||
"E": "E",
|
||||
"F": "F",
|
||||
"G": "G",
|
||||
"H": "H",
|
||||
"I": "I",
|
||||
"J": "J",
|
||||
"K": "K",
|
||||
"L": "L",
|
||||
"M": "M",
|
||||
"N": "N",
|
||||
"O": "O",
|
||||
"P": "P",
|
||||
"Q": "Q",
|
||||
"R": "R",
|
||||
"S": "S",
|
||||
"T": "T",
|
||||
"U": "U",
|
||||
"V": "V",
|
||||
"W": "W",
|
||||
"X": "X",
|
||||
"Y": "Y",
|
||||
"Z": "Z"
|
||||
}
|
||||
key_map:
|
||||
{
|
||||
"a": "a",
|
||||
"b": "b",
|
||||
"c": "c",
|
||||
"d": "d",
|
||||
"e": "e",
|
||||
"f": "f",
|
||||
"g": "g",
|
||||
"h": "h",
|
||||
"i": "i",
|
||||
"j": "j",
|
||||
"k": "k",
|
||||
"l": "l",
|
||||
"m": "m",
|
||||
"n": "n",
|
||||
"o": "o",
|
||||
"p": "p",
|
||||
"q": "q",
|
||||
"r": "r",
|
||||
"s": "s",
|
||||
"t": "t",
|
||||
"u": "u",
|
||||
"v": "v",
|
||||
"w": "w",
|
||||
"x": "x",
|
||||
"y": "y",
|
||||
"z": "z",
|
||||
"A": "A",
|
||||
"B": "B",
|
||||
"C": "C",
|
||||
"D": "D",
|
||||
"E": "E",
|
||||
"F": "F",
|
||||
"G": "G",
|
||||
"H": "H",
|
||||
"I": "I",
|
||||
"J": "J",
|
||||
"K": "K",
|
||||
"L": "L",
|
||||
"M": "M",
|
||||
"N": "N",
|
||||
"O": "O",
|
||||
"P": "P",
|
||||
"Q": "Q",
|
||||
"R": "R",
|
||||
"S": "S",
|
||||
"T": "T",
|
||||
"U": "U",
|
||||
"V": "V",
|
||||
"W": "W",
|
||||
"X": "X",
|
||||
"Y": "Y",
|
||||
"Z": "Z",
|
||||
}
|
||||
- pymdownx.details
|
||||
- pymdownx.highlight
|
||||
- pymdownx.superfences
|
||||
|
|
@ -113,30 +114,29 @@ extra:
|
|||
provider: google
|
||||
property: G-L04GTMT28R
|
||||
|
||||
|
||||
# Navigation
|
||||
nav:
|
||||
- "Home": index.md
|
||||
- "Support": support.md
|
||||
- "Usage":
|
||||
- "General Usage": usage/general-usage.md
|
||||
- "Widgets":
|
||||
- "CPU Widget": usage/widgets/cpu.md
|
||||
- "Memory Widget": usage/widgets/memory.md
|
||||
- "Network Widget": usage/widgets/network.md
|
||||
- "Process Widget": usage/widgets/process.md
|
||||
- "Disk Widget": usage/widgets/disk.md
|
||||
- "Temperature Widget": usage/widgets/temperature.md
|
||||
- "Battery Widget": usage/widgets/battery.md
|
||||
- "Basic Mode": usage/basic-mode.md
|
||||
- "General Usage": usage/general-usage.md
|
||||
- "Widgets":
|
||||
- "CPU Widget": usage/widgets/cpu.md
|
||||
- "Memory Widget": usage/widgets/memory.md
|
||||
- "Network Widget": usage/widgets/network.md
|
||||
- "Process Widget": usage/widgets/process.md
|
||||
- "Disk Widget": usage/widgets/disk.md
|
||||
- "Temperature Widget": usage/widgets/temperature.md
|
||||
- "Battery Widget": usage/widgets/battery.md
|
||||
- "Basic Mode": usage/basic-mode.md
|
||||
- "Configuration":
|
||||
- "Command-line Flags": configuration/command-line-flags.md
|
||||
- "Config File":
|
||||
- "Default Config": configuration/config-file/default-config.md
|
||||
- "Flags": configuration/config-file/flags.md
|
||||
- "Theming": configuration/config-file/theming.md
|
||||
- "Layout": configuration/config-file/layout.md
|
||||
- "Data Filtering": configuration/config-file/data-filtering.md
|
||||
- "Default Config": configuration/config-file/default-config.md
|
||||
- "Flags": configuration/config-file/flags.md
|
||||
- "Theming": configuration/config-file/theming.md
|
||||
- "Layout": configuration/config-file/layout.md
|
||||
- "Data Filtering": configuration/config-file/data-filtering.md
|
||||
- "Contribution":
|
||||
- "Issues and Pull Requests": contribution/issues-and-pull-requests.md
|
||||
- "Documentation": contribution/documentation.md
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue