mirror of
https://github.com/ClementTsang/bottom.git
synced 2026-05-04 05:50:42 +00:00
docs: migrate documentation over to mkdocs (#506)
A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
This commit is contained in:
Clement Tsang
@@ -6,60 +6,40 @@ labels: "bug"
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/troubleshooting) to see if there's already an answer to your problem.
|
||||
|
||||
Also, **please fill in all fields if possible** - if the issue is too hard to reproduce or vague, it may not be fixed!
|
||||
|
||||
## Describe the bug
|
||||
|
||||
_A clear and concise description of what the bug is and what the expected behaviour was. If applicable, add screenshots to help explain your problem:_
|
||||
Give a high level description of the bug.
|
||||
|
||||
## How to reproduce
|
||||
## What operating system/architecture are you using?
|
||||
|
||||
_Steps on how to reproduce the behaviour. Please try to include this section so I can reproduce your problem in order to fix it. If you are using any runtime flags (i.e. `btm --group`) please mention them as part of this.:_
|
||||
Please mention what operating system, version, and architecture you're experiencing the problem on (ex: macOS 10.13, x86_64). Please also ensure that your system is [on the list of supported systems](https://github.com/ClementTsang/bottom#support) - bug reports on unsupported systems are likely to be closed.
|
||||
|
||||
## bottom version
|
||||
## What terminal are you using `bottom` on?
|
||||
|
||||
_Use `btm -V` and report the version of bottom you have installed. Also, if you're not on the latest version, please [try that](https://github.com/ClementTsang/bottom/releases/latest) and see if the problem is already resolved._
|
||||
Please mention what terminal/terminal emulator you are using `bottom` on (ex: Konsole, Kitty).
|
||||
|
||||
## bottom config file (if used)
|
||||
## What version are you on?
|
||||
|
||||
_If you're using a config file, please include it in the report._
|
||||
Please ensure that the bug still exists on the [latest stable release](https://github.com/ClementTsang/bottom/releases/latest) or newer (i.e. nightly). If so, mention
|
||||
what version you are using here.
|
||||
|
||||
## Installation method
|
||||
## How did you install `bottom`?
|
||||
|
||||
_How did you install bottom? Note if it's not a supported method, I may not be able to help you._
|
||||
Please mention how you installed `bottom`. If you manually compiled it, please also mention your _Rust version_.
|
||||
|
||||
## Platform and environment information
|
||||
## How can we reproduce this?
|
||||
|
||||
### Operating system, OS version, and architecture
|
||||
Provide detailed steps on _how_ to reproduce your problem, to the best of your ability. Be as detailed as possible, and include config files or flags if relevant.
|
||||
If maintainers cannot reproduce the bug, it will be very hard to fix it.
|
||||
|
||||
_Please specify your operating system, the version, and architecture, so I can try to replicate your environment as best as possible. Note that the officially supported platforms are:_
|
||||
## What is the actual behaviour?
|
||||
|
||||
- _macOS (`x86_64`)_
|
||||
- _Linux (`x86_64`, `i686`, `aarch64`)_
|
||||
- _Windows (`x86_64`, `i686`)_
|
||||
What is the _actual_ result of the given steps? Be detailed. Please include screenshots if the issue is a visual one.
|
||||
|
||||
_If your platform is not listed, please be aware I do not officially support it and may be unable to fix this issue._
|
||||
## What is the expected behaviour?
|
||||
|
||||
### Terminal (i.e. urxvt, kitty, etc.)
|
||||
|
||||
_Sometimes this matters, so please mention your terminal/terminal emulator._
|
||||
|
||||
### Shell (i.e. zsh, bash, etc.)
|
||||
|
||||
_Again, sometimes this matters, so please mention your shell type if possible._
|
||||
|
||||
### Miscellaneous system info
|
||||
|
||||
_Not totally necessary, but if possible, include details like:_
|
||||
|
||||
_RAM size:_
|
||||
|
||||
_SWAP size:_
|
||||
|
||||
_CPU and number of cores:_
|
||||
|
||||
### Rust version
|
||||
|
||||
_Check this with `rustc --version`. This is only relevant if your version of bottom isn't from a pre-built binary (i.e. Cargo). Otherwise, feel free to skip._
|
||||
|
||||
## Additional context
|
||||
|
||||
_If anything hasn't been covered by the above categories, feel free to include it here:_
|
||||
What do you believe the expected behaviour should be given these steps?
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Got a good idea that hasn't already been mentioned? Suggest it!
|
||||
about: Got a good idea that hasn't already been suggested? Mention it here!
|
||||
title: ""
|
||||
labels: "feature"
|
||||
assignees: ""
|
||||
@@ -8,8 +8,5 @@ assignees: ""
|
||||
|
||||
### Describe the feature request
|
||||
|
||||
_What is the feature of interest? Be clear and concise._
|
||||
|
||||
### Additional context/details
|
||||
|
||||
_Provide any additional context or details here. What needs to be done, why, etc:_
|
||||
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.
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
name: Packaging
|
||||
about: For any issues, questions, or requests regarding packaging or distribution.
|
||||
title: ""
|
||||
labels: "packaging"
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
## Details
|
||||
|
||||
What is the issue? Please be clear and concise.
|
||||
|
||||
Note: 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/contribution/packaging-and-distribution/) for more information.
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
name: Packaging
|
||||
about: For any issues, questions, or requests regarding packaging or distribution.
|
||||
title: ""
|
||||
labels: "packaging"
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
## Details
|
||||
|
||||
_What is the issue? Please be clear and concise._
|
||||
|
||||
_Note: if this issue is about supporting a new package manager, please do consider maintaining it yourself and sending in a PR, and I'll be glad accept it! While I definitely want to support more ways of distribution, it gets quite challenging to support package managers for operating systems you don't even have installed..._
|
||||
@@ -8,4 +8,4 @@ assignees: ""
|
||||
|
||||
### Question
|
||||
|
||||
_What do you want to ask in regards to this project? Note that if this is a feature request or a bug/issue report, please use the appropriate templates instead._
|
||||
What do you want to ask in regards to this project? Note that this is **not** the template to use if you have a bug report or feature request - use the appropriate templates instead.
|
||||
@@ -24,6 +24,6 @@ _If relevant, ensure the following have been met:_
|
||||
|
||||
- [ ] _Areas your change affects have been linted using rustfmt (`cargo fmt`)_
|
||||
- [ ] _The change has been tested and doesn't appear to cause any unintended breakage_
|
||||
- [ ] _Documentation has been added/updated if needed (README, help menu, etc.)_
|
||||
- [ ] _Documentation has been added/updated if needed (`README.md`, help menu, etc.)_
|
||||
- [ ] _The pull request passes the provided CI pipeline_
|
||||
- [ ] _There are no merge conflicts_
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
name: docs
|
||||
on:
|
||||
workflow_dispatch:
|
||||
# inputs:
|
||||
# version:
|
||||
# description: "The documentation version to update. Defaults to nightly."
|
||||
# default: "nightly"
|
||||
# required: false
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
paths:
|
||||
- 'docs/**'
|
||||
- '.github/workflows/docs.yml'
|
||||
jobs:
|
||||
build-documentation:
|
||||
name: Build and deploy docs
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: 3.x
|
||||
- run: pip install mkdocs-material
|
||||
- run: pip install mdx_truly_sane_lists
|
||||
- run: cd docs/
|
||||
- run: mkdocs gh-deploy --force
|
||||
@@ -11,6 +11,7 @@ on:
|
||||
isMock:
|
||||
description: "Mock nightly run, fill in with anything to trigger a mock build."
|
||||
default: ""
|
||||
required: false
|
||||
|
||||
jobs:
|
||||
create-github-release:
|
||||
|
||||
Reference in New Issue
Block a user