docs/handbook/bug_reports/making_good_bug_reports/collect_system_information.md

@@ -0,0 +1,15 @@
+# Manually Collecting System Information 
+
+When reporting a bug you will be asked to provide some system information
+and your Blender version number. This information can be automatically
+collected and filled out by selecteing `Help > Report a bug` from the
+top of Blender. Or selecting `Report a bug` on the add-on you want
+to report a bug on.
+
+However, sometimes Blender won't open, so you can't use these features.
+In which case you will need to collect the information manually.
+To do that, check the guide for your operating system below.
+
+- [Windows](windows_information.md)
+- [macOS](macos_information.md)
+- [Linux](linux_information.md)

docs/handbook/bug_reports/making_good_bug_reports/index.md

@@ -49,8 +49,8 @@ Or, if this is a bug in an Addon, use the corresponding button in the
 
 ![](../../../images/BugReport-blender-addon.png)
 
-Alternatively, you can also do this from within Gitea (without the
-relevant information pre-filled though)
+Alternatively, you can also do this from within Gitea, but you'll need
+to fill out system information [manually](./collect_system_information.md).
 
 Click the `New Issue` button in the corresponding repository:
 

docs/handbook/bug_reports/making_good_bug_reports/linux_information.md

@@ -0,0 +1,93 @@
+# Linux System Information 
+
+## Operating System
+
+We need to collect a few pieces of information for the Operating System information
+field. They are the Linux kernel version, CPU architecture, glibc version,
+and display server type.
+
+Follow the steps below to collect the information and combine them together
+in the bug report form like this:
+`Linux-6.8.0-31-generic - x86_64 - glibc2.39 - wayland`
+
+#### Linux Kernel Version
+
+Run `uname -r` in a terminal.
+
+![](./images/linux_get_os_info_kernel.jpg)
+
+#### CPU Architecture
+
+Run `lscpu | grep Architecture` in a terminal.
+
+![](./images/linux_get_os_info_architecture.jpg)
+
+#### glibc
+
+Run `ldd --version` in a terminal and extract the glibc version from the
+first line of the output.
+
+![](./images/linux_get_os_info_glibc.jpg)
+
+#### Display Server
+
+Run `echo $XDG_SESSION_TYPE` in a terminal.
+
+![](./images/linux_get_os_info_display_server.jpg)
+
+## Graphics Card
+
+There are two main ways we recommend to collect GPU information on Linux. 
+`glxinfo`, or `lspci` if `glxinfo` isn't avaliable.
+
+[comment]: <> (Use `vulkaninfo` instead of glxinfo once Blender uses Vulkan)
+
+#### glxinfo
+
+Run `glxinfo -B` in a terminal (you may need to install glxinfo from your
+package manager). This will provide you with the GPU name, driver type, and
+driver version of the display GPU (the GPU usually used by Blender).
+Combine these details together and include them on your bug report form like this:
+`AMD Radeon RX 7800XT - Mesa 24.1.0-devel`
+
+![](./images/linux_get_gpu_info_glxinfo.jpg)
+
+#### lspci
+
+Run `lspci -k | grep -EA3 'VGA|3D|Display` in a terminal.
+This will tell you which graphics cards you have. Copy the GPU name
+and include it on your bug report form like this: `AMD Radeon RX 7700 XT / 7800 XT`
+
+![](./images/linux_get_gpu_info_lspci.jpg)
+
+## Blender Version
+
+Follow one of the guides below to obtain Blender version information,
+The information we're intereted in are Blender version, commit date, hash,
+and branch *(Blender 4.2+)*. Collect this information and share it on your
+bug report form like this:
+`Blender 4.2.0 - branch: main - commit date: 2024-05-16 20:40 - hash: 1558bc7cb428`
+
+### Downloaded from Blender Website
+
+Run `/path/to/blender --verison` in a terminal. The Blender version information
+will be visible in the output.
+
+![](./images/linux_get_blender_version.jpg)
+
+### Downloaded from Steam
+
+Open Steam, right click on Blender and select the option
+`Manage > Browse local files`. A file browser will open displaying the path
+to where Blender is installed. Open a terminal and run
+`/path/to/blender --verison`. The Blender version information
+will be visible in the output.
+
+![](./images/linux_get_blender_version_steam.jpg)
+
+### Downloaded from snap
+
+Open a terminal and run `blender --version`. The Blender version information
+will be visible in the output.
+
+![](./images/linux_get_blender_version_snap.jpg)

docs/handbook/bug_reports/making_good_bug_reports/macos_information.md

@@ -0,0 +1,81 @@
+# macOS System Information 
+
+## Operating System
+
+Select from the top bar of macOS `Apple Icon > About This Mac`. Here you will find
+your macOS version beside the field `macOS`.
+
+Share the information on the report form like this: `macOS 14.4.1`
+
+![](./images/macOS_get_os_version.jpg)
+
+## Graphics Card
+
+Open Launchpad from the dock, then search for and open the `System Information`
+app. You will be find your graphics card information in the section
+`Hardware > Graphics/Display`. The information we're interested in is the
+`Chipset Model` and `Metal Support`.
+
+Combine these details together and share them in your bug report form
+like this: `Apple M1 Pro - Metal 3`
+
+![](./images/macOS_get_gpu_info.jpg)
+
+## Blender Version
+
+Follow one of the guides below to obtain your Blender version number, then
+share it on your bug reporting form.
+
+### Downloaded from Blender Website
+
+There are two main ways we recommend collecting Blender version.
+Through the command line, or through a GUI.
+
+#### Command Line
+
+Open a terminal and run the command `/path/to/blender --version`. In the output
+you will find the information we're interested in. They are Blender version,
+commit date, hash, and branch *(Blender 4.2+)*. Combine these details together
+and put them on your report form like this:
+`Blender 4.2.0 - branch: main - commit date: 2024-05-16 20:40 - hash: 1558bc7cb428`
+
+The path to Blender is typically `/Applications/Blender.app/Contents/MacOS/Blender`
+
+![](./images/macOS_get_blender_version_command_line.jpg)
+
+#### GUI
+
+Navigate to where Blender is installed and right click on it and select `Get Info`.
+You will find the Blender version number in the section `General > Version`. Share
+this information on your bug reporting form like this: `Blender 4.1.1 2024-04-16`
+
+![](./images/macOS_get_blender_version_gui.jpg)
+
+### Downloaded from Steam
+
+There are two main ways we recommend collecting Blender version.
+Through the command line, or through a GUI.
+
+#### Command Line
+
+Open Steam, right click on Blender and select the option
+`Manage > Browse local files`. Finder will open showing where
+Blender is installed. Right click on Blender and select `Show Package Contents`
+then navigate to the folder `/Contents/MacOS/`. Here you will find the Blender
+executable we want to run in a terminal with the `--version` launch argument.
+Like this: `/path/to/blender --version`. The output of the command will include the
+Blender version, commit date, hash, and branch *(Blender 4.2+)*. Combine these
+together and put them on your report form like this:
+`Blender 4.2.0 - branch: main - commit date: 2024-05-16 20:40 - hash: 1558bc7cb428`
+
+![](./images/macOS_get_blender_version_steam_command_line.jpg)
+
+#### GUI
+
+Open Steam, right click on Blender and select the option
+`Manage > Browse local files`. Finder will open showing where
+Blender is installed. Right click on Blender and select `Get Info`.
+You will find the Blender version number in the section `General > Version`. Share
+this information on your bug reporting form like this: `Blender 4.1.1 2024-04-16`
+
+![](./images/macOS_get_blender_version_steam_gui.jpg)

docs/handbook/bug_reports/making_good_bug_reports/windows_information.md

@@ -0,0 +1,107 @@
+# Windows System Information 
+
+## Operating System
+
+Click on the search icon on the task bar, then search for and open `dxdiag`.
+
+A DirectX Diagnostic Tool window will open. You will find the operating system
+version visible in the `System` tab. Copy it onto your bug report form like this:
+`Windows 11 Home 64-bit (10.0, Build 22631)`.
+
+![](./images/windows_get_os_version.jpg)
+
+## Graphics Card
+
+With `dxdiag`, navigate to the `Display` or `Render` tab and you will find
+the `Device name` and `Driver version` of your graphics card.
+
+Combine these details together and share them in your bug report form like this:
+`NVIDIA GeForce RTX 4090 - Driver 31.0.15.5186`
+
+![](./images/windows_get_gpu_info.jpg)
+
+## Blender Version
+
+Follow one of the guides below to obtain your Blender version number then
+share it on your bug reporting form.
+
+### Downloaded from Blender Website
+
+There are two main ways we recommend collecting Blender version. Through the
+command line, or through a GUI.
+
+#### Command line
+
+Open up a command prompt or terminal and run the command
+`/path/to/blender.exe --version`. You will find the Blender version,
+commit date, hash, and branch *(Blender 4.2+)*. Combine these details together
+and include them on your report form like this:
+`Blender 4.2.0 - branch: main - commit date: 2024-05-17 00:32 - hash: 05617ed07d2b`
+
+![](./images/windows_get_blender_version_command_line.jpg)
+
+#### GUI
+
+Navigate to where Blender is installed, right click on the file `blender.exe`
+and select the `Properties` option. In the new window that appears, select
+the `Details` tab and you will find the Blender version in the field
+called `File Version`. Include this on your bug report form like this:
+`Blender 4.1.1.0`
+
+![](./images/windows_get_blender_version_gui.jpg)
+
+### Downloaded from Steam
+
+There are two main ways we recommend collecting Blender version. Through the
+command line, or through a GUI.
+
+#### Command line
+
+Open Steam, right click on Blender and select the option
+`Manage > Browse local files`. A file browser will appear showing where
+Blender is installed. Knowing where Blender is now installed, open a command
+prompt or terminal and run the command `/path/to/blender.exe --version`
+You will find the Blender version, commit date, hash, and branch *(Blender 4.2+)*.
+Combine these details together and include them on your report form like this:
+`Blender 4.2.0 - branch: main - commit date: 2024-05-17 00:32 - hash: 05617ed07d2b`
+
+![](./images/windows_get_blender_version_steam_command_line.jpg)
+
+#### GUI
+
+Open Steam, right click on Blender and select the option
+`Manage > Browse local files`. A file browser will appear showing where
+Blender is installed. Right click on `blender.exe` and select
+the `Properties` option. In the new window that appears, select the `Details`
+tab and you will find the Blender version in the field called `File Version`.
+Include this on your bug report form like this: `Blender 4.1.1.0`
+
+![](./images/windows_get_blender_version_steam_gui.jpg)
+
+### Downloaded from Microsoft Store
+
+There are two main ways we recommend collecting Blender version. Through the
+command line, or through a GUI.
+
+#### Command line
+
+Open up a command prompt or terminal and run the command
+`/path/to/blender.exe --version`. You will find the Blender version,
+commit date, hash, and branch *(Blender 4.2+)*. Combine these details together
+and include them on your report form like this:
+`Blender 4.2.0 - branch: main - commit date: 2024-05-17 00:32 - hash: 05617ed07d2b`
+
+The path to Blender is usually:
+`C:\Program Files\WindowsApps\BlenderFoundation.EXTRA_DETAILS\Blender\blender.exe`
+
+![](./images/windows_get_blender_version_command_line.jpg)
+
+#### GUI
+
+Click on the Windows icon on the task bar and find Blender in your apps list.
+Once you've found it, right click on Blender and select `More > App Settings`.
+The settings app will open and you will find the Blender version in the section
+`Specifications` in the field `Version`. Include this on your bug report form
+like this: `Blender 4.1.1.0`
+
+![](./images/windows_get_blender_version_microsoft_store.jpg)