* [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> |
||
---|---|---|
.. | ||
common | ||
public | ||
server | ||
jest.config.js | ||
kibana.json | ||
README.md |
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
- When developing locally, Enterprise Search should be running locally alongside Kibana on
localhost:3002
. - Update
config/kibana.dev.yml
withenterpriseSearch.host: 'http://localhost:3002'
- 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_case
d 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