Deploying to gh-pages from @ Klipper3d/klipper@8a06528747 🚀
This commit is contained in:
KevinOConnor
83
Contact.html
83
Contact.html
@@ -431,8 +431,8 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#i-have-diagnosed-a-defect-in-the-klipper-software" class="md-nav__link">
|
||||
I have diagnosed a defect in the Klipper software
|
||||
<a href="#i-found-a-bug-in-the-klipper-software" class="md-nav__link">
|
||||
I found a bug in the Klipper software
|
||||
</a>
|
||||
|
||||
</li>
|
||||
@@ -442,6 +442,13 @@
|
||||
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>
|
||||
@@ -1337,8 +1344,8 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#i-have-diagnosed-a-defect-in-the-klipper-software" class="md-nav__link">
|
||||
I have diagnosed a defect in the Klipper software
|
||||
<a href="#i-found-a-bug-in-the-klipper-software" class="md-nav__link">
|
||||
I found a bug in the Klipper software
|
||||
</a>
|
||||
|
||||
</li>
|
||||
@@ -1348,6 +1355,13 @@
|
||||
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>
|
||||
@@ -1375,8 +1389,9 @@
|
||||
<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-have-diagnosed-a-defect-in-the-klipper-software">I have diagnosed a defect in the Klipper software</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">¶</a></h2>
|
||||
<p>There is a
|
||||
@@ -1404,7 +1419,6 @@ 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>Do not open a Klipper github issue to ask a question.</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">¶</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
|
||||
@@ -1412,7 +1426,6 @@ feature, you can search for ongoing developments in the
|
||||
<a href="#community-forum">Klipper Community Forum</a>. There is also
|
||||
<a href="#discord-chat">Klipper Discord Chat</a> for discussions between
|
||||
collaborators.</p>
|
||||
<p>Do not open a Klipper github issue to request a feature.</p>
|
||||
<h2 id="help-it-doesnt-work">Help! It doesn't work!<a class="headerlink" href="#help-it-doesnt-work" title="Permanent link">¶</a></h2>
|
||||
<p>Unfortunately, we receive many more requests for help than we could
|
||||
possibly answer. Most problem reports we see are eventually tracked
|
||||
@@ -1438,32 +1451,24 @@ other Klipper users then you can join the
|
||||
<a href="#community-forum">Klipper Community 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>Do not open a Klipper github issue to request help.</p>
|
||||
<h2 id="i-have-diagnosed-a-defect-in-the-klipper-software">I have diagnosed a defect in the Klipper software<a class="headerlink" href="#i-have-diagnosed-a-defect-in-the-klipper-software" title="Permanent link">¶</a></h2>
|
||||
<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">¶</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>
|
||||
<p>There is important information that will be needed in order to fix a
|
||||
bug. Please follow these steps:</p>
|
||||
<ol>
|
||||
<li>Be sure the bug is in the Klipper software. If you are thinking
|
||||
"there is a problem, I can't figure out why, and therefore it is a
|
||||
Klipper bug", then <strong>do not</strong> open a github issue. In that case,
|
||||
someone interested and able will need to first research and
|
||||
diagnose the root cause of the problem. If you would like to share
|
||||
the results of your research or check if other users are
|
||||
experiencing similar issues then you can search the
|
||||
<a href="#community-forum">Klipper Community Forum</a>.</li>
|
||||
<li>Make sure you are running unmodified code from
|
||||
<a href="https://github.com/Klipper3d/klipper"><a href="https://github.com/Klipper3d/klipper">https://github.com/Klipper3d/klipper</a></a>.
|
||||
If the code has been modified or is obtained from another source,
|
||||
then you will need to reproduce the problem on the unmodified code
|
||||
from
|
||||
then you should reproduce the problem on the unmodified code from
|
||||
<a href="https://github.com/Klipper3d/klipper"><a href="https://github.com/Klipper3d/klipper">https://github.com/Klipper3d/klipper</a></a>
|
||||
prior to reporting an issue.</li>
|
||||
<li>If possible, run an <code>M112</code> command in the OctoPrint terminal window
|
||||
immediately after the undesirable event occurs. This causes Klipper
|
||||
to go into a "shutdown state" and it will cause additional
|
||||
debugging information to be written to the log file.</li>
|
||||
prior to reporting.</li>
|
||||
<li>If possible, run an <code>M112</code> command immediately after the
|
||||
undesirable event occurs. This causes Klipper to go into a
|
||||
"shutdown state" and it will cause additional debugging information
|
||||
to be written to the log file.</li>
|
||||
<li>Obtain the Klipper log file from the event. The log file has been
|
||||
engineered to answer common questions the Klipper developers have
|
||||
about the software and its environment (software version, hardware
|
||||
@@ -1484,19 +1489,14 @@ bug. Please follow these steps:</p>
|
||||
<li>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.</li>
|
||||
<li>If the log file is very large (eg, greater than 2MB) then one
|
||||
may need to compress the log with zip or gzip.</li>
|
||||
<li>It is a good idea to compress the log file with zip or gzip.</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li>
|
||||
<p>Open a new github issue at
|
||||
<a href="https://github.com/Klipper3d/klipper/issues"><a href="https://github.com/Klipper3d/klipper/issues">https://github.com/Klipper3d/klipper/issues</a></a>
|
||||
and provide a clear description of the problem. The Klipper
|
||||
developers need to understand what steps were taken, what the
|
||||
desired outcome was, and what outcome actually occurred. The
|
||||
Klipper log file <strong>must be attached</strong> to that ticket:</p>
|
||||
<p><img alt="attach-issue" src="img/attach-issue.png" /></p>
|
||||
</li>
|
||||
<li>Open a new topic on the <a href="#community-forum">Klipper Community 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
|
||||
compressed Klipper log file should be attached to that topic.</li>
|
||||
</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">¶</a></h2>
|
||||
<p>Klipper is open-source software and we appreciate new contributions.</p>
|
||||
@@ -1507,10 +1507,15 @@ for important information.</p>
|
||||
<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>. If you would like to
|
||||
provide an update on your current progress then you can open a Github
|
||||
issue with the location of your code, an overview of the changes, and
|
||||
a description of its current status.</p>
|
||||
<a href="#discord-chat">Klipper Community Discord</a>.</p>
|
||||
<h2 id="klipper-github">Klipper github<a class="headerlink" href="#klipper-github" title="Permanent link">¶</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>
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
Reference in New Issue
Block a user