mirror of
https://github.com/outbackdingo/Mailu.git
synced 2026-01-27 10:19:35 +00:00
Merge #3014
3014: Update issue template and faq r=mergify[bot] a=Diman0 ## What type of PR? documentation ## What does this PR do? We have opened github discussions. Github discussions must be used for anything but issues. The FAQ and issue template have been updated that github issues are only meant for bug reports that follow the issue template. Anything else should be posed on github discussions. ### Related issue(s) ## Prerequisites Before we can consider review and merge, please make sure the following list is done and checked. If an entry in not applicable, you can check it or remove it from the list. - [n/a] In case of feature or enhancement: documentation updated accordingly - [n/a] Unless it's docs or a minor change: add [changelog](https://mailu.io/master/contributors/workflow.html#changelog) entry file. Co-authored-by: Dimitri Huisman <diman@huisman.xyz>
This commit is contained in:
bors[bot]
@@ -1,7 +1,15 @@
|
||||
<!--
|
||||
|
||||
Thank you for opening an issue with Mailu. Please understand that issues are meant for bugs and enhancement-requests.
|
||||
For **user-support questions**, reach out to us on [matrix](https://matrix.to/#/#mailu:tedomum.net).
|
||||
Thank you for opening an issue with Mailu. Please understand that issues are meant for bugs only. The bug report should follow the issue template and provide clear replication steps and logs.
|
||||
For **user-support questions**, reach out to us on [matrix](https://matrix.to/#/#mailu:tedomum.net) or [disussions](https://github.com/Mailu/Mailu/discussions/categories/user-support).
|
||||
|
||||
For anything but bug reports use the [matrix channel](https://matrix.to/#/#mailu:tedomum.net) or [disussions](https://github.com/Mailu/Mailu/discussions).
|
||||
So use discussions for topics such as
|
||||
|
||||
* Checking announcements.
|
||||
* General discussion about Mailu usage or using Mail software in general.
|
||||
* Feature requests
|
||||
* User support.
|
||||
|
||||
To be able to help you best, we need some more information.
|
||||
|
||||
@@ -10,6 +18,7 @@ Before you open your issue
|
||||
- Check [documentation](https://mailu.io/master/) and [FAQ](https://mailu.io/master/faq.html). (Tip, use the search function on the documentation page)
|
||||
- You understand `Mailu` is made by volunteers in their **free time** — be concise, civil and accept that delays can occur.
|
||||
- The title of the issue should be short and simple. It should contain specific terms related to the actual issue. Be specific while writing the title.
|
||||
- You understand issues are only meant for bug reports that follow the issue template. Non bug reports or bug reports that do not follow the template will be moved to [disussions](https://github.com/Mailu/Mailu/discussions)
|
||||
|
||||
Please put your text outside of the comment blocks to be visible. You can use the button "Preview" above to check.
|
||||
|
||||
@@ -32,6 +41,8 @@ $> grep MAILU_VERSION docker-compose.yml mailu.env
|
||||
|
||||
If you are not using docker compose do not file any new issue here.
|
||||
Kubernetes related issues belong to https://github.com/Mailu/helm-charts/issues
|
||||
If you are not using docker compose or kubernetes, create a new thread on user support in [disussions](https://github.com/Mailu/Mailu/discussions/categories/user-support).
|
||||
Non-bug reports (or bug reports that do not follow the template) are moved to [disussions](https://github.com/Mailu/Mailu/discussions).
|
||||
|
||||
## Description
|
||||
<!--
|
||||
@@ -61,9 +72,10 @@ You can get the logs via `docker logs <container name> --tail 1000`.
|
||||
For example for the admin container: `docker logs mailu_admin_1 --tail 1000`
|
||||
or using docker compose `docker compose -f /mailu/docker-compose.yml logs --tail 1000 admin`
|
||||
|
||||
If you can find the relevant section, please share only the parts that seem relevant. If you have any logs, please enclose them in code tags, like so:
|
||||
If you can find the relevant section, please share only the parts that seem relevant. If you have any logs, please enclose them in code tags and in a section, like so:
|
||||
|
||||
```
|
||||
Your logs here!
|
||||
```
|
||||
|
||||
-->
|
||||
|
||||
17
docs/faq.rst
17
docs/faq.rst
@@ -11,8 +11,7 @@ Where to ask questions?
|
||||
|
||||
First, please read this FAQ to check if your question is listed here.
|
||||
Simple questions are best asked in our `Matrix`_ room.
|
||||
For more complex questions, you can always open a `new issue`_ on GitHub.
|
||||
We actively monitor the issues list.
|
||||
For more complex questions, you can always open a `new discussion`_ on GitHub.
|
||||
|
||||
|
||||
My installation is broken!
|
||||
@@ -33,16 +32,17 @@ I want a new feature or enhancement!
|
||||
|
||||
Great! We are always open for suggestions. We currently maintain two tags:
|
||||
|
||||
- `Enhancement issues`_: Typically used for optimization of features in the project.
|
||||
- `Feature request issues`_: For implementing new functionality,
|
||||
- ``type/enhancement``: Typically used for optimization of features in the project.
|
||||
- ``type/feature``: For implementing new functionality,
|
||||
plugins and applications.
|
||||
|
||||
Please check if your idea (or something similar) is already mentioned there.
|
||||
Feature requests are discussed on the discussion page of the project (see `feature requests`_).
|
||||
Please check if your idea (or something similar) is already mentioned on the project.
|
||||
If there is one open, you can choose to vote with a thumbs up, so we can
|
||||
estimate the popular demand. Please refrain from writing comments like
|
||||
*"me too"* as it clobbers the actual discussion.
|
||||
|
||||
If you can't find anything similar, you can open a `new issue`_.
|
||||
If you can't find anything similar, you can open a `new feature request`_.
|
||||
Please also share (where applicable):
|
||||
|
||||
- Use case: how does this improve the project?
|
||||
@@ -89,8 +89,9 @@ Please click the |sponsor| button on top of our GitHub Page for current possibil
|
||||
.. _`Matrix`: https://matrix.to/#/#mailu:tedomum.net
|
||||
.. _`open issues`: https://github.com/Mailu/Mailu/issues
|
||||
.. _`new issue`: https://github.com/Mailu/Mailu/issues/new
|
||||
.. _`Enhancement issues`: https://github.com/Mailu/Mailu/issues?q=is%3Aissue+is%3Aopen+label%3Atype%2Fenhancement
|
||||
.. _`Feature request issues`: https://github.com/Mailu/Mailu/issues?q=is%3Aopen+is%3Aissue+label%3Atype%2Ffeature
|
||||
.. _`new discussion`: https://github.com/Mailu/Mailu/discussions/categories/user-support
|
||||
.. _`feature requests`: https://github.com/Mailu/Mailu/discussions/categories/feature-requests-ideas
|
||||
.. _`new feature request`: https://github.com/Mailu/Mailu/discussions/new?category=feature-requests-ideas
|
||||
.. _`GitHub`: https://github.com/Mailu/Mailu
|
||||
.. _`Community Bridge`: https://funding.communitybridge.org/projects/mailu
|
||||
|
||||
|
||||
Reference in New Issue
Block a user