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

docs: update doc about mkdocs, changelog, and versioning (#1561)

Browse Source 
* docs: update doc about mkdocs

* docs: more readme docs wording

* add some details about versioning
This commit is contained in:
Clement Tsang 2024-08-14 02:44:32 +00:00 committed by GitHub
parent 277a30bca5
commit 1f011bd918
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CHANGELOG.md
View File

@ -1,9 +1,24 @@
# Changelog
All notable changes to this project will be documented in this file.
All notable changes to this project will be documented in this file. The format is based on
[Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Versioning for this project is based on [Semantic Versioning](https://semver.org/spec/v2.0.0.html). More specifically:
**Pre 1.0.0 (current)**:
- Patch versions should aim to only contain bug fixes or non-breaking features/changes.
- Minor versions may break things.
**Post 1.0.0**:
- Patch versions should only contain bug fixes.
- Minor versions should only contain forward-compatible features/changes.
- Major versions may break things.
That said, these are more guidelines rather than hardset rules, though the project will generally try to follow them.
---
## [0.11.0]/[0.10.3] - Unreleased
@ -43,7 +58,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changes
- [#1276](https://github.com/ClementTsang/bottom/pull/1276): GPU functionality is now tied behind the `--enable_gpu` flag. This will likely be changed in the future.
- [#1276](https://github.com/ClementTsang/bottom/pull/1276): NVIDIA GPU functionality is now tied behind the `--enable_gpu` flag. This will likely be changed in the future.
- [#1344](https://github.com/ClementTsang/bottom/pull/1344): Change the `group` command line-argument to `group_processes` for consistency with the config file option.
- [#1376](https://github.com/ClementTsang/bottom/pull/1376): Group together related command-line arguments in `-h` and `--help`.
- [#1411](https://github.com/ClementTsang/bottom/pull/1411): Add `time` as a default column.

10
docs/README.md
View File

@ -7,7 +7,8 @@ Documentation is currently built using Python 3.11, though it should work fine w
## Running locally
One way is to just run `serve.sh`. Alternatively, the manual steps are:
One way is to just run `serve.sh`. Alternatively, the manual steps are, assuming your current working directory
is the bottom repo:
```bash
# Change directories to the documentation.
@ -26,16 +27,17 @@ venv/bin/mkdocs serve
## Deploying
Deploying is done via [mike](https://github.com/jimporter/mike).
Deploying is done via [mike](https://github.com/jimporter/mike) in order to get versioning. Typically,
this is done through CI, but can be done manually if needed.
### Nightly
### Nightly docs
```bash
cd docs
mike deploy nightly --push
```
### Stable
### Stable docs
```bash
cd docs