From 1de24626fab3e561c912aa8b16651de187538c2b Mon Sep 17 00:00:00 2001 From: Bruno Garcia Date: Thu, 5 Dec 2024 23:55:48 -0300 Subject: [PATCH 1/2] unreal: Improve environment doc --- .../unreal/configuration/environments.mdx | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/platforms/unreal/configuration/environments.mdx b/docs/platforms/unreal/configuration/environments.mdx index f531dd4c1e68e..38eaba23d8e2e 100644 --- a/docs/platforms/unreal/configuration/environments.mdx +++ b/docs/platforms/unreal/configuration/environments.mdx @@ -4,14 +4,14 @@ description: "Learn how to configure your SDK to tell Sentry about your environm sidebar_order: 30 --- -Environments tell you where an error occurred, whether that's in your production system, your staging server, or elsewhere. -It help you better filter issues, releases, and user feedback in the Issue Details page of sentry.io, which you learn more about in our [documentation that covers using environments](/product/sentry-basics/environments/). +Environments in Sentry let you know where an error occurred, (such as in production, staging server, or another location). +They make it easier to filter issues, releases, and user feedback on the Issue Details page, (which you can navigate to by clicking any issue on the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page). To learn more, read our docs about [using environments](/product/sentry-basics/environments/). Sentry automatically creates an environment when it receives an event with the `environment` parameter set. -By default, the SDK reports `Editor` when running inside the Unreal Engine Editor. -For shipping builds it'll use `Release` and in other configurations it'll use `FApp::GetBuildConfiguration()` -You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration or override the environment value programatically. +When running inside the Unreal Engine Editor, the SDK reports the environment as `Editor`. For shipping builds, it defaults to `Release`. +In other configurations it uses the `FApp::GetBuildConfiguration()`. +You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration, or override it programmatically. ```cpp FConfigureSettingsDelegate SettingsDelegate; @@ -29,4 +29,11 @@ USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystemInitializeWithSettings(SettingsDelegate); ``` -Environments are case-sensitive. The environment name can't contain newlines, spaces or forward slashes, can't be the string "None", or exceed 64 characters. You can't delete environments, but you can [hide](/product/sentry-basics/environments/#hidden-environments) them. +**Important things to note about environments:** + + - Environment names are case-sensitive. + - Names cannot include new lines, spaces, or forward slashes. + - Certain strings, like "None", aren't allowed. + - The maximum length for an environment name is 64 characters. + - Environments can't be deleted, but can be [hidden](/product/sentry-basics/environments/#hidden-environments) if no longer needed. + From fd6fb55c2120d42e38173c1e911ef25a6d4e507a Mon Sep 17 00:00:00 2001 From: Bruno Garcia Date: Thu, 5 Dec 2024 23:56:49 -0300 Subject: [PATCH 2/2] Update docs/platforms/unreal/configuration/environments.mdx --- docs/platforms/unreal/configuration/environments.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/platforms/unreal/configuration/environments.mdx b/docs/platforms/unreal/configuration/environments.mdx index 38eaba23d8e2e..b9d9a03caed06 100644 --- a/docs/platforms/unreal/configuration/environments.mdx +++ b/docs/platforms/unreal/configuration/environments.mdx @@ -30,10 +30,10 @@ SentrySubsystem->InitializeWithSettings(SettingsDelegate); ``` **Important things to note about environments:** - - - Environment names are case-sensitive. - - Names cannot include new lines, spaces, or forward slashes. - - Certain strings, like "None", aren't allowed. - - The maximum length for an environment name is 64 characters. - - Environments can't be deleted, but can be [hidden](/product/sentry-basics/environments/#hidden-environments) if no longer needed. + + - Environment names are case-sensitive. + - Names cannot include new lines, spaces, or forward slashes. + - Certain strings, like "None", aren't allowed. + - The maximum length for an environment name is 64 characters. + - Environments can't be deleted, but can be [hidden](/product/sentry-basics/environments/#hidden-environments) if no longer needed.