Skip to content

Commit

Permalink
Start adding mdx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
weltenwort committed Dec 7, 2020
1 parent de45829 commit 218a3c4
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
7 changes: 6 additions & 1 deletion x-pack/plugins/infra/.storybook/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,9 @@
* you may not use this file except in compliance with the Elastic License.
*/

module.exports = require('@kbn/storybook').defaultConfig;
const defaultConfig = require('@kbn/storybook').defaultConfig;

module.exports = {
...defaultConfig,
stories: ['../**/*.stories.mdx', ...defaultConfig.stories],
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { Meta } from '@storybook/addon-docs/blocks';

<Meta title="infra/dataSearch/Overview" />

# The `data` plugin and `SearchStrategies`

The search functionality abstraction provided by the `search` service of the
`data` plugin is pretty powerful:

- The execution of the request is delegated to a search strategy, which is
executed on the Kibana server side.
- Any plugin can register custom search strategies with custom parameters and
response shapes.
- Requests can be cancelled via an `AbortSignal`.
- Partial responses can be returned as they become available if the search
takes longer.

# Working with `data.search.search` in the Browser

The following chapters describe a set of React components and hooks that aim to
make it easy to take advantage of these characteristics from client-side React
code.

## Issuing new requests


0 comments on commit 218a3c4

Please sign in to comment.