3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add links to Klipper Discourse server to Contact.md 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2021-03-20 16:37:59 -04:00
parent b88a0b8004
commit 00f8262e57
2 changed files with 65 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/ISSUE_TEMPLATE/config.yml vendored
View File

@ -3,6 +3,9 @@ contact_links:
- name: Directions - name: Directions
url: https://www.klipper3d.org/Contact.html url: https://www.klipper3d.org/Contact.html
about: Have a question? Need help? Start here. about: Have a question? Need help? Start here.
- name: Klipper Forum
url: https://community.klipper3d.org/
about: Klipper community Discourse server.
- name: Klipper Chat - name: Klipper Chat
url: https://discord.klipper3d.org/ url: https://discord.klipper3d.org/
about: Klipper community Discord chat server. about: Klipper community Discord chat server.

156
docs/Contact.md
View File

@ -1,51 +1,61 @@
This document provides contact information for Klipper. This document provides contact information for Klipper.
1. [I have a question about Klipper](#i-have-a-question-about-klipper) 1. [Community Forum](#community-forum)
2. [I have a feature request](#i-have-a-feature-request) 2. [Discord Chat](#discord-chat)
3. [Help! It doesn't work!](#help-it-doesnt-work) 3. [I have a question about Klipper](#i-have-a-question-about-klipper)
4. [I would like to share the findings of work that I have done](#i-would-like-to-share-the-findings-of-work-that-i-have-done) 4. [I have a feature request](#i-have-a-feature-request)
5. [I found a bug in Klipper](#i-found-a-bug-in-klipper) 5. [Help! It doesn't work!](#help-it-doesnt-work)
6. [I am making changes that I'd like to include in Klipper](#i-am-making-changes-that-id-like-to-include-in-klipper) 6. [I have diagnosed a defect in the Klipper software](#i-have-diagnosed-a-defect-in-the-klipper-software)
7. [Klipper Community Discord](#discord) 7. [I am making changes that I'd like to include in Klipper](#i-am-making-changes-that-id-like-to-include-in-klipper)
8. [Klipper mailing list](#mailing-list)
I have a question about Klipper # Community Forum
===============================
Unfortunately, we receive many more questions than we could possibly There is a [Klipper Community Discourse
answer. We did our best to provide answers to common questions in the server](https://community.klipper3d.org) for discussions on Klipper.
[Klipper documentation](Overview.md). Please take the time to read the
# Discord Chat
There is a Discord server dedicated to Klipper at:
[https://discord.klipper3d.org](https://discord.klipper3d.org).
This server is run by a community of Klipper enthusiasts dedicated to
discussions on Klipper. It allows users to chat with other users in
real-time.
# I have a question about Klipper
Many questions we receive are already answered in the [Klipper
documentation](Overview.md). Please be sure to to read the
documentation and follow the directions provided there. documentation and follow the directions provided there.
It is also possible to search for similar questions in the [Klipper
Community Forum](#community-forum).
If you are interested in sharing your knowledge and experience with
other Klipper users then you can join the [Klipper Community
Forum](#community-forum) or [Klipper Discord
Chat](#discord-chat). Both are communities where Klipper users can
discuss Klipper with other users.
Many questions we receive are general 3d-printing questions that are Many questions we receive are general 3d-printing questions that are
not specific to Klipper. If you have a general question or are not specific to Klipper. If you have a general question or are
experiencing general printing problems, then you will likely get a experiencing general printing problems, then you will likely get a
better response by asking in a general 3d-printing forum or a forum better response by asking in a general 3d-printing forum or a forum
dedicated to your printer hardware. dedicated to your printer hardware.
If you are interested in sharing your knowledge and experience with
other Klipper users then you can join the
[Klipper Community Discord](#discord). It is a community where Klipper
users can discuss Klipper with other users.
Do not open a Klipper github issue to ask a question. Do not open a Klipper github issue to ask a question.
I have a feature request # I have a feature request
========================
All new features require someone interested and able to implement that All new features require someone interested and able to implement that
feature. If you are interested in helping to implement or test a new feature. If you are interested in helping to implement or test a new
feature, you can inquire about ongoing developments in the feature, you can search for ongoing developments in the [Klipper
[Klipper Community Discord](#discord). Community Forum](#community-forum). There is also [Klipper Discord
Chat](#discord-chat) for discussions between collaborators.
Unfortunately, if no one is currently working on a feature, then it is
unlikely to be implemented in the near future. We only track features
that are under active development.
Do not open a Klipper github issue to request a feature. Do not open a Klipper github issue to request a feature.
Help! It doesn't work! # Help! It doesn't work!
======================
Unfortunately, we receive many more requests for help than we could Unfortunately, we receive many more requests for help than we could
possibly answer. Most problem reports we see are eventually tracked possibly answer. Most problem reports we see are eventually tracked
@ -60,40 +70,26 @@ were followed.
If you are experiencing a printing problem, then we recommend If you are experiencing a printing problem, then we recommend
carefully inspecting the printer hardware (all joints, wires, screws, carefully inspecting the printer hardware (all joints, wires, screws,
etc.) and verify nothing is abnormal. We find most printing problems etc.) and verify nothing is abnormal. We find most printing problems
are not related to the Klipper software. You may get a better response are not related to the Klipper software. If you do find a problem with
by searching in a general 3d-printing forum or in a forum dedicated to the printer hardware then you will likely get a better response by
searching in a general 3d-printing forum or in a forum dedicated to
your printer hardware. your printer hardware.
It is also possible to search for similar issues in the [Klipper
Community Forum](#community-forum).
If you are interested in sharing your knowledge and experience with If you are interested in sharing your knowledge and experience with
other Klipper users then you can join the other Klipper users then you can join the [Klipper Community
[Klipper Community Discord](#discord). It is a community where Klipper Forum](#community-forum) or [Klipper Discord
users can discuss Klipper with other users. Chat](#discord-chat). Both are communities where Klipper users can
discuss Klipper with other users.
Do not open a Klipper github issue to request help. Do not open a Klipper github issue to request help.
I would like to share the findings of work that I have done # I have diagnosed a defect in the Klipper software
===========================================================
We use Github as a location for collaborators that are working on
improving Klipper to share the results of their work. If you have done
some interesting research then you can share the results of your work
using the Github issue tracker.
Note, that the Klipper Github is not a place to ask a question and it
is not a place to make requests.
The Klipper Github issue tracker is at:
[https://github.com/KevinOConnor/klipper/issues](https://github.com/KevinOConnor/klipper/issues)
Another option is to share your results using the
[Klipper Community Discord](#discord). It is a community where Klipper
users can discuss Klipper with other users.
I found a bug in Klipper
========================
Klipper is an open-source project and we appreciate when collaborators Klipper is an open-source project and we appreciate when collaborators
provide bug reports. diagnose errors in the software.
There is important information that will be needed in order to fix a There is important information that will be needed in order to fix a
bug. Please follow these steps: bug. Please follow these steps:
@ -102,9 +98,9 @@ bug. Please follow these steps:
Klipper bug", then **do not** open a github issue. In that case, Klipper bug", then **do not** open a github issue. In that case,
someone interested and able will need to first research and someone interested and able will need to first research and
diagnose the root cause of the problem. If you would like to share diagnose the root cause of the problem. If you would like to share
the results of your research and check if other users are the results of your research or check if other users are
experiencing similar issues then you can join the experiencing similar issues then you can search the [Klipper
[Klipper Community Discord](#discord) and inquire there. Community Forum](#community-forum).
2. Make sure you are running unmodified code from 2. Make sure you are running unmodified code from
[https://github.com/KevinOConnor/klipper](https://github.com/KevinOConnor/klipper). [https://github.com/KevinOConnor/klipper](https://github.com/KevinOConnor/klipper).
If the code has been modified or is obtained from another source, If the code has been modified or is obtained from another source,
@ -147,8 +143,7 @@ bug. Please follow these steps:
![attach-issue](img/attach-issue.png) ![attach-issue](img/attach-issue.png)
I am making changes that I'd like to include in Klipper # I am making changes that I'd like to include in Klipper
=======================================================
Klipper is open-source software and we appreciate new contributions. Klipper is open-source software and we appreciate new contributions.
@ -156,38 +151,11 @@ New contributions (for both code and documentation) are submitted via
Github Pull Requests. See the [CONTRIBUTING document](CONTRIBUTING.md) Github Pull Requests. See the [CONTRIBUTING document](CONTRIBUTING.md)
for important information. for important information.
There are several There are several [documents for
[documents for developers](Overview.md#developer-documentation). If developers](Overview.md#developer-documentation). If you have
you have questions on the code then you can also ask on the questions on the code then you can also ask in the [Klipper Community
[Klipper Community Discord](#discord). If you would like to provide an Forum](#community-forum) or on the [Klipper Community
update on your current progress then you can open a Github issue with Discord](#discord-chat). If you would like to provide an update on
the location of your code, an overview of the changes, and a your current progress then you can open a Github issue with the
description of its current status. location of your code, an overview of the changes, and a description
of its current status.
Discord
=======
There is a Discord server dedicated to Klipper at:
[https://discord.klipper3d.org](https://discord.klipper3d.org).
This server is run by a community of Klipper enthusiasts dedicated to
discussions on Klipper. It allows users to chat with other users in
real-time.
Mailing list
============
There is a mailing list for Klipper announcements and for discussions
on the Klipper project itself.
Do not use the email list to
[ask a printing question](#i-have-a-question-about-klipper),
nor to [make a feature request](#i-have-a-feature-request), nor to
[ask for help with a printer](#help-it-doesnt-work).
In order to send an email to the list, one must first subscribe:
[https://www.freelists.org/list/klipper](https://www.freelists.org/list/klipper)
. Once subscribed, emails may be sent to `klipper@freelists.org`.
Archives of the mailing list are available at:
[https://www.freelists.org/archive/klipper/](https://www.freelists.org/archive/klipper/)