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

Deploying to gh-pages from @ Klipper3d/klipper@64a97431b5 🚀

Browse Source
This commit is contained in:
KevinOConnor
2023-11-01 23:18:03 +00:00
parent fe07b4b3b1
commit bc113f9e41
15 changed files with 41 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

115
Contact.html
View File

@@ -402,8 +402,8 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#community-forum" class="md-nav__link">
Community Forum
<a href="#discourse-forum" class="md-nav__link">
Discourse Forum
</a>
</li>
@@ -448,13 +448,6 @@
I am making changes that I'd like to include in Klipper
</a>
</li>
<li class="md-nav__item">
<a href="#klipper-github" class="md-nav__link">
Klipper github
</a>
</li>
</ul>
@@ -1357,8 +1350,8 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#community-forum" class="md-nav__link">
Community Forum
<a href="#discourse-forum" class="md-nav__link">
Discourse Forum
</a>
</li>
@@ -1403,13 +1396,6 @@
I am making changes that I'd like to include in Klipper
</a>
</li>
<li class="md-nav__item">
<a href="#klipper-github" class="md-nav__link">
Klipper github
</a>
</li>
</ul>
@@ -1431,23 +1417,15 @@
<h1 id="contact">Contact<a class="headerlink" href="#contact" title="Permanent link">&para;</a></h1>
<p>This document provides contact information for Klipper.</p>
<ol>
<li><a href="#community-forum">Community Forum</a></li>
<li><a href="#discord-chat">Discord Chat</a></li>
<li><a href="#i-have-a-question-about-klipper">I have a question about Klipper</a></li>
<li><a href="#i-have-a-feature-request">I have a feature request</a></li>
<li><a href="#help-it-doesnt-work">Help! It doesn't work!</a></li>
<li><a href="#i-found-a-bug-in-the-klipper-software">I found a bug in the Klipper software</a></li>
<li><a href="#i-am-making-changes-that-id-like-to-include-in-klipper">I am making changes that I'd like to include in Klipper</a></li>
<li><a href="#klipper-github">Klipper github</a></li>
</ol>
<h2 id="community-forum">Community Forum<a class="headerlink" href="#community-forum" title="Permanent link">&para;</a></h2>
<h2 id="discourse-forum">Discourse Forum<a class="headerlink" href="#discourse-forum" title="Permanent link">&para;</a></h2>
<p>There is a
<a href="https://community.klipper3d.org">Klipper Community Discourse server</a>
for discussions on Klipper.</p>
for "forum" style discussions on Klipper. Note that Discourse is not
Discord.</p>
<h2 id="discord-chat">Discord Chat<a class="headerlink" href="#discord-chat" title="Permanent link">&para;</a></h2>
<p>There is a Discord server dedicated to Klipper at:
<a href="https://discord.klipper3d.org"><a href="https://discord.klipper3d.org">https://discord.klipper3d.org</a></a>.</p>
<a href="https://discord.klipper3d.org"><a href="https://discord.klipper3d.org">https://discord.klipper3d.org</a></a>. Note
that Discord is not Discourse.</p>
<p>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.</p>
@@ -1456,32 +1434,23 @@ real-time.</p>
<a href="Overview.html">Klipper documentation</a>. Please be sure to to read the
documentation and follow the directions provided there.</p>
<p>It is also possible to search for similar questions in the
<a href="#community-forum">Klipper Community Forum</a>.</p>
<a href="#discourse-forum">Klipper Discourse Forum</a>.</p>
<p>If you are interested in sharing your knowledge and experience with
other Klipper users then you can join the
<a href="#community-forum">Klipper Community Forum</a> or
<a href="#discourse-forum">Klipper Discourse Forum</a> or
<a href="#discord-chat">Klipper Discord Chat</a>. Both are communities where
Klipper users can discuss Klipper with other users.</p>
<p>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.</p>
<p>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.</p>
<h2 id="i-have-a-feature-request">I have a feature request<a class="headerlink" href="#i-have-a-feature-request" title="Permanent link">&para;</a></h2>
<p>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
<a href="#community-forum">Klipper Community Forum</a>. There is also
<a href="#discourse-forum">Klipper Discourse Forum</a>. There is also
<a href="#discord-chat">Klipper Discord Chat</a> for discussions between
collaborators.</p>
<h2 id="help-it-doesnt-work">Help! It doesn't work!<a class="headerlink" href="#help-it-doesnt-work" title="Permanent link">&para;</a></h2>
<p>Unfortunately, we receive many more requests for help than we could
possibly answer. Most problem reports we see are eventually tracked
down to:</p>
<ol>
<li>Subtle errors in the hardware, or</li>
<li>Not following all the steps described in the Klipper documentation.</li>
</ol>
<p>If you are experiencing problems we recommend you carefully read the
<a href="Overview.html">Klipper documentation</a> and double check that all steps
were followed.</p>
@@ -1489,21 +1458,20 @@ were followed.</p>
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.</p>
the printer hardware then consider searching general 3d-printing
forums or forums dedicated to the printer hardware.</p>
<p>It is also possible to search for similar issues in the
<a href="#community-forum">Klipper Community Forum</a>.</p>
<a href="#discourse-forum">Klipper Discourse Forum</a>.</p>
<p>If you are interested in sharing your knowledge and experience with
other Klipper users then you can join the
<a href="#community-forum">Klipper Community Forum</a> or
<a href="#discourse-forum">Klipper Discourse Forum</a> or
<a href="#discord-chat">Klipper Discord Chat</a>. Both are communities where
Klipper users can discuss Klipper with other users.</p>
<h2 id="i-found-a-bug-in-the-klipper-software">I found a bug in the Klipper software<a class="headerlink" href="#i-found-a-bug-in-the-klipper-software" title="Permanent link">&para;</a></h2>
<p>Klipper is an open-source project and we appreciate when collaborators
diagnose errors in the software.</p>
<p>Problems should be reported in the
<a href="#community-forum">Klipper Community Forum</a>.</p>
<a href="#discourse-forum">Klipper Discourse Forum</a>.</p>
<p>There is important information that will be needed in order to fix a
bug. Please follow these steps:</p>
<ol>
@@ -1522,16 +1490,21 @@ bug. Please follow these steps:</p>
about the software and its environment (software version, hardware
type, configuration, event timing, and hundreds of other
questions).<ol>
<li>The Klipper log file is located in <code>/tmp/klippy.log</code> on the
Klipper "host" computer (the Raspberry Pi).</li>
<li>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 <code>/tmp/klippy.log</code> then
repeatedly click on <code>..</code> or <code>parent folder</code> until you get to the
root directory, click on the <code>tmp</code> folder, and then select the
<code>klippy.log</code> file.</li>
<li>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
<code>~/printer_data/logs/klippy.log</code> file (if using a graphical scp
utility, look for the "printer_data" folder, then the "logs"
folder under that, then the <code>klippy.log</code> file). The log file may
alternatively be located in the <code>/tmp/klippy.log</code> file (if using
a graphical scp utility that can not directly copy
<code>/tmp/klippy.log</code> then repeatedly click on <code>..</code> or
"parent folder" until reaching the root directory, click on
the <code>tmp</code> folder, and then select the <code>klippy.log</code> file).</li>
<li>Copy the log file to your desktop so that it can be attached to
an issue report.</li>
<li>Do not modify the log file in any way; do not provide a snippet
@@ -1540,7 +1513,7 @@ bug. Please follow these steps:</p>
<li>It is a good idea to compress the log file with zip or gzip.</li>
</ol>
</li>
<li>Open a new topic on the <a href="#community-forum">Klipper Community Forum</a>
<li>Open a new topic on the <a href="#discourse-forum">Klipper Discourse Forum</a>
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
@@ -1548,22 +1521,12 @@ bug. Please follow these steps:</p>
</ol>
<h2 id="i-am-making-changes-that-id-like-to-include-in-klipper">I am making changes that I'd like to include in Klipper<a class="headerlink" href="#i-am-making-changes-that-id-like-to-include-in-klipper" title="Permanent link">&para;</a></h2>
<p>Klipper is open-source software and we appreciate new contributions.</p>
<p>New contributions (for both code and documentation) are submitted via
Github Pull Requests. See the <a href="CONTRIBUTING.html">CONTRIBUTING document</a>
for important information.</p>
<p>See the <a href="CONTRIBUTING.html">CONTRIBUTING document</a> for information.</p>
<p>There are several
<a href="Overview.html#developer-documentation">documents for developers</a>. If
you have questions on the code then you can also ask in the
<a href="#community-forum">Klipper Community Forum</a> or on the
<a href="#discord-chat">Klipper Community Discord</a>.</p>
<h2 id="klipper-github">Klipper github<a class="headerlink" href="#klipper-github" title="Permanent link">&para;</a></h2>
<p>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 <a href="#community-forum">Klipper Community Forum</a> or the
<a href="#discord-chat">Klipper Community Discord</a> instead.</p>
<a href="#discourse-forum">Klipper Discourse Forum</a> or on the
<a href="#discord-chat">Klipper Discord Chat</a>.</p>
</article>