kibana/examples
Lukas Olson 09cd69d386
[UnifiedDocViewer] Move Discover doc viewer into plugin/package (#162847)
## Summary

Replaces https://github.com/elastic/kibana/pull/154012.

Moves the Discover doc viewer component into a new plugin/package,
`@kbn/unified-doc-viewer` and `@kbn/unified-doc-viewer-plugin`.

### Checklist

- [ ] 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
- [ ] [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
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] 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))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] 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))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

### Risk Matrix

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |

### 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: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Shahzad <shahzad31comp@gmail.com>
2023-08-31 11:46:59 -07:00
..
bfetch_explorer Upgrade EUI to v87.1.0 (#163961) 2023-08-21 15:16:39 -07:00
content_management_examples Make SavedObjectFinder backward compatible (#162904) 2023-08-08 13:10:29 +02:00
controls_example [Tech Debt] Remove deprecated EuiLoadingContent (#156316) 2023-05-03 08:01:37 -06:00
data_view_field_editor_example Assign functional tests and example plugins code ownership to Data Discovery (#162740) 2023-08-04 17:21:13 -03:00
developer_examples Update EUI layout components in dev examples (#163494) 2023-08-10 11:19:06 +02:00
discover_customization_examples [Logs+] Add Filter Control Customization Point (#162013) 2023-08-02 10:35:27 +01:00
embeddable_examples [Embeddable] Clientside migration system (#162986) 2023-08-22 15:08:27 -04:00
embeddable_explorer Clean up saved object based embeddable examples (#162987) 2023-08-03 03:14:36 -07:00
expressions_explorer remove deprecated components, improve spacing and title (#163378) 2023-08-08 09:46:40 -07:00
field_formats_example [Discover] Replace deprecated page components (#162836) 2023-08-02 20:08:17 +02:00
files_example Upgraded EUI to v76.0.0 (#152506) 2023-03-14 14:27:40 -05:00
guided_onboarding_example [Guided onboarding] Migrate all usages of EuiPage*_Deprecated (#161457) 2023-07-10 16:00:27 +01:00
hello_world [packages] migrate all plugins to packages (#148130) 2023-02-08 21:06:50 -06:00
locator_examples Updates deprecated EUI components in locators example plugins (#163405) 2023-08-08 07:55:38 -07:00
locator_explorer Updates deprecated EUI components in locators example plugins (#163405) 2023-08-08 07:55:38 -07:00
partial_results_example [Discover] Replace deprecated page components (#162836) 2023-08-02 20:08:17 +02:00
portable_dashboards_example [shared-ux-router] Add Router and Routes components (#159834) 2023-06-23 10:02:06 -05:00
preboot_example Migrate from deprecated EUI components (#161548) 2023-07-13 03:22:02 -07:00
response_stream [ML] Response Stream developer example: Migrate deprecated EUI components. (#162454) 2023-07-28 15:42:34 +02:00
routing_example Migrate from deprecated EUI components (#161548) 2023-07-13 03:22:02 -07:00
screenshot_mode_example Update EUI deprecated components in sample screenshot plugin (#163409) 2023-08-08 07:45:45 -07:00
search_examples remove unneeded usages of isErrorResponse (#164609) 2023-08-28 11:40:26 -06:00
share_examples [packages] migrate all plugins to packages (#148130) 2023-02-08 21:06:50 -06:00
state_containers_examples Update usage of deprecated EUI components in SharedUx plugins (#163560) 2023-08-14 06:36:38 -07:00
ui_action_examples [packages] migrate all plugins to packages (#148130) 2023-02-08 21:06:50 -06:00
ui_actions_explorer Update usage of deprecated EUI components in SharedUx plugins (#163560) 2023-08-14 06:36:38 -07:00
unified_doc_viewer [UnifiedDocViewer] Move Discover doc viewer into plugin/package (#162847) 2023-08-31 11:46:59 -07:00
unified_field_list_examples [Lens] Refactor drag and drop (#161257) 2023-07-11 13:05:03 +02:00
user_profile_examples [packages] migrate all plugins to packages (#148130) 2023-02-08 21:06:50 -06:00
v8_profiler_examples [examples] add routes to access v8 profiling (#155956) 2023-06-30 08:42:38 -04:00
README.asciidoc Add a few asciidoc readmes (#72082) 2020-07-17 11:08:57 -04:00

[[example-plugins]]
== Example plugins

This folder contains example plugins.  To run the plugins in this folder, use the `--run-examples` flag, via

[source,bash]
----
yarn start --run-examples
----