-
Notifications
You must be signed in to change notification settings - Fork 950
/
Copy pathREADME.md
36 lines (29 loc) · 1015 Bytes
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
## Developer examples
Owner: OpenSearch Dashboards 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/opensearch-project/OpenSearch-Dashboards/tree/master/src/plugins/foo/README.md',
iconType: 'logoGithub',
target: '_blank',
size: 's',
},
],
image: img,
});
}
```
Run OpenSearch Dashboards with developer examples via:
```
yarn start --run-examples
```
Then navigate to "Developer examples":
<img src="./navigation.png" height="400px" />