From 1e88c37750fc4497135ef0426a04f9f5843c2da4 Mon Sep 17 00:00:00 2001 From: meteyou Date: Tue, 2 Jan 2024 13:58:42 +0000 Subject: [PATCH] GITBOOK-155: Help page --- SUMMARY.md | 13 +-- about/{sponsors.md => sponsors/README.md} | 4 +- .../sponsors}/development/README.md | 0 .../sponsors}/development/code-standards.md | 2 +- .../sponsors}/development/environment.md | 0 .../sponsors}/development/localization.md | 0 faq/getting-help/README.md | 16 ++++ faq/getting-help/discord.md | 88 +++++++++++++++++++ faq/getting-help/github-discussions.md | 59 +++++++++++++ overview/features/localization.md | 2 +- 10 files changed, 175 insertions(+), 9 deletions(-) rename about/{sponsors.md => sponsors/README.md} (82%) rename {overview => about/sponsors}/development/README.md (100%) rename {overview => about/sponsors}/development/code-standards.md (96%) rename {overview => about/sponsors}/development/environment.md (100%) rename {overview => about/sponsors}/development/localization.md (100%) create mode 100644 faq/getting-help/README.md create mode 100644 faq/getting-help/discord.md create mode 100644 faq/getting-help/github-discussions.md diff --git a/SUMMARY.md b/SUMMARY.md index 62bff0d..a2513df 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -60,10 +60,6 @@ * [Additional Sensors](overview/quicktips/additional-sensors.md) * [Disable Octoprint LCD menu](overview/quicktips/disable-octoprint-lcd-menu.md) * [config.json](overview/quicktips/config.json.md) -* [Development](overview/development/README.md) - * [Code standards](overview/development/code-standards.md) - * [Environment](overview/development/environment.md) - * [Localization](overview/development/localization.md) ## FAQ @@ -75,11 +71,18 @@ * [PolicyKit Permissions](faq/moonraker\_warnings/policykit-permissions.md) * [Klipper errors](faq/klipper\_errors/README.md) * [Command format mismatch](faq/klipper\_errors/command-format-mismatch.md) +* [Getting Help](faq/getting-help/README.md) + * [Discord](faq/getting-help/discord.md) + * [GitHub Discussions](faq/getting-help/github-discussions.md) ## About * [Data Privacy](about/data-privacy.md) -* [Sponsors](about/sponsors.md) +* [Sponsors](about/sponsors/README.md) + * [Development](about/sponsors/development/README.md) + * [Code standards](about/sponsors/development/code-standards.md) + * [Environment](about/sponsors/development/environment.md) + * [Localization](about/sponsors/development/localization.md) * [Credits](about/credits.md) ## 🔗 Links diff --git a/about/sponsors.md b/about/sponsors/README.md similarity index 82% rename from about/sponsors.md rename to about/sponsors/README.md index 9fef185..ecdc1e6 100644 --- a/about/sponsors.md +++ b/about/sponsors/README.md @@ -8,11 +8,11 @@ description: >- ## Official Partners -

BigTreeTech

+

BigTreeTech

**BIGTREETECH** is the official mainboard partner of Mainsail. BIGTREETECH is committed to developing innovative and competitive products to better serve the 3D printing community. Follow them on [Facebook](https://www.facebook.com/BIGTREETECH) or [Twitter](https://twitter.com/BigTreeTech). -

JetBrains

+

JetBrains

[**JetBrains**](https://www.jetbrains.com/community/opensource/#support), one of the leading software providers for development environments(IDEs), supports us with free [open-source licences](https://www.jetbrains.com/community/opensource/#support). JetBrains ensures a smooth workflow and is a great help to develop Mainsail. diff --git a/overview/development/README.md b/about/sponsors/development/README.md similarity index 100% rename from overview/development/README.md rename to about/sponsors/development/README.md diff --git a/overview/development/code-standards.md b/about/sponsors/development/code-standards.md similarity index 96% rename from overview/development/code-standards.md rename to about/sponsors/development/code-standards.md index c043d95..5bab31b 100644 --- a/overview/development/code-standards.md +++ b/about/sponsors/development/code-standards.md @@ -19,7 +19,7 @@ Add this integration by: So it looks like this: -![](../../.gitbook/assets/prettier-config-jetbrains.png) +![](../../../.gitbook/assets/prettier-config-jetbrains.png) ### VSCode diff --git a/overview/development/environment.md b/about/sponsors/development/environment.md similarity index 100% rename from overview/development/environment.md rename to about/sponsors/development/environment.md diff --git a/overview/development/localization.md b/about/sponsors/development/localization.md similarity index 100% rename from overview/development/localization.md rename to about/sponsors/development/localization.md diff --git a/faq/getting-help/README.md b/faq/getting-help/README.md new file mode 100644 index 0000000..eaaa379 --- /dev/null +++ b/faq/getting-help/README.md @@ -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 %} + diff --git a/faq/getting-help/discord.md b/faq/getting-help/discord.md new file mode 100644 index 0000000..196a652 --- /dev/null +++ b/faq/getting-help/discord.md @@ -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 %} diff --git a/faq/getting-help/github-discussions.md b/faq/getting-help/github-discussions.md new file mode 100644 index 0000000..c7728de --- /dev/null +++ b/faq/getting-help/github-discussions.md @@ -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) diff --git a/overview/features/localization.md b/overview/features/localization.md index 196ee85..e248652 100644 --- a/overview/features/localization.md +++ b/overview/features/localization.md @@ -16,7 +16,7 @@ In the "GENERAL" section, select your preferred language. ## Missing a translation or found an incorrect translation? -You are welcome to help us improve the translations. You can find instructions on how to do that over [here](../development/localization.md). +You are welcome to help us improve the translations. You can find instructions on how to do that over [here](../../about/sponsors/development/localization.md). {% hint style="info" %} Get in touch with us on our Discord server. We will assign you a translator role for your language and inform you in advance when a new Mainsail version will be released, so that you can make the changes.