From 4d61895caf8052029f829909dcfecaa8af79930e Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Thu, 11 Aug 2022 13:55:36 -0400 Subject: [PATCH] Moved & Formatted Reporting --- README.md | 22 ++------------ docs/Report.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+), 19 deletions(-) create mode 100644 docs/Report.md diff --git a/README.md b/README.md index eef0a49414..4aef5d600e 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,7 @@ [![Button Plugins]][Plugins]    [![Button Machines]][Machines] +[![Button Report]][Report]    [![Button Settings]][Settings]    [![Button Localize]][Localize] @@ -44,30 +45,11 @@ -
-
- -## Logging Issues - -For crashes and similar issues, please attach the following information: - -* (On Windows) The log as produced by dxdiag (start -> run -> dxdiag -> save output) -* The Cura GUI log file, located at - * `%APPDATA%\cura\\cura.log` (Windows), or usually `C:\Users\\AppData\Roaming\cura\\cura.log` - * `$HOME/Library/Application Support/cura//cura.log` (OSX) - * `$HOME/.local/share/cura//cura.log` (Ubuntu/Linux) - -If the Cura user interface still starts, you can also reach this directory from the application menu in Help -> Show settings folder. -An alternative is to install the [ExtensiveSupportLogging Plugin] -this creates a zip folder of the relevant log files. If you're experiencing performance issues, we might ask you to connect the CPU profiler -in this plugin and attach the collected data to your support ticket. -
-[ExtensiveSupportLogging Plugin]: https://marketplace.ultimaker.com/app/cura/plugins/UltimakerPackages/ExtensiveSupportLogging [Contributors]: https://github.com/Ultimaker/Cura/graphs/contributors [PullRequests]: https://github.com/Ultimaker/Cura/pulls [Machines]: https://github.com/Ultimaker/Cura/wiki/Adding-new-machine-profiles-to-Cura @@ -82,6 +64,7 @@ in this plugin and attach the collected data to your support ticket. [Showcase]: cura-logo.PNG [License]: LICENSE +[Report]: docs/Report.md [Logo]: resources/images/cura-icon.png [#]: # @@ -105,5 +88,6 @@ in this plugin and attach the collected data to your support ticket. [Button Settings]: https://img.shields.io/badge/Configuration-00979D?style=for-the-badge&logoColor=white&logo=CodeReview [Button Building]: https://img.shields.io/badge/Building_Cura-blue?style=for-the-badge&logoColor=white&logo=GitBook [Button Plugins]: https://img.shields.io/badge/Plugin_Usage-569A31?style=for-the-badge&logoColor=white&logo=ROS +[Button Report]: https://img.shields.io/badge/Report_Issues-C9284D?style=for-the-badge&logoColor=white&logo=Cliqz diff --git a/docs/Report.md b/docs/Report.md new file mode 100644 index 0000000000..8b24903878 --- /dev/null +++ b/docs/Report.md @@ -0,0 +1,81 @@ + +# Reporting Issues + +Please attach the following information in case
+you want to report crashing or similar issues. + +
+ +## DxDiag + +### ![Badge Windows] + +The log as produced by **dxdiag**. + +  start    »    run    »    dxdiag    »    save output   + +
+
+ +## Cura GUI Log + +If the Cura user interface still starts, you can also
+reach these directories from the application menu: + +  Help    »    Show settings folder   + +
+ +### ![Badge Windows] + +``` +%APPDATA%\cura\<Cura Version>\cura.log +``` + +or + +``` +C:\Users\\AppData\Roaming\cura\<Cura Version>\cura.log +``` + +
+ +### ![Badge Linux] + +``` +~/.local/share/cura/<Cura Version>/cura.log +``` + +
+ +### ![Badge MacOS] + +``` +~/Library/Application Support/cura/<Cura Version>/cura.log +``` + +
+
+ +## Alternative + +An alternative is to install the **[ExtensiveSupportLogging]**
+plugin this creates a zip folder of the relevant log files. + +If you're experiencing performance issues, we might ask
+you to connect the CPU profiler in this plugin and attach
+the collected data to your support ticket. + +
+ + + + +[ExtensiveSupportLogging]: https://marketplace.ultimaker.com/app/cura/plugins/UltimakerPackages/ExtensiveSupportLogging + + + + +[Badge Windows]: https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logoColor=white&logo=Windows +[Badge Linux]: https://img.shields.io/badge/Linux-00A95C?style=for-the-badge&logoColor=white&logo=Linux +[Badge MacOS]: https://img.shields.io/badge/MacOS-403C3D?style=for-the-badge&logoColor=white&logo=MacOS