kibana/x-pack/plugins/enterprise_search
Constance 2a71d41a60
[App Search] Document Creation Buttons & bare-bones modal/logic (#85902)
* [Setup] Add EuiCardTo helper

* Set up very basic DocumentCreationLogic file modal management

* Create buttons and modal components

* Update EngineOverviewEmpty to use only DocumentCreationButtons

- Remove API section/example/constants for now: per design discussion, we'll be moving this section into the document creation modal
- Move preceding DOCUMENT_CREATION_DESCRIPTION paragraph directly into DocumentCreationButtons, since the Documents view will just use this verbatim

* Update Documents view Index Documents button to show DocumentsCreationModal

- with some extra logic to add a new creationStep view
+ some minor test cleanup / clarification for openDocumentCreation

* Update Crawler button with conditional check

- Forgot to port this over initially

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2020-12-15 13:34:19 -08:00
..
common [bundle optimization] Update to semver 7.x to get tree-shaking (#83020) 2020-11-14 07:32:02 -05:00
public [App Search] Document Creation Buttons & bare-bones modal/logic (#85902) 2020-12-15 13:34:19 -08:00
server [Workplace Search] Migrate Sources Schema tree (#84847) 2020-12-03 10:13:22 -06:00
jest.config.js Jest multi-project configuration (#77894) 2020-12-02 11:42:23 -08:00
kibana.json [Enterprise Search] Add Cloud-specific setup guide instructions (#84008) 2020-11-23 13:09:59 -08:00
README.md test:jest improvements to better support our monorepo (#84848) 2020-12-14 14:07:50 -08:00

Enterprise Search

Overview

This plugin's goal is to provide a Kibana user interface to the Enterprise Search solution's products (App Search and Workplace Search). In it's current MVP state, the plugin provides the following with the goal of gathering user feedback and raising product awareness:

  • App Search: A basic engines overview with links into the product.
  • Workplace Search: A simple app overview with basic statistics, links to the sources, users (if standard auth), and product settings.

Development

  1. When developing locally, Enterprise Search should be running locally alongside Kibana on localhost:3002.
  2. Update config/kibana.dev.yml with enterpriseSearch.host: 'http://localhost:3002'
  3. For faster QA/development, run Enterprise Search on elasticsearch-native auth and log in as the elastic superuser on Kibana.

Kea

Enterprise Search uses Kea.js to manage our React/Redux state for us. Kea state is handled in our *Logic files and exposes values and actions for our components to get and set state with.

Advanced Kea usage

For the most part, we stick to the functionality described in Kea's core concepts. However, in some files, we also take advantage of props and events, as well as manually mounting some shared logic files on plugin init outside of React.

Debugging Kea

To debug Kea state in-browser, Kea recommends Redux Devtools. To facilitate debugging, we use the path key with snake_cased paths. The path key should always end with the logic filename (e.g. ['enterprise_search', 'some_logic']) to make it easy for devs to quickly find/jump to files via IDE tooling.

Testing

Unit tests

Documentation: https://www.elastic.co/guide/en/kibana/current/development-tests.html#_unit_testing

yarn test:jest x-pack/plugins/enterprise_search --watch

E2E tests

See our functional test runner README.