Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation for the observability:enableComparisonByDefault setting #161372

Merged
merged 5 commits into from
Jul 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/management/advanced-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -598,4 +598,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.
3 changes: 2 additions & 1 deletion x-pack/plugins/observability/server/ui_settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the key has not been changed, the translation might not be updated in main (discussion)

Also, for the previous releases, since the translation is already done, there are basically two options:

  • Removing the translation and, as a result, showing the English version by default
  • Keep the current translation if it is OK to have different messages in different languages

Is the second option what you want?

'Determines whether the comparison feature is enabled or disabled by default in the APM app.',
}),
schema: schema.boolean(),
},
Expand Down