kibana/examples/developer_examples/README.md
Stacey Gammon f89e911f64
Kibana developer examples landing page (#67049)
* Kibana developer examples

* Batch explorer tests should be run in examples config

* Fix tests

* add codeowner for new developer examples plugin & readme cleanup

* Try to frame embeddable wording based on what a developer's goals are.

* Add noopener noreferer, fix bad merge

* Remove bfetch.png

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-06-08 09:47:51 -04:00

37 lines
959 B
Markdown

## Developer examples
Owner: Kibana application architecture team
The developer examples app is a landing page where developers go to search for working, tested examples of various developer
services. Add your a link to your example using the developerExamples `register` function offered on the `setup` contract:
```ts
setup(core, { developerExamples }) {
developerExamples.register({
appId: 'myFooExampleApp',
title: 'Foo services',
description: `Foo services let you do bar and zed.`,
links: [
{
label: 'README',
href: 'https://github.com/elastic/kibana/tree/master/src/plugins/foo/README.md',
iconType: 'logoGithub',
target: '_blank',
size: 's',
},
],
image: img,
});
}
```
Run Kibana with developer examples via:
```
yarn start --run-examples
```
Then navigate to "Developer examples":
<img src="./navigation.png" height="400px" />