diff options
| -rw-r--r-- | docs/content/contribution/documentation.md | 2 | ||||
| -rw-r--r-- | docs/content/contribution/issues-and-pull-requests.md | 9 | ||||
| -rw-r--r-- | docs/mkdocs.yml | 2 | ||||
| -rw-r--r-- | docs/requirements.txt | 3 |
4 files changed, 12 insertions, 4 deletions
diff --git a/docs/content/contribution/documentation.md b/docs/content/contribution/documentation.md index 75952b7f..b06d48ab 100644 --- a/docs/content/contribution/documentation.md +++ b/docs/content/contribution/documentation.md @@ -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/). diff --git a/docs/content/contribution/issues-and-pull-requests.md b/docs/content/contribution/issues-and-pull-requests.md index d4ba805a..7207ad7e 100644 --- a/docs/content/contribution/issues-and-pull-requests.md +++ b/docs/content/contribution/issues-and-pull-requests.md @@ -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 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 5a2c2ac0..ab378806 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -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 diff --git a/docs/requirements.txt b/docs/requirements.txt index 36036e8f..cd567400 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -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
\ No newline at end of file |