Updating deprecation message wording based on docs team feedback #79387
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
elasticmachine
added
the
Team:Data Management
|
Pinging @elastic/es-data-management (Team:Data Management) |
|
@elasticmachine update branch |
|
@elasticmachine update branch |
masseyke
added a commit
to masseyke/elasticsearch
that referenced
this pull request
Nov 1, 2021
…ding and URLs as a follow-up to elastic#79387
masseyke
added a commit
that referenced
this pull request
Nov 3, 2021
This commit includes more updates to deprecation info API message wording and URLs as a follow-up to #79387.
droberts195
added a commit
to droberts195/elasticsearch
that referenced
this pull request
Nov 25, 2021
This is a followup to elastic#81039. The same requirement to tolerate model snapshots back to 6.4.0 that applies to the job opening code also applies to the deprecation checker. Again, we tell the user that 7.0.0 is the model snapshot version we support, but we actually have to support versions going back to 6.4.0 because we didn't update the constant in the C++ in 7.0.0. Additionally, the wording of the ML deprecation messages is very slightly updated. The messages are different in the 7.16 branch, where they were updated by elastic#79387. This wording is copied forward to master, but with the tiny change that "Snapshot" is changed to "Model snapshot" in one place. This should make it clearer for users that we're talking about ML model snapshots and not cluster snapshots (which are completely different things). Another reason to change the wording is that the UI is looking for the pattern /[Mm]odel snapshot/ to decide when to display the "Fix" button for upgrading ML model snapshots - see elastic/kibana#119745.
droberts195
added a commit
to elastic/kibana
that referenced
this pull request
Nov 29, 2021
…upgrade (#119745) The deprecations for ML snapshots that are too old and need upgrading are supposed to have a "Fix" button next to them. Unfortunately this disappeared when a message was reworded in elastic/elasticsearch#79387. This change adjusts the regex that the upgrade assistant uses to detect which deprecations to add the "Fix" button to so that it will match both "Model snapshot" and "model snapshot". The test data is also updated to match the new backend text. This change is designed to work with elastic/elasticsearch#81060.
droberts195
added a commit
that referenced
this pull request
Nov 29, 2021
…#81060) This is a followup to #81039. The same requirement to tolerate model snapshots back to 6.4.0 that applies to the job opening code also applies to the deprecation checker. Again, we tell the user that 7.0.0 is the model snapshot version we support, but we actually have to support versions going back to 6.4.0 because we didn't update the constant in the C++ in 7.0.0. Additionally, the wording of the ML deprecation messages is very slightly updated. The messages are different in the 7.16 branch, where they were updated by #79387. This wording is copied forward to master, but with the tiny change that "Snapshot" is changed to "Model snapshot" in one place. This should make it clearer for users that we're talking about ML model snapshots and not cluster snapshots (which are completely different things). Another reason to change the wording is that the UI is looking for the pattern /[Mm]odel snapshot/ to decide when to display the "Fix" button for upgrading ML model snapshots - see elastic/kibana#119745.
droberts195
added a commit
to droberts195/elasticsearch
that referenced
this pull request
Nov 29, 2021
…elastic#81060) This is a followup to elastic#81039. The same requirement to tolerate model snapshots back to 6.4.0 that applies to the job opening code also applies to the deprecation checker. Again, we tell the user that 7.0.0 is the model snapshot version we support, but we actually have to support versions going back to 6.4.0 because we didn't update the constant in the C++ in 7.0.0. Additionally, the wording of the ML deprecation messages is very slightly updated. The messages are different in the 7.16 branch, where they were updated by elastic#79387. This wording is copied forward to master, but with the tiny change that "Snapshot" is changed to "Model snapshot" in one place. This should make it clearer for users that we're talking about ML model snapshots and not cluster snapshots (which are completely different things). Another reason to change the wording is that the UI is looking for the pattern /[Mm]odel snapshot/ to decide when to display the "Fix" button for upgrading ML model snapshots - see elastic/kibana#119745.
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Nov 29, 2021
…upgrade (elastic#119745) The deprecations for ML snapshots that are too old and need upgrading are supposed to have a "Fix" button next to them. Unfortunately this disappeared when a message was reworded in elastic/elasticsearch#79387. This change adjusts the regex that the upgrade assistant uses to detect which deprecations to add the "Fix" button to so that it will match both "Model snapshot" and "model snapshot". The test data is also updated to match the new backend text. This change is designed to work with elastic/elasticsearch#81060.
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Nov 29, 2021
…upgrade (elastic#119745) The deprecations for ML snapshots that are too old and need upgrading are supposed to have a "Fix" button next to them. Unfortunately this disappeared when a message was reworded in elastic/elasticsearch#79387. This change adjusts the regex that the upgrade assistant uses to detect which deprecations to add the "Fix" button to so that it will match both "Model snapshot" and "model snapshot". The test data is also updated to match the new backend text. This change is designed to work with elastic/elasticsearch#81060.
droberts195
added a commit
to droberts195/elasticsearch
that referenced
this pull request
Nov 29, 2021
…checker This is a followup to elastic#81039. The same requirement to tolerate model snapshots back to 6.4.0 that applies to the job opening code also applies to the deprecation checker. Again, we tell the user that 7.0.0 is the model snapshot version we support, but we actually have to support versions going back to 6.4.0 because we didn't update the constant in the C++ in 7.0.0. Additionally, the wording of the ML deprecation messages is very slightly updated. The messages are different in the 7.16 branch, where they were updated by elastic#79387. This wording is copied forward to master, but with the tiny change that "Snapshot" is changed to "Model snapshot" in one place. This should make it clearer for users that we're talking about ML model snapshots and not cluster snapshots (which are completely different things). Another reason to change the wording is that the UI is looking for the pattern /[Mm]odel snapshot/ to decide when to display the "Fix" button for upgrading ML model snapshots - see elastic/kibana#119745. Backport of elastic#81060
elasticsearchmachine
pushed a commit
that referenced
this pull request
Nov 29, 2021
…#81060) (#81101) This is a followup to #81039. The same requirement to tolerate model snapshots back to 6.4.0 that applies to the job opening code also applies to the deprecation checker. Again, we tell the user that 7.0.0 is the model snapshot version we support, but we actually have to support versions going back to 6.4.0 because we didn't update the constant in the C++ in 7.0.0. Additionally, the wording of the ML deprecation messages is very slightly updated. The messages are different in the 7.16 branch, where they were updated by #79387. This wording is copied forward to master, but with the tiny change that "Snapshot" is changed to "Model snapshot" in one place. This should make it clearer for users that we're talking about ML model snapshots and not cluster snapshots (which are completely different things). Another reason to change the wording is that the UI is looking for the pattern /[Mm]odel snapshot/ to decide when to display the "Fix" button for upgrading ML model snapshots - see elastic/kibana#119745.
droberts195
added a commit
to droberts195/elasticsearch
that referenced
this pull request
Nov 29, 2021
This is a fix to the fix of elastic#81060. In the original fix where I tried to port the changes from elastic#79387 to master I didn't notice that the text of the message and detail of the deprecation had been largely switched around. My tweaks to the wording in elastic#81060 did not make this major switch. This PR switches the two strings we generate.
kibanamachine
added a commit
to elastic/kibana
that referenced
this pull request
Nov 29, 2021
…upgrade (#119745) (#119850) The deprecations for ML snapshots that are too old and need upgrading are supposed to have a "Fix" button next to them. Unfortunately this disappeared when a message was reworded in elastic/elasticsearch#79387. This change adjusts the regex that the upgrade assistant uses to detect which deprecations to add the "Fix" button to so that it will match both "Model snapshot" and "model snapshot". The test data is also updated to match the new backend text. This change is designed to work with elastic/elasticsearch#81060. Co-authored-by: David Roberts <dave.roberts@elastic.co>
kibanamachine
added a commit
to elastic/kibana
that referenced
this pull request
Nov 29, 2021
…upgrade (#119745) (#119851) The deprecations for ML snapshots that are too old and need upgrading are supposed to have a "Fix" button next to them. Unfortunately this disappeared when a message was reworded in elastic/elasticsearch#79387. This change adjusts the regex that the upgrade assistant uses to detect which deprecations to add the "Fix" button to so that it will match both "Model snapshot" and "model snapshot". The test data is also updated to match the new backend text. This change is designed to work with elastic/elasticsearch#81060. Co-authored-by: David Roberts <dave.roberts@elastic.co>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Nov 29, 2021
…checker (#81105) This is a followup to #81039. The same requirement to tolerate model snapshots back to 6.4.0 that applies to the job opening code also applies to the deprecation checker. Again, we tell the user that 7.0.0 is the model snapshot version we support, but we actually have to support versions going back to 6.4.0 because we didn't update the constant in the C++ in 7.0.0. Additionally, the wording of the ML deprecation messages is very slightly updated. The messages are different in the 7.16 branch, where they were updated by #79387. This wording is copied forward to master, but with the tiny change that "Snapshot" is changed to "Model snapshot" in one place. This should make it clearer for users that we're talking about ML model snapshots and not cluster snapshots (which are completely different things). Another reason to change the wording is that the UI is looking for the pattern /[Mm]odel snapshot/ to decide when to display the "Fix" button for upgrading ML model snapshots - see elastic/kibana#119745. Backport of #81060
elasticsearchmachine
pushed a commit
that referenced
this pull request
Nov 29, 2021
This is a fix to the fix of #81060. In the original fix where I tried to port the changes from #79387 to master I didn't notice that the text of the message and detail of the deprecation had been largely switched around. My tweaks to the wording in #81060 did not make this major switch. This PR switches the two strings we generate. This is only for 8.0 and 8.1. For 7.16 the discrepancy became obvious in the backport of #81060 to that branch, so it's already correct there.
droberts195
added a commit
to droberts195/elasticsearch
that referenced
this pull request
Nov 29, 2021
…ic#81108) This is a fix to the fix of elastic#81060. In the original fix where I tried to port the changes from elastic#79387 to master I didn't notice that the text of the message and detail of the deprecation had been largely switched around. My tweaks to the wording in elastic#81060 did not make this major switch. This PR switches the two strings we generate. This is only for 8.0 and 8.1. For 7.16 the discrepancy became obvious in the backport of elastic#81060 to that branch, so it's already correct there.
elasticsearchmachine
pushed a commit
that referenced
this pull request
Nov 29, 2021
… (#81114) This is a fix to the fix of #81060. In the original fix where I tried to port the changes from #79387 to master I didn't notice that the text of the message and detail of the deprecation had been largely switched around. My tweaks to the wording in #81060 did not make this major switch. This PR switches the two strings we generate. This is only for 8.0 and 8.1. For 7.16 the discrepancy became obvious in the backport of #81060 to that branch, so it's already correct there.
TinLe
pushed a commit
to TinLe/kibana
that referenced
this pull request
Dec 22, 2021
…upgrade (elastic#119745) The deprecations for ML snapshots that are too old and need upgrading are supposed to have a "Fix" button next to them. Unfortunately this disappeared when a message was reworded in elastic/elasticsearch#79387. This change adjusts the regex that the upgrade assistant uses to detect which deprecations to add the "Fix" button to so that it will match both "Model snapshot" and "model snapshot". The test data is also updated to match the new backend text. This change is designed to work with elastic/elasticsearch#81060.
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.
This commit updates deprecation info API wording based on feedback from the docs team.