From 03982f2c7ecae3fee2e187f1d235b28f373d8885 Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Mon, 30 Oct 2023 16:32:49 -0400 Subject: [PATCH 1/2] 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 --- .github/workflows/reviewer-needed-label.yaml | 4 +- .github/workflows/stale-issue-bot.yaml | 6 +- docs/Contact.md | 68 ++++++-------------- docs/SDCard_Updates.md | 2 +- 4 files changed, 26 insertions(+), 54 deletions(-) diff --git a/.github/workflows/reviewer-needed-label.yaml b/.github/workflows/reviewer-needed-label.yaml index c4603b300270..61b72dc98fca 100644 --- a/.github/workflows/reviewer-needed-label.yaml +++ b/.github/workflows/reviewer-needed-label.yaml @@ -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" diff --git a/.github/workflows/stale-issue-bot.yaml b/.github/workflows/stale-issue-bot.yaml index 3ada94d61dea..2f05abc1fb7b 100644 --- a/.github/workflows/stale-issue-bot.yaml +++ b/.github/workflows/stale-issue-bot.yaml @@ -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" diff --git a/docs/Contact.md b/docs/Contact.md index d6ffc08dcfae..26894eb1188c 100644 --- a/docs/Contact.md +++ b/docs/Contact.md @@ -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). diff --git a/docs/SDCard_Updates.md b/docs/SDCard_Updates.md index 77a586157dae..432446de78cf 100644 --- a/docs/SDCard_Updates.md +++ b/docs/SDCard_Updates.md @@ -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 From 64a97431b5091d97b06cb125c30213519495d84b Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Mon, 30 Oct 2023 18:18:17 -0400 Subject: [PATCH 2/2] docs: Update Contact.md to note other common ways to obtain Klipper log file Signed-off-by: Kevin O'Connor --- docs/Contact.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/docs/Contact.md b/docs/Contact.md index 26894eb1188c..714c36bd4339 100644 --- a/docs/Contact.md +++ b/docs/Contact.md @@ -94,22 +94,27 @@ bug. Please follow these steps: about the software and its environment (software version, hardware type, configuration, event timing, and hundreds of other questions). - 1. The Klipper log file is located in `/tmp/klippy.log` on the - Klipper "host" computer (the Raspberry Pi). - 2. An "scp" or "sftp" utility is needed to copy this log file to - your desktop computer. The "scp" utility comes standard with - Linux and MacOS desktops. There are freely available scp - utilities for other desktops (eg, WinSCP). If using a graphical - scp utility that can not directly copy `/tmp/klippy.log` then - repeatedly click on `..` or `parent folder` until you get to the - root directory, click on the `tmp` folder, and then select the - `klippy.log` file. - 3. Copy the log file to your desktop so that it can be attached to + 1. Dedicated Klipper web interfaces have the ability to directly + obtain the Klipper log file. It's the easiest way to obtain the + log when using one of these interfaces. Otherwise, an "scp" or + "sftp" utility is needed to copy the log file to your desktop + computer. The "scp" utility comes standard with Linux and MacOS + desktops. There are freely available scp utilities for other + desktops (eg, WinSCP). The log file may be located in the + `~/printer_data/logs/klippy.log` file (if using a graphical scp + utility, look for the "printer_data" folder, then the "logs" + folder under that, then the `klippy.log` file). The log file may + alternatively be located in the `/tmp/klippy.log` file (if using + a graphical scp utility that can not directly copy + `/tmp/klippy.log` then repeatedly click on `..` or + "parent folder" until reaching the root directory, click on + the `tmp` folder, and then select the `klippy.log` file). + 2. Copy the log file to your desktop so that it can be attached to an issue report. - 4. Do not modify the log file in any way; do not provide a snippet + 3. Do not modify the log file in any way; do not provide a snippet 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. + 4. It is a good idea to compress the log file with zip or gzip. 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