docs: mention discussions, fix broken link, update mkdocs req (#698)

Fixes a broken link, and mention when to use discussions over issues. Also updates mkdocs in the build process due to some broken dependencies.
This commit is contained in:
Clement Tsang 2022-03-27 21:57:55 -04:00 committed by GitHub
parent 6fa04de2b7
commit 747497cc8a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 4 deletions

View file

@ -28,4 +28,4 @@ There are a few areas where documentation changes are often needed:
You may also want [Mike](https://github.com/jimporter/mike), but it isn't really needed.
3. Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to [Issues and Pull Requests](http://127.0.0.1:8000/contribution/issues-and-pull-requests/).
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/).

View file

@ -1,7 +1,14 @@
# Issues and Pull Requests
# Issues, Pull Requests, and Discussions
Contribution in any way is appreciated, whether it is reporting problems, fixing bugs, implementing features, improving the documentation, etc.
## Discussions
Discussions are open [in the repo](https://github.com/ClementTsang/bottom/discussions). As for the difference between discussions and issues:
- Open an issue if what you have enough information to properly fill out any details needed for a report or request.
- Open a discussion otherwise (e.g. asking a question).
## Opening an issue
### Bug reports

View file

@ -141,7 +141,7 @@ nav:
- "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
- "Issues, Pull Requests, and Discussions": contribution/issues-and-pull-requests.md
- "Documentation": contribution/documentation.md
- "Development": contribution/development.md
- "Packaging and Distribution": contribution/packaging-and-distribution.md

View file

@ -1,4 +1,5 @@
mkdocs-material == 8.1.3
mkdocs == 1.3.0
mkdocs-material == 8.2.8
mkdocs-material-extensions == 1.0.3
mdx_truly_sane_lists == 1.2
mike == 1.1.2