-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e8603db
commit 1e88c37
Showing
10 changed files
with
175 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| description: >- | ||
| We provide support/help for all Mainsail-Crew software parts on the following | ||
| platforms: | ||
| --- | ||
|
|
||
| # Getting Help | ||
|
|
||
| {% content-ref url="discord.md" %} | ||
| [discord.md](discord.md) | ||
| {% endcontent-ref %} | ||
|
|
||
| {% content-ref url="github-discussions.md" %} | ||
| [github-discussions.md](github-discussions.md) | ||
| {% endcontent-ref %} | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| description: >- | ||
| We are glad to help and chat with you on our Community Discord, but if you | ||
| need help and want the best support possible you should, follow a few simple | ||
| rules: | ||
| --- | ||
|
|
||
| # Discord | ||
|
|
||
| {% hint style="info" %} | ||
| **We cannot help with everything** | ||
|
|
||
| We are trying our best to support everyone to satisfaction but we are just humans too. We cannot know everything and make mistakes sometimes. So if you don't get a response we most likely don't know the answer or sometimes just didn't see your post. | ||
| {% endhint %} | ||
|
|
||
| ## Rules | ||
|
|
||
| ### Is your issue connected to some part of the Mainsail universe or from a third-party? | ||
|
|
||
| As already explained before, we cannot know everything. The main focus of the support is for following programs: | ||
|
|
||
| * [Mainsail](https://github.com/mainsail-crew/mainsail) | ||
| * [MainsailOS](https://github.com/mainsail-crew/MainsailOS) | ||
| * [Crowsnest](https://github.com/mainsail-crew/crowsnest) | ||
| * [Moonraker-Timelapse](https://github.com/mainsail-crew/moonraker-timelapse) | ||
| * [Sonar](https://github.com/mainsail-crew/sonar) | ||
| * [Klipper](https://www.klipper3d.org/) | ||
| * [Moonraker](https://github.com/Arksine/moonraker) | ||
| * Overall Linux questions | ||
|
|
||
| There are also support channels for some third-party programs: | ||
|
|
||
| * [KIAUH](https://github.com/dw-0/kiauh) | ||
| * [Mobileraker](https://mobileraker.com/) | ||
| * [Obico](https://www.obico.io/) | ||
| * [OctoEverywhere](https://octoeverywhere.com/) | ||
| * [Mooncord](https://github.com/eliteSchwein/mooncord) | ||
| * [Spoolman](https://github.com/Donkie/Spoolman) | ||
|
|
||
| {% hint style="danger" %} | ||
| All other questions regarding third-party programs and third-party macros should be asked at the repo of the project and might get ignored. | ||
| {% endhint %} | ||
|
|
||
| ### Chat is not a help channel | ||
|
|
||
| The chat area of the Mainsail Discord should be used only for chatting. If you need help with a topic open a post inside the support-forum. Don't hesitate to open a post even for small problems. | ||
|
|
||
| ### Choose a good post name and the correct tag | ||
|
|
||
| Choosing a good name for your post and only the correct tag, will make it easier for others to know what your issue is about.\ | ||
| \ | ||
| Choosing the correct tag might be difficult so here is an explanation for them: | ||
|
|
||
| * **Mainsail**: Mainsail is just a website running inside your browser. So everything regarding the web interface should use this tag. | ||
| * **Klipper**: This is most times the correct tag for problems regarding your printer. Klipper is the firmware that your printer uses. If you see errors on your Webinterface, then it's most likely a problem with Klipper and therefore your printer.cfg | ||
| * **Moonraker**: Moonraker is forwarding the errors and messages from Klipper that you can see them inside Mainsail. It also manages updates of all the software and is doing the authorization. | ||
| * **Linux**: Linux is the underlying OS for your Raspberry Pi. You can compare it to Windows or MacOS. This tag should be used if you got general Linux questions or issues, errors via SSH or similar topics. | ||
| * **MainsailOS**: MainsailOS is based on Raspberry Pi OS Lite. You can compare it to an base image installation that got installed all software parts (Klipper, Moonraker, Mainsail...) with a tool like KIAUH, some patches pre applied and some recommended or often used settings already set. This tag should only be used for issues coming directly from MainsailOS or questions about the image. | ||
| * **Webcam**: This tag should be chosen for all issues and questions about webcams and Crowsnest | ||
| * **Timelapse**: This tag is for all issues about setting up [Moonraker-Timelapse](https://github.com/mainsail-crew/moonraker-timelapse) or questions about the settings | ||
|
|
||
| {% hint style="warning" %} | ||
| Choose only one tag best suited for your problem! | ||
| {% endhint %} | ||
|
|
||
| {% hint style="danger" %} | ||
| Configuration problems or errors from your printer doesn't have anything to do with Mainsail. Mainsail is just the messenger showing you that problem. _**Don't shoot the messenger!**_ | ||
| {% endhint %} | ||
|
|
||
| ### Upload logs and give as much information as possible | ||
|
|
||
| Always upload logs and/or pictures of the corresponding software and/or problem. Give detailed informations on when this problem occured and maybe what you already tried to fix it. There is nothing like too much information. | ||
|
|
||
| ### Have patience and always be polite | ||
|
|
||
| Everyone supporting, it doesn't matter if part of the crew or one of the community, are doing this in their free time and doesn't get paid for it. So try to be always polite and have patience. Make sure that you follow everything you are being asked for. | ||
|
|
||
| {% hint style="info" %} | ||
| Don't ask in multiple places at the same time. Getting help on multiple ends for the same problem will make it more difficult and time consuming for everyone. | ||
| {% endhint %} | ||
|
|
||
| ## Open your post and get your issue resolved | ||
|
|
||
| If you read through all of this, you should be ready to join our [Discord](https://discord.gg/mainsail) and open a post for your issue inside the **support-forum**. If your issue is resolved, please close the post again. More information for this can be found inside the **readme** channel. | ||
|
|
||
| {% embed url="http://discord.mainsail.xyz/" %} | ||
| Link to Discord | ||
| {% endembed %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| description: >- | ||
| GitHub Discussions is our second official communication platform. If you don't | ||
| have a Discord account, this area is free for you to use. | ||
| layout: | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: true | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: true | ||
| --- | ||
|
|
||
| # GitHub Discussions | ||
|
|
||
| ## Rules for the Discussions area | ||
|
|
||
| For the use of the Github Discussions area, we have a few rules. Please follow them: | ||
|
|
||
| ### Is your issue part of the Mainsail universe? | ||
|
|
||
| We (Mainsail-Crew) provide a range of software which we support. We can also provide support for related software. Here is an overview of all software programs from the Mainsail-Crew: | ||
|
|
||
| * [Mainsail](https://github.com/mainsail-crew/mainsail) | ||
| * [MainsailOS](https://github.com/mainsail-crew/MainsailOS) | ||
| * [Crowsnest](https://github.com/mainsail-crew/crowsnest) | ||
| * [Moonraker-Timelapse](https://github.com/mainsail-crew/moonraker-timelapse) | ||
| * [Sonar](https://github.com/mainsail-crew/sonar) | ||
|
|
||
| We can also provide support for the following software: | ||
|
|
||
| * [Klipper](https://www.klipper3d.org/) | ||
| * [Moonraker](https://github.com/Arksine/moonraker) | ||
|
|
||
| {% hint style="danger" %} | ||
| All other questions regarding third-party programs and third-party macros should be asked at the repo of the project and might get ignored. | ||
| {% endhint %} | ||
|
|
||
| ### Upload logs and give as much information as possible | ||
|
|
||
| Always upload logs and/or pictures of the corresponding software and/or problem. Give detailed informations on when this problem occured and maybe what you already tried to fix it. There is nothing like too much information. | ||
|
|
||
| ### Have patience and always be polite | ||
|
|
||
| Everyone supporting, it doesn't matter if part of the crew or one of the community, are doing this in their free time and doesn't get paid for it. So try to be always polite and have patience. Make sure that you follow everything you are being asked for. | ||
|
|
||
| {% hint style="warning" %} | ||
| Don't ask in multiple places at the same time. Getting help on multiple ends for the same problem will make it more difficult and time consuming for everyone. | ||
| {% endhint %} | ||
|
|
||
| ## Open your post and get your issue resolved | ||
|
|
||
| If you read through all of this, you should be ready to start your first post in the [GitHub Discussions](https://github.com/orgs/mainsail-crew/discussions) area in the **Help** channel. If your issue is resolved, please close the post again. | ||
|
|
||
| [**Mainsail-Crew GitHub Discussions**](https://github.com/orgs/mainsail-crew/discussions) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters