Explorar o código

Added information about logs files

Björn Ritzl %!s(int64=5) %!d(string=hai) anos
pai
achega
187e814825
Modificáronse 1 ficheiros con 32 adicións e 17 borrados
  1. 32 17
      docs/en/manuals/getting-help.md

+ 32 - 17
docs/en/manuals/getting-help.md

@@ -28,23 +28,10 @@ A good way to discuss and get help with a problem is to post a question on our [
   - OS: [e.g. iOS8.1, Windows 10, High Sierra]
   - Device: [e.g. iPhone6]
 
-* **Logs (OPTIONAL)** - Please include any relevant logs (engine and/or editor). Editor logs are located here:
-  - Windows: `C:\Users\ **Your Username** \AppData\Local\Defold`
-  - macOS: `/Users/ **Your Username** /Library/Application Support/` or `~/Library/Application Support/Defold`
-  - Linux: `~/.Defold`
+* **System details (OPTIONAL)** - Additional systems details about the platform where the problem happens.
+  - HTML5: Provide information about WebGL from websites such as https://webglreport.com/?v=1
 
-  Engine logs for Android can be accessed using the `adb` command line tool (Android Debug Bridge). Read more about the `adb` command line tool in the [Android manual](/manuals/android/#android-debug-bridge).
-
-  Engine logs for iOS can be accessed using XCode and the Devices and Simulators menu option.
-
-  Engine logs for HTML5 builds can be viewed in the browser developer console:
-  - Chrome: Menu > More Tools > Developer Tools
-  - Firefox: Tools > Web Developer > Web Console
-  - Safari: Develop > Show JavaScript Console
-
-  Engine logs for desktop builds can be viewed by running the Defold application from a terminal/command prompt.
-
-  You can also write engine logs to a file and access this once the application has been shut down. You can read more about how to enable and access the log in the [Debugging manual](/manuals/debugging/#extracting-the-logtxt-file).
+* **Logs (OPTIONAL)** - Please include any relevant logs (build server, engine and editor). Refer to [the section below on how to extract log files](#log-files).
 
 * **Minimal repro case project (OPTIONAL)** - Please attach a minimal project where the bug is reproduced. This will greatly help the person trying to investigate and fix the bug. If you share the project as a zip file make sure to exclude the `.git`, `.internal` and `build` folders from the archive.
 
@@ -61,9 +48,37 @@ The editor provides a convenient way to report issues. Select the <kbd>Help->Rep
 
 ![](images/getting_help/report_issue.png)
 
-Selecting this menu option will bring you to an issue tracker on GitHub. Please fill out the form and include as much information as possible. Note that you need a GitHub account to submit a bug report this way.
+Selecting this menu option will bring you to an issue tracker on GitHub. Please fill out the form and include as much information as possible. Refer to [the section below on how to extract log files](#log-files).
+
+::: sidenote
+You need a GitHub account to submit a bug report this way.
+:::
 
 
 ## Discuss a problem on Slack
 
 If you run into a problem while using Defold you can try to ask the question on [Slack](https://www.defold.com/slack/). We do however recommend that complex questions and in-depth discussions are posted on the forum. Also note that we do not accept bug reports submitted through Slack.
+
+
+# Log files
+
+The engine, editor and build server generates logging information that can be very valuable when asking for help and debugging an issue. Always provide log files when reporting a problem.
+
+## Engine logs
+- Android: Logs can be accessed using the `adb` command line tool (Android Debug Bridge). Read more about the `adb` command line tool in the [Android manual](/manuals/android/#android-debug-bridge).
+- iOS: Logs can be accessed using XCode and the Devices and Simulators menu option.
+- HTML5: Logs can be viewed in the browser developer console:
+  - Chrome: Menu > More Tools > Developer Tools
+  - Firefox: Tools > Web Developer > Web Console
+  - Safari: Develop > Show JavaScript Console
+- Desktop: Logs for desktop builds can be viewed by running the Defold application from a terminal/command prompt.
+
+You can also write engine logs to a file and access this once the application has been shut down. You can read more about how to enable and access the log in the [Debugging manual](/manuals/debugging/#extracting-the-logtxt-file).
+
+## Editor logs
+- Windows: `C:\Users\ **Your Username** \AppData\Local\Defold`
+- macOS: `/Users/ **Your Username** /Library/Application Support/` or `~/Library/Application Support/Defold`
+- Linux: `~/.Defold`
+
+## Build server logs
+Build server logs are available when the project is using native extensions. The build server log (`log.txt`) is downloaded together with the custom engine when the project is built and stored inside the file `.internal/%platform%/build.zip`.