lee/bottom
1
0
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2026-08-26 21:36:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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
4 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/contribution/documentation.md
+1 -1
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. 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/).
docs/content/contribution/issues-and-pull-requests.md
+8 -1
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. 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 ## Opening an issue
### Bug reports ### Bug reports
docs/mkdocs.yml
+1 -1
View File
@@ -141,7 +141,7 @@ nav:
- "Layout": configuration/config-file/layout.md - "Layout": configuration/config-file/layout.md
- "Data Filtering": configuration/config-file/data-filtering.md - "Data Filtering": configuration/config-file/data-filtering.md
- "Contribution": - "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 - "Documentation": contribution/documentation.md
- "Development": contribution/development.md - "Development": contribution/development.md
- "Packaging and Distribution": contribution/packaging-and-distribution.md - "Packaging and Distribution": contribution/packaging-and-distribution.md
docs/requirements.txt
+2 -1
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 mkdocs-material-extensions == 1.0.3
mdx_truly_sane_lists == 1.2 mdx_truly_sane_lists == 1.2
mike == 1.1.2 mike == 1.1.2