Clarify documentation for the observability:enableComparisonByDefault setting
#161372
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…t` setting The previous description > Enables the comparison feature in the APM app. makes it sound like the entire feature would be disabled when setting the option to false.
|
Pinging @elastic/apm-ui (Team:APM) |
|
Documentation preview: |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
not sure how this sunk in 🤔
|
Mind if I push an update to this PR? The settings definitions in the docs should match what we show in the UI. To do that, we'll need to update this line as well: |
bmorelli25
added
release_note:skip
|
Sure, feel free to push any updates directly to the PR. Thanks! |
bmorelli25
approved these changes
Jul 6, 2023
💚 Build Succeeded
Metrics [docs]Unknown metric groupsESLint disabled line counts
Total ESLint disabled count
To update your PR or re-run it, just comment with: |
dgieselaar
approved these changes
Jul 7, 2023
maryam-saeidi
approved these changes
Jul 7, 2023
| @@ -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: | |||
There was a problem hiding this comment.
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?
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jul 7, 2023
…t` setting (elastic#161372) The previous description > Enables the comparison feature in the APM app. makes it sound like the entire feature would be disabled when setting the option to false. (cherry picked from commit 5c0f034)
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Jul 7, 2023
…Default` setting (#161372) (#161433) # Backport This will backport the following commits from `main` to `8.9`: - [Clarify documentation for the `observability:enableComparisonByDefault` setting (#161372)](#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":"[email protected]"},"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 <[email protected]>
This was referenced Jul 7, 2023
|
Tested on 
|
gbamparop
added
the
apm:test-plan-done
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The previous description
makes it sound like the entire feature would be disabled when setting the option to false.