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

docs: Update the Contact document 

Try to make it more clear that Discord is not Discourse, as the two
similarly sounding services are often confused by users unfamiliar
with them.

The Klipper Discourse and Klipper Discord are available for many
topics related to Klipper - reword some sections to make their use
more open.

Avoid referring to the Klipper github repo in this Contact document as
we no longer use Klipper github issues at all.

Remove the table of contents as it is largely redundant for the
document.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2023-10-30 16:32:49 -04:00
parent bee7ec720b
commit 03982f2c7e
4 changed files with 26 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/reviewer-needed-label.yaml vendored
View File

@ -34,7 +34,7 @@ jobs:
+ " bulk of a review has already been completed."
+ "\n"
+ "2. Consider opening a topic on the [Klipper Discourse]"
+ "(https://www.klipper3d.org/Contact.html#community-forum)"
+ "(https://www.klipper3d.org/Contact.html#discourse-forum)"
+ " server to discuss this work. The Discourse server is a good"
+ " place to discuss development ideas and to engage users"
+ " interested in testing. Reviewers are more likely to"
@ -50,7 +50,7 @@ jobs:
+ " this GitHub Pull Request then it will be automatically"
+ " closed. If this happens, then it is a good idea to move"
+ " further discussion to the [Klipper Discourse]"
+ "(https://www.klipper3d.org/Contact.html#community-forum)"
+ "(https://www.klipper3d.org/Contact.html#discourse-forum)"
+ " server. Reviewers can reach out on that forum to let you"
+ " know if they are interested and when they are available."
+ "\n\n"

6
.github/workflows/stale-issue-bot.yaml vendored
View File

@ -83,7 +83,7 @@ jobs:
+ " this GitHub Pull Request and it is therefore being"
+ " closed. It is a good idea to move"
+ " further discussion to the [Klipper Discourse]"
+ "(https://www.klipper3d.org/Contact.html#community-forum)"
+ "(https://www.klipper3d.org/Contact.html#discourse-forum)"
+ " server. Reviewers can reach out on that forum to let you"
+ " know if they are interested and when they are available."
+ "\n\n"
@ -137,7 +137,7 @@ jobs:
+ " bulk of a review has already been completed."
+ "\n"
+ "2. Consider opening a topic on the [Klipper Discourse]"
+ "(https://www.klipper3d.org/Contact.html#community-forum)"
+ "(https://www.klipper3d.org/Contact.html#discourse-forum)"
+ " server to discuss this work. The Discourse server is a good"
+ " place to discuss development ideas and to engage users"
+ " interested in testing. Reviewers are more likely to"
@ -153,7 +153,7 @@ jobs:
+ " this GitHub Pull Request then it will be automatically"
+ " closed. If this happens, then it is a good idea to move"
+ " further discussion to the [Klipper Discourse]"
+ "(https://www.klipper3d.org/Contact.html#community-forum)"
+ "(https://www.klipper3d.org/Contact.html#discourse-forum)"
+ " server. Reviewers can reach out on that forum to let you"
+ " know if they are interested and when they are available."
+ "\n\n"

68
docs/Contact.md
View File

@ -2,25 +2,18 @@
This document provides contact information for Klipper.
1. [Community Forum](#community-forum)
2. [Discord Chat](#discord-chat)
3. [I have a question about Klipper](#i-have-a-question-about-klipper)
4. [I have a feature request](#i-have-a-feature-request)
5. [Help! It doesn't work!](#help-it-doesnt-work)
6. [I found a bug in the Klipper software](#i-found-a-bug-in-the-klipper-software)
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 github](#klipper-github)
## Community Forum
## Discourse Forum
There is a
[Klipper Community Discourse server](https://community.klipper3d.org)
for discussions on Klipper.
for "forum" style discussions on Klipper. Note that Discourse is not
Discord.
## Discord Chat
There is a Discord server dedicated to Klipper at:
[https://discord.klipper3d.org](https://discord.klipper3d.org).
[https://discord.klipper3d.org](https://discord.klipper3d.org). Note
that Discord is not Discourse.
This server is run by a community of Klipper enthusiasts dedicated to
discussions on Klipper. It allows users to chat with other users in
@ -33,37 +26,29 @@ Many questions we receive are already answered in the
documentation and follow the directions provided there.
It is also possible to search for similar questions in the
[Klipper Community Forum](#community-forum).
[Klipper Discourse Forum](#discourse-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 Discourse Forum](#discourse-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
not specific to Klipper. If you have a general question or are
experiencing general printing problems, then you will likely get a
better response by asking in a general 3d-printing forum or a forum
dedicated to your printer hardware.
If you have a general question or are experiencing general printing
problems, then also consider a general 3d-printing forum or a forum
dedicated to the printer hardware.
## I have a feature request
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, you can search for ongoing developments in the
[Klipper Community Forum](#community-forum). There is also
[Klipper Discourse Forum](#discourse-forum). There is also
[Klipper Discord Chat](#discord-chat) for discussions between
collaborators.
## Help! It doesn't work!
Unfortunately, we receive many more requests for help than we could
possibly answer. Most problem reports we see are eventually tracked
down to:
1. Subtle errors in the hardware, or
2. Not following all the steps described in the Klipper documentation.
If you are experiencing problems we recommend you carefully read the
[Klipper documentation](Overview.md) and double check that all steps
were followed.
@ -72,16 +57,15 @@ If you are experiencing a printing problem, then we recommend
carefully inspecting the printer hardware (all joints, wires, screws,
etc.) and verify nothing is abnormal. We find most printing problems
are not related to the Klipper software. If you do find a problem with
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.
the printer hardware then consider searching general 3d-printing
forums or forums dedicated to the printer hardware.
It is also possible to search for similar issues in the
[Klipper Community Forum](#community-forum).
[Klipper Discourse Forum](#discourse-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 Discourse Forum](#discourse-forum) or
[Klipper Discord Chat](#discord-chat). Both are communities where
Klipper users can discuss Klipper with other users.
@ -91,7 +75,7 @@ Klipper is an open-source project and we appreciate when collaborators
diagnose errors in the software.
Problems should be reported in the
[Klipper Community Forum](#community-forum).
[Klipper Discourse Forum](#discourse-forum).
There is important information that will be needed in order to fix a
bug. Please follow these steps:
@ -126,7 +110,7 @@ bug. Please follow these steps:
of the log. Only the full unmodified log file provides the
necessary information.
5. It is a good idea to compress the log file with zip or gzip.
5. Open a new topic on the [Klipper Community Forum](#community-forum)
5. Open a new topic on the [Klipper Discourse Forum](#discourse-forum)
and provide a clear description of the problem. Other Klipper
contributors will need to understand what steps were taken, what
the desired outcome was, and what outcome actually occurred. The
@ -136,22 +120,10 @@ bug. Please follow these steps:
Klipper is open-source software and we appreciate new contributions.
New contributions (for both code and documentation) are submitted via
Github Pull Requests. See the [CONTRIBUTING document](CONTRIBUTING.md)
for important information.
See the [CONTRIBUTING document](CONTRIBUTING.md) for information.
There are several
[documents for developers](Overview.md#developer-documentation). If
you have questions on the code then you can also ask in the
[Klipper Community Forum](#community-forum) or on the
[Klipper Community Discord](#discord-chat).
## Klipper github
Klipper github may be used by contributors to share the status of
their work to improve Klipper. It is expected that the person opening
a github ticket is actively working on the given task and will be the
one performing all the work necessary to accomplish it. The Klipper
github is not used for requests, nor to report bugs, nor to ask
questions. Use the [Klipper Community Forum](#community-forum) or the
[Klipper Community Discord](#discord-chat) instead.
[Klipper Discourse Forum](#discourse-forum) or on the
[Klipper Discord Chat](#discord-chat).

2
docs/SDCard_Updates.md
View File

@ -170,7 +170,7 @@ BOARD_ALIASES = {
If you need a new board definition and you are uncomfortable with the
procedure outlined above it is recommended that you request one in
the [Klipper Community Discord](Contact.md#discord).
the [Klipper Discord](Contact.md).
## Flashing Boards that use SDIO