From cad06cbc764999322e7c3ca715833d3a30edd970 Mon Sep 17 00:00:00 2001
From: alfrix <alfredomonclus@gmail.com>
Date: Sat, 4 Nov 2023 15:36:45 -0300
Subject: [PATCH] docs: add an easier way to grab the system logs

---
 .github/ISSUE_TEMPLATE/bug_report.yml | 16 +++++++++++-----
 docs/Troubleshooting.md               | 17 +++++++++++++----
 2 files changed, 24 insertions(+), 9 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 79a53282..4b8a38a0 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -10,11 +10,6 @@ body:
 
         This is a bug report, If you need general support, please visit us on [Discord](https://discord.klipper3d.org/)
 
-        #### The LOG file is REQUIRED. Without the logfile your issue will be closed
-
-        if you need help to find the log file:
-        Read the [Documentation](https://klipperscreen.readthedocs.io/en/latest/Troubleshooting/)
-
         #### This is an Open Source project developed voluntarily, there are no Warranties, or ETA.
         [License](https://github.com/KlipperScreen/KlipperScreen/blob/master/LICENSE)
 
@@ -23,6 +18,7 @@ body:
     attributes:
       label: 'What happened?'
       description: A clear and concise description of what the bug is.
+      placeholder: Example: During a print i pressed pause and nothing happend
     validations:
       required: true
   - type: textarea
@@ -30,6 +26,7 @@ body:
     attributes:
       label: 'What did you expect to happen instead?'
       description: A clear and concise description of what you expected to happen instead.
+      placeholder: Example: The printer to pause.
     validations:
       required: true
   - type: textarea
@@ -37,6 +34,7 @@ body:
     attributes:
       label: 'How to reproduce this bug?'
       description: A clear and concise description with precise steps to reproduce this bug.
+      placeholder: Example: Press pause button and during printing.
     validations:
       required: true
   - type: textarea
@@ -44,11 +42,19 @@ body:
     attributes:
       label: 'Additional information:'
       description: Any additional info, screenshots or recordings which help to describe the issue.
+      placeholder: Example: hardware info or related printer config.
   - type: textarea
     id: logs
     attributes:
       label: Log output
       description: Please attach the FULL klipperscreen.log and if needed xorg.log or the tail of journalctl.
+      placeholder:  >-
+        #### The LOG file is REQUIRED. Without the logfile your issue will be closed
+
+        if you need help to find the log file:
+        Read the [Documentation](https://klipperscreen.readthedocs.io/en/latest/Troubleshooting/)
+        Use a Zip archive if needed
+
       render: shell
     validations:
       required: true
diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md
index fa70d2f0..77c13c23 100644
--- a/docs/Troubleshooting.md
+++ b/docs/Troubleshooting.md
@@ -21,20 +21,29 @@ Located at `~/printer_data/logs`or in `/tmp/` if the former doesn't exist.
 
 ## System logs
 
-If [KlipperScreen.log](#first-steps) doesn't exist:
+If [KlipperScreen.log](#first-steps) doesn't exist open a terminal in the host (typically from SSH) and
+copy all the relevant logs to the folder described above that can be seen and copied from the webui:
+
+```sh
+systemctl status KlipperScreen > ~/printer_data/logs/KliperScreen_systemctl.log
+journalctl -xe -u KlipperScreen > ~/printer_data/logs/KliperScreen_journalctl.log
+cp /var/log/Xorg.0.log ~/printer_data/logs/KliperScreen_Xorg.log
+```
+
+
+Alternatively you can inspect them directly on the terminal:
+
 ```sh
 systemctl status KlipperScreen
 ```
-or
 ```sh
 journalctl -xe -u KlipperScreen
 ```
-
-Also the Xorg log where you can find issues with the X server:
 ```sh
 cat /var/log/Xorg.0.log
 ```
 
+
 ## Screen shows console instead of KlipperScreen
 
 ![boot](img/troubleshooting/boot.png)