[Guided onboarding] Fix the missing help link#156399
Conversation
|
Pinging @elastic/platform-onboarding (Team:Journey/Onboarding) |
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]Unknown metric groupsESLint disabled line counts
Total ESLint disabled count
To update your PR or re-run it, just comment with: |
alisonelizabeth
left a comment
There was a problem hiding this comment.
Changes LGTM. Verified locally. Thanks for fixing this!
| "cloud", | ||
| "security", | ||
| "guided_onboarding" | ||
| "guidedOnboarding" |
There was a problem hiding this comment.
Just curious - Do we know when this regression was introduced?
There was a problem hiding this comment.
Looking at x-pack/plugins/cloud_integrations/cloud_links/kibana.jsonc and src/plugins/guided_onboarding/kibana.jsonc, it seems the typo has always been here?
There was a problem hiding this comment.
@alisonelizabeth @pgayvallet The typo in the cloud_links dependencies was introduced in this PR and without the test for the link I haven't noticed the regression. But that should be covered with the new test now
## Summary This PR fixes a bug introduced in elastic#155065 that I noticed when testing guided onboarding for v8.9.0: the help link was missing from the help menu. I added a functional test for the help link but we also need a test that the link is hidden when the user doesn't have access to guided onboarding (opened an issue for that [here](elastic#156410)). ### How to test 1. Add xpack.cloud.id: 'testID' to /config/kibana.dev.yml 2. Start ES with yarn es snapshot and Kibana with `yarn start`` 3. Check that the help link "Setup guides" is displayed in the help menu ### Screenshot <img width="336" alt="Screenshot 2023-05-02 at 17 27 20" src="https://user-images.githubusercontent.com/6585477/235712599-812b422d-3092-45b3-a726-37f6b90e81c1.png"> (cherry picked from commit d00e2a3)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
# Backport This will backport the following commits from `main` to `8.8`: - [[Guided onboarding] Fix the missing help link (#156399)](#156399) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Yulia Čech","email":"6585477+yuliacech@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-05-03T14:00:09Z","message":"[Guided onboarding] Fix the missing help link (#156399)\n\n## Summary\r\n\r\nThis PR fixes a bug introduced in\r\nhttps://github.com//pull/155065/ that I noticed when\r\ntesting guided onboarding for v8.9.0: the help link was missing from the\r\nhelp menu. I added a functional test for the help link but we also need\r\na test that the link is hidden when the user doesn't have access to\r\nguided onboarding (opened an issue for that\r\n[here](https://github.com/elastic/kibana/issues/156410)).\r\n\r\n### How to test\r\n1. Add xpack.cloud.id: 'testID' to /config/kibana.dev.yml\r\n2. Start ES with yarn es snapshot and Kibana with `yarn start``\r\n3. Check that the help link \"Setup guides\" is displayed in the help menu\r\n\r\n### Screenshot \r\n<img width=\"336\" alt=\"Screenshot 2023-05-02 at 17 27 20\"\r\nsrc=\"https://user-images.githubusercontent.com/6585477/235712599-812b422d-3092-45b3-a726-37f6b90e81c1.png\">","sha":"d00e2a366f872d80b5cd598765f8a5aee50cc399","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","Team:Journey/Onboarding","v8.8.0","v8.9.0"],"number":156399,"url":"https://github.com/elastic/kibana/pull/156399","mergeCommit":{"message":"[Guided onboarding] Fix the missing help link (#156399)\n\n## Summary\r\n\r\nThis PR fixes a bug introduced in\r\nhttps://github.com//pull/155065/ that I noticed when\r\ntesting guided onboarding for v8.9.0: the help link was missing from the\r\nhelp menu. I added a functional test for the help link but we also need\r\na test that the link is hidden when the user doesn't have access to\r\nguided onboarding (opened an issue for that\r\n[here](https://github.com/elastic/kibana/issues/156410)).\r\n\r\n### How to test\r\n1. Add xpack.cloud.id: 'testID' to /config/kibana.dev.yml\r\n2. Start ES with yarn es snapshot and Kibana with `yarn start``\r\n3. Check that the help link \"Setup guides\" is displayed in the help menu\r\n\r\n### Screenshot \r\n<img width=\"336\" alt=\"Screenshot 2023-05-02 at 17 27 20\"\r\nsrc=\"https://user-images.githubusercontent.com/6585477/235712599-812b422d-3092-45b3-a726-37f6b90e81c1.png\">","sha":"d00e2a366f872d80b5cd598765f8a5aee50cc399"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/156399","number":156399,"mergeCommit":{"message":"[Guided onboarding] Fix the missing help link (#156399)\n\n## Summary\r\n\r\nThis PR fixes a bug introduced in\r\nhttps://github.com//pull/155065/ that I noticed when\r\ntesting guided onboarding for v8.9.0: the help link was missing from the\r\nhelp menu. I added a functional test for the help link but we also need\r\na test that the link is hidden when the user doesn't have access to\r\nguided onboarding (opened an issue for that\r\n[here](https://github.com/elastic/kibana/issues/156410)).\r\n\r\n### How to test\r\n1. Add xpack.cloud.id: 'testID' to /config/kibana.dev.yml\r\n2. Start ES with yarn es snapshot and Kibana with `yarn start``\r\n3. Check that the help link \"Setup guides\" is displayed in the help menu\r\n\r\n### Screenshot \r\n<img width=\"336\" alt=\"Screenshot 2023-05-02 at 17 27 20\"\r\nsrc=\"https://user-images.githubusercontent.com/6585477/235712599-812b422d-3092-45b3-a726-37f6b90e81c1.png\">","sha":"d00e2a366f872d80b5cd598765f8a5aee50cc399"}}]}] BACKPORT--> Co-authored-by: Yulia Čech <6585477+yuliacech@users.noreply.github.com>
Summary
This PR fixes a bug introduced in #155065 that I noticed when testing guided onboarding for v8.9.0: the help link was missing from the help menu. I added a functional test for the help link but we also need a test that the link is hidden when the user doesn't have access to guided onboarding (opened an issue for that here).
How to test
Screenshot