Skip to content

[Guided onboarding] Fix the missing help link#156399

Merged
yuliacech merged 2 commits intoelastic:mainfrom
yuliacech:guided_onboarding/8.9/fix_help_link
May 3, 2023
Merged

[Guided onboarding] Fix the missing help link#156399
yuliacech merged 2 commits intoelastic:mainfrom
yuliacech:guided_onboarding/8.9/fix_help_link

Conversation

@yuliacech
Copy link
Copy Markdown
Contributor

@yuliacech yuliacech commented May 2, 2023

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

  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

Screenshot 2023-05-02 at 17 27 20

@yuliacech yuliacech added bug Fixes for quality problems that affect the customer experience Team:Journey/Onboarding Platform Journey Onboarding team v8.8.0 v8.9.0 labels May 2, 2023
@yuliacech yuliacech marked this pull request as ready for review May 2, 2023 15:28
@yuliacech yuliacech requested a review from a team as a code owner May 2, 2023 15:28
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/platform-onboarding (Team:Journey/Onboarding)

@kibana-ci
Copy link
Copy Markdown

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #47 / spaces api without security update can update from the default space "before all" hook in "can update from the default space"

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id before after diff
enterpriseSearch 19 21 +2
securitySolution 399 402 +3
total +5

Total ESLint disabled count

id before after diff
enterpriseSearch 20 22 +2
securitySolution 479 482 +3
total +5

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@yuliacech yuliacech added the release_note:skip Skip the PR/issue when compiling release notes label May 2, 2023
Copy link
Copy Markdown
Contributor

@alisonelizabeth alisonelizabeth left a comment

Choose a reason for hiding this comment

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

Changes LGTM. Verified locally. Thanks for fixing this!

"cloud",
"security",
"guided_onboarding"
"guidedOnboarding"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just curious - Do we know when this regression was introduced?

Copy link
Copy Markdown
Contributor

@pgayvallet pgayvallet May 3, 2023

Choose a reason for hiding this comment

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

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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@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

@yuliacech yuliacech merged commit d00e2a3 into elastic:main May 3, 2023
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 3, 2023
## 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)
@kibanamachine
Copy link
Copy Markdown
Contributor

💚 All backports created successfully

Status Branch Result
8.8

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request May 3, 2023
# 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>
@yuliacech yuliacech deleted the guided_onboarding/8.9/fix_help_link branch February 15, 2024 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Fixes for quality problems that affect the customer experience release_note:skip Skip the PR/issue when compiling release notes Team:Journey/Onboarding Platform Journey Onboarding team v8.8.0 v8.9.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants