[8.9] Clarify documentation for the observability:enableComparisonByDefault setting (#161372) (#161433)

# Backport

This will backport the following commits from `main` to `8.9`:
- [Clarify documentation for the
`observability:enableComparisonByDefault` setting
(#161372)](https://github.com/elastic/kibana/pull/161372)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Felix
Barnsteiner","email":"felixbarny@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-07-07T07:52:47Z","message":"Clarify
documentation for the `observability:enableComparisonByDefault` setting
(#161372)\n\nThe previous description\r\n> Enables the comparison
feature in the APM app.\r\n\r\nmakes it sound like the entire feature
would be disabled when setting\r\nthe option to
false.","sha":"5c0f034e7517898f25f664ebc9d7c31f5b3d33ad","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:APM","release_note:skip","docs","v8.9.0","v8.10.0","v8.8.3"],"number":161372,"url":"https://github.com/elastic/kibana/pull/161372","mergeCommit":{"message":"Clarify
documentation for the `observability:enableComparisonByDefault` setting
(#161372)\n\nThe previous description\r\n> Enables the comparison
feature in the APM app.\r\n\r\nmakes it sound like the entire feature
would be disabled when setting\r\nthe option to
false.","sha":"5c0f034e7517898f25f664ebc9d7c31f5b3d33ad"}},"sourceBranch":"main","suggestedTargetBranches":["8.9","8.8"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/161372","number":161372,"mergeCommit":{"message":"Clarify
documentation for the `observability:enableComparisonByDefault` setting
(#161372)\n\nThe previous description\r\n> Enables the comparison
feature in the APM app.\r\n\r\nmakes it sound like the entire feature
would be disabled when setting\r\nthe option to
false.","sha":"5c0f034e7517898f25f664ebc9d7c31f5b3d33ad"}},{"branch":"8.8","label":"v8.8.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Felix Barnsteiner <felixbarny@users.noreply.github.com>
This commit is contained in:
Kibana Machine 2023-07-07 05:05:43 -04:00 committed by GitHub
parent 843d2c6167
commit aa4d2ca195
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 3 deletions

View file

@ -408,7 +408,7 @@ preview:[] Sorts services without anomaly detection rules on the APM Service inv
preview:[] Display Amazon Lambda metrics in the service metrics tab.
[[observability-apm-enable-comparison]]`observability:enableComparisonByDefault`::
Enables the comparison feature in the APM app.
Determines whether the <<service-time-comparison, comparison feature>> is enabled or disabled by default in the APM app.
[[observability-apm-enable-infra-view]]`observability:enableInfrastructureView`::
Enables the Infrastructure view in the APM app.
@ -597,4 +597,4 @@ The URL of a custom PNG image that appears on {kib} browser tabs.
[[provide-usage-data]]`telemetry:enabled`::
Enabling data usage collection (also known as Telemetry) allows us to learn
what our users are most interested in, so we can improve our products and services.
Refer to our https://www.elastic.co/legal/product-privacy-statement[Privacy Statement] for more details.
Refer to our https://www.elastic.co/legal/product-privacy-statement[Privacy Statement] for more details.

View file

@ -76,7 +76,8 @@ export const uiSettings: Record<string, UiSettings> = {
}),
value: true,
description: i18n.translate('xpack.observability.enableComparisonByDefaultDescription', {
defaultMessage: 'Enable the comparison feature in APM app',
defaultMessage:
'Determines whether the comparison feature is enabled or disabled by default in the APM app.',
}),
schema: schema.boolean(),
},