[Dashboard Navigation] Documentation #166750
Assignees
Labels
impact:high
Addressing this issue will have a high level of impact on the quality/strength of our product.
loe:medium
Medium Level of Effort
Project:Dashboard Navigation
Related to the Dashboard Navigation Project
Team:Presentation
Presentation Team for Dashboard, Input Controls, and Canvas
Comments
nickpeihl
added
Team:Presentation
|
Pinging @elastic/kibana-presentation (Team:Presentation) |
8 tasks
Heenawter
added a commit
that referenced
this issue
Sep 29, 2023
…view (#166896) ## Summary This PR wraps up the work the @elastic/kibana-presentation team has done to finish the MVP of [Phase 1](#154354) of the `Link` embeddable, which enables users to add panels to their dashboard that contain links to other dashboards + external links - with respect to dashboard links, we give the author control over which pieces of context should be kept across dashboards so that things like filter pills, queries, and time ranges are not lost. This marks a huge improvement in dashboard navigation overall, which was previously only available via a variety of different workarounds including (but not limited to): - Creating (essentially) a `noop` dashboard-to-dashboard drilldown - Using markdown panels with hard Dashboard links, which are prone to break across updates - Avoiding navigation all together, which resulted in large, slow-to-load dashboards. As an added benefit, because these panels contain **references** to each dashboard rather than hard links, (1) unlike markdown links, they should not break after updates and (2) if a links panel is exported and imported into another space or instance, all of the dashboards it links to will also be imported. https://github.com/elastic/kibana/assets/8698078/1a86b713-47e7-4db9-8a04-29d41b13681a > **Note** > 🔉 The above video has audio! Turn on your sound for the best experience. ### Note about this PR - A majority of this work was done on a feature branch, with thorough reviews from @andreadelrio on behalf of @elastic/kibana-design along the way. Therefore, while feedback on the design is encouraged, any large concerns brought up in this PR should be filed as separate issues and addressed in follow-up PRs. - This PR contains work for giving embeddables control over their own panel size / default positioning on the dashboard. This was especially important for the links panel, since we assume that (a) most links panels would be located somewhere near the top of the dashboard and (b) the horizontal links panel should have a different default "shape" (longer than it is tall) than the vertical panel (taller than it is long). - This PR also contains work for caching dashboard saved objects, which makes navigation much more seamless. ### Flaky Test Runner - https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/3251  ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] ~[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials~ This will be addressed in a follow up: #166750 - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - ~Units tests are added, functional tests are forthcoming~ Edit: All tests are in. - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [x] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Nick Peihl <nick.peihl@elastic.co> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Andrea Del Rio <delrio.andre@gmail.com> Co-authored-by: Devon Thomson <devon.thomson@elastic.co> Co-authored-by: Nick Peihl <nickpeihl@gmail.com> Co-authored-by: Gerard Soldevila <gerard.soldevila@elastic.co>
nickpeihl
added a commit
that referenced
this issue
Nov 1, 2023
Fixes #166750 ## Summary Adds documentation for the links panel. --------- Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co>
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this issue
Nov 1, 2023
Fixes elastic#166750 ## Summary Adds documentation for the links panel. --------- Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co> (cherry picked from commit 878df86)
kibanamachine
added a commit
that referenced
this issue
Nov 1, 2023
# Backport This will backport the following commits from `main` to `8.11`: - [[Dashboard links] Links documentation (#170153)](#170153) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Nick Peihl","email":"nick.peihl@elastic.co"},"sourceCommit":{"committedDate":"2023-11-01T18:11:36Z","message":"[Dashboard links] Links documentation (#170153)\n\nFixes #166750 \r\n\r\n## Summary\r\n\r\nAdds documentation for the links panel.\r\n\r\n---------\r\n\r\nCo-authored-by: Amy Jonsson <amy.jonsson@elastic.co>","sha":"878df86151701759c8c3e55bc2f2c6c189fe209b","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","Team:Presentation","release_note:skip","docs","Project:Dashboard Navigation","v8.11.0","v8.12.0"],"number":170153,"url":"https://github.com/elastic/kibana/pull/170153","mergeCommit":{"message":"[Dashboard links] Links documentation (#170153)\n\nFixes #166750 \r\n\r\n## Summary\r\n\r\nAdds documentation for the links panel.\r\n\r\n---------\r\n\r\nCo-authored-by: Amy Jonsson <amy.jonsson@elastic.co>","sha":"878df86151701759c8c3e55bc2f2c6c189fe209b"}},"sourceBranch":"main","suggestedTargetBranches":["8.11"],"targetPullRequestStates":[{"branch":"8.11","label":"v8.11.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/170153","number":170153,"mergeCommit":{"message":"[Dashboard links] Links documentation (#170153)\n\nFixes #166750 \r\n\r\n## Summary\r\n\r\nAdds documentation for the links panel.\r\n\r\n---------\r\n\r\nCo-authored-by: Amy Jonsson <amy.jonsson@elastic.co>","sha":"878df86151701759c8c3e55bc2f2c6c189fe209b"}}]}] BACKPORT--> Co-authored-by: Nick Peihl <nick.peihl@elastic.co>
delanni
pushed a commit
to delanni/kibana
that referenced
this issue
Nov 6, 2023
Fixes elastic#166750 ## Summary Adds documentation for the links panel. --------- Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We will want to have documentation for the Links panels.
The text was updated successfully, but these errors were encountered: