Unreal Engine plugin documentation update (#6350)

tustanivsky · web-flow · commit e8eb8638fbdd · 2023-03-09T15:35:54.000+01:00
diff --git a/src/platform-includes/capture-message/unreal.mdx b/src/platform-includes/capture-message/unreal.mdx
@@ -31,7 +31,7 @@ The same result can be achieved by calling corresponding functions in blueprint:
 
 <Note>
 
-Scoped message capturing is supported only on iOS and Android.
+Scoped message capturing is supported only on macOS, iOS and Android.
 
 </Note>
 
@@ -83,7 +83,7 @@ The same result can be achieved by calling corresponding functions in blueprint:
 
 <Note>
 
-Scoped events capturing is supported only on iOS and Android platforms.
+Scoped events capturing is supported only on macOS, iOS and Android platforms.
 
 </Note>
 
diff --git a/src/platform-includes/enriching-events/scopes/configure-scope/unreal.mdx b/src/platform-includes/enriching-events/scopes/configure-scope/unreal.mdx
@@ -21,7 +21,7 @@ SentrySubsystem->ConfigureScope(ScopeDelegate);
 
 <Note>
 
-`ConfigureScope` function is supported only on iOS and Android.
+`ConfigureScope` function is supported only on macOS, iOS and Android.
 
 </Note>
 
diff --git a/src/platform-includes/enriching-events/set-tag/unreal.mdx b/src/platform-includes/enriching-events/set-tag/unreal.mdx
@@ -9,3 +9,7 @@ The same result can be achieved by calling corresponding function in blueprint:
 ![Set tag](unreal_set_tag.png)
 
 Alternatively, this configuration cab be provided to the crash reporter [during initialization](/platforms/unreal/setup-crashreporter/#configure-attributes).
+
+Commonly used values including `Engine version`, `Configuration`, and `Target Type`, can be promoted to tags via Sentry's configuration window by navigating to the editor's menu **Project Settings > Plugins > Sentry > Misc > Promote values to tags** and selecting the values that should be automatically added to captured events as tags.
+
+![Configure default tags](unreal_tags_setting.png)
diff --git a/src/platform-includes/enriching-events/set-tag/unreal_tags_setting.png b/src/platform-includes/enriching-events/set-tag/unreal_tags_setting.png
diff --git a/src/platform-includes/enriching-events/user-feedback/sdk-api-example/unreal.mdx b/src/platform-includes/enriching-events/user-feedback/sdk-api-example/unreal.mdx
@@ -22,6 +22,6 @@ The same result can be achieved by calling corresponding functions in blueprint:
 
 <Note>
 
-User feedback capturing is supported only on iOS and Android.
+The ability to capture user feedback is only supported on macOS, iOS, and Android.
 
 </Note>
diff --git a/src/platform-includes/getting-started-config/unreal_window.png b/src/platform-includes/getting-started-config/unreal_window.png
diff --git a/src/platform-includes/getting-started-install/unreal.mdx b/src/platform-includes/getting-started-install/unreal.mdx
@@ -1,4 +1,4 @@
-The Unreal Engine (UE) SDK is currently compatible with **UE 4.26 or later** and supports **Windows**, **macOS**, **iOS**, and **Android**.
+The Unreal Engine (UE) SDK is currently compatible with **UE 4.27 or later** and supports **Windows**, **Linux**, **macOS**, **iOS**, and **Android**.
 
 To build the SDK, download the latest sources from the [Releases page](https://github.com/getsentry/sentry-unreal/releases) and place it in the project's `Plugins` directory. On the next project launch, UE will prompt to build Sentry module.
 
diff --git a/src/platform-includes/getting-started-primer/unreal.mdx b/src/platform-includes/getting-started-primer/unreal.mdx
@@ -11,12 +11,13 @@ This SDK is a preview that packages Sentry's native SDKs into an Unreal Engine p
 - Native support for automatic crash error tracking for
   - Android by using the [Android SDK](/platforms/android/) to support Java, Kotlin, C and C++
   - iOS by using the [iOS SDK](/platforms/apple/guides/ios/) to support Objective-C, Swift, C and C++
-  - Windows, Mac, and Linux by using the [Native SDK](/platforms/native/) to support C and C++ with minidumps
+  - Windows and Linux by using the [Native SDK](/platforms/native/) to support C and C++ with minidumps
+  - macOS by using the [macOS SDK](/platforms/apple/guides/macos/) to support Objective-C, Swift, C and C++
 - Compatible with Unreal Engine 5
 - [Crash Reporter Client](/platforms/unreal/setup-crashreporter/) provided along with Unreal Engine
 
 <Alert level="warning">
 
-In order to capture crashes on Windows and Mac automatically [Crash Reporter Client](/platforms/unreal/setup-crashreporter/) has to be configured.
+[Crash Reporter Client](/platforms/unreal/setup-crashreporter/) has to be configured in order to capture crashes on Windows automatically. This step isn't required starting with UE 5.2 because the engine provides an API, which allows you to switch between default and third-party crash-handling solutions.
 
 </Alert>
diff --git a/src/platforms/common/enriching-events/context.mdx b/src/platforms/common/enriching-events/context.mdx
@@ -55,6 +55,16 @@ The class must be serializable and only properties are included; fields are not.
 
 </PlatformSection>
 
+<PlatformSection supported={["unreal"]}>
+
+<Note>
+
+Sentry's SDK automatically attaches certain context values such as `Engine version`, `Configuration`, and `Target Type`, to name a few, to all events.
+
+</Note>
+
+</PlatformSection>
+
 There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally.
 
 Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/).
diff --git a/src/platforms/unreal/debug-symbols.mdx b/src/platforms/unreal/debug-symbols.mdx
@@ -0,0 +1,23 @@
+---
+title: Upload Debug Symbols
+description: "Learn how the Unreal Engine SDK handles debug symbols upload."
+---
+
+Sentry requires [debug information files](/platforms/unreal/data-management/debug-files/) to symbolicate crashes. The Unreal Engine SDK provides an automated upload functionality for those symbol files that rely on the [sentry-cli](/product/cli/). This is done automatically, so running the `sentry-cli` manually isn't required. The symbol upload happens during the execution of `PostBuildSteps`, as specified in the `Sentry.uplugin` file. The `sentry-cli` executables for Windows, macOS, and Linux are included as part of the Unreal Engine SDK package.
+
+<Note>
+
+For Android, debug symbols upload is handled by [Sentry Android Gradle Plugin](/platforms/android/gradle).
+
+</Note>
+
+The automated debug symbols upload is disabled by default and requires configuration. To configure it, navigate to **Project Settings > Plugins > Sentry**, then enter the [Auth Token](https://sentry.io/api/), Organization Slug, and Project Name. Note, that the Unreal Engine SDK automatically creates a `sentry.properties` file at the root of your project directory to store the configuration. This configuration file should **never** be made publicly available.
+
+![The UE4 debug symbols ppload configuration](unreal-debug-symbols.png)
+
+### Manual Upload Using sentry-cli
+
+To upload debug symbols to Sentry manually, run `sentry-cli` through the command line. You can either use the provided executables from within the package, or follow the [sentry-cli documentation](/product/cli/installation/) to make it available globally. To upload debug symbols run the following command:
+
+```bash
+sentry-cli --auth-token YOUR_AUTH_TOKEN upload-dif --org ___ORG_SLUG___ --project ___PROJECT_SLUG___ PATH_TO_SYMBOLS
diff --git a/src/platforms/unreal/setup-crashreporter.mdx b/src/platforms/unreal/setup-crashreporter.mdx
@@ -80,6 +80,14 @@ is enough.
 
 </Alert>
 
+Alternatively, the endpoint can be added automatically to the _DefaultEngine.ini_ file
+ by using the Sentry configuration window.
+
+ ![The UE4 Crash Reporter settings](ue4-crash-reporter-settings.png)
+
+Navigate to the editor's menu **Project Settings > Plugins > Sentry**, set the Sentry _Unreal Engine Endpoint_ in the corresponding input field, and click the **Update global settings** button to apply changes. The default endpoint value can be restored by clicking the **Reset** button once the _Crash Reporter_ is no longer needed.
+
+
 ## Configure the Crash Reporter Attributes {#configure-attributes}
 
 Basic attributes can be reconfigured by providing special game data to the
diff --git a/src/platforms/unreal/ue4-crash-reporter-settings.png b/src/platforms/unreal/ue4-crash-reporter-settings.png
diff --git a/src/platforms/unreal/unreal-debug-symbols.png b/src/platforms/unreal/unreal-debug-symbols.png

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-The Unreal Engine (UE) SDK is currently compatible with UE 4.26 or later and supports Windows, macOS, iOS, and Android.`
	`1`	`+The Unreal Engine (UE) SDK is currently compatible with UE 4.27 or later and supports Windows, Linux, macOS, iOS, and Android.`
`2`	`2`
`3`	`3`	To build the SDK, download the latest sources from the [Releases page](https://github.com/getsentry/sentry-unreal/releases) and place it in the project's `Plugins` directory. On the next project launch, UE will prompt to build Sentry module.
`4`	`4`