Skip to content

Commit

Permalink
update api_docs with new lines and frontmatter
Browse files Browse the repository at this point in the history
  • Loading branch information
stacey-gammon committed Mar 2, 2021
1 parent 045b826 commit aa8fccf
Show file tree
Hide file tree
Showing 108 changed files with 1,258 additions and 456 deletions.
9 changes: 9 additions & 0 deletions api_docs/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the actions plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import actionsObj from './actions.json';
Expand All @@ -14,19 +15,27 @@ import actionsObj from './actions.json';

### Setup
<DocDefinitionList data={[actionsObj.server.setup]}/>

### Start
<DocDefinitionList data={[actionsObj.server.start]}/>

### Functions
<DocDefinitionList data={actionsObj.server.functions}/>

### Interfaces
<DocDefinitionList data={actionsObj.server.interfaces}/>

### Consts, variables and types
<DocDefinitionList data={actionsObj.server.misc}/>

## Common

### Functions
<DocDefinitionList data={actionsObj.common.functions}/>

### Interfaces
<DocDefinitionList data={actionsObj.common.interfaces}/>

### Consts, variables and types
<DocDefinitionList data={actionsObj.common.misc}/>

5 changes: 5 additions & 0 deletions api_docs/advanced_settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the advancedSettings plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import advancedSettingsObj from './advanced_settings.json';
Expand All @@ -14,9 +15,13 @@ import advancedSettingsObj from './advanced_settings.json';

### Setup
<DocDefinitionList data={[advancedSettingsObj.client.setup]}/>

### Start
<DocDefinitionList data={[advancedSettingsObj.client.start]}/>

### Functions
<DocDefinitionList data={advancedSettingsObj.client.functions}/>

### Classes
<DocDefinitionList data={advancedSettingsObj.client.classes}/>

11 changes: 11 additions & 0 deletions api_docs/alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the alerts plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerts']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import alertsObj from './alerts.json';
Expand All @@ -14,25 +15,35 @@ import alertsObj from './alerts.json';

### Setup
<DocDefinitionList data={[alertsObj.client.setup]}/>

### Start
<DocDefinitionList data={[alertsObj.client.start]}/>

## Server

### Functions
<DocDefinitionList data={alertsObj.server.functions}/>

### Interfaces
<DocDefinitionList data={alertsObj.server.interfaces}/>

### Consts, variables and types
<DocDefinitionList data={alertsObj.server.misc}/>

## Common

### Objects
<DocDefinitionList data={alertsObj.common.objects}/>

### Functions
<DocDefinitionList data={alertsObj.common.functions}/>

### Interfaces
<DocDefinitionList data={alertsObj.common.interfaces}/>

### Enums
<DocDefinitionList data={alertsObj.common.enums}/>

### Consts, variables and types
<DocDefinitionList data={alertsObj.common.misc}/>

8 changes: 8 additions & 0 deletions api_docs/apm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the apm plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import apmObj from './apm.json';
Expand All @@ -14,17 +15,24 @@ import apmObj from './apm.json';

### Start
<DocDefinitionList data={[apmObj.client.start]}/>

### Interfaces
<DocDefinitionList data={apmObj.client.interfaces}/>

## Server

### Setup
<DocDefinitionList data={[apmObj.server.setup]}/>

### Functions
<DocDefinitionList data={apmObj.server.functions}/>

### Classes
<DocDefinitionList data={apmObj.server.classes}/>

### Enums
<DocDefinitionList data={apmObj.server.enums}/>

### Consts, variables and types
<DocDefinitionList data={apmObj.server.misc}/>

7 changes: 7 additions & 0 deletions api_docs/apm_oss.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the apmOss plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmOss']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import apmOssObj from './apm_oss.json';
Expand All @@ -14,15 +15,21 @@ import apmOssObj from './apm_oss.json';

### Setup
<DocDefinitionList data={[apmOssObj.client.setup]}/>

### Start
<DocDefinitionList data={[apmOssObj.client.start]}/>

### Consts, variables and types
<DocDefinitionList data={apmOssObj.client.misc}/>

## Server

### Setup
<DocDefinitionList data={[apmOssObj.server.setup]}/>

### Functions
<DocDefinitionList data={apmOssObj.server.functions}/>

### Consts, variables and types
<DocDefinitionList data={apmOssObj.server.misc}/>

3 changes: 3 additions & 0 deletions api_docs/banners.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the banners plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import bannersObj from './banners.json';
Expand All @@ -14,5 +15,7 @@ import bannersObj from './banners.json';

### Interfaces
<DocDefinitionList data={bannersObj.common.interfaces}/>

### Consts, variables and types
<DocDefinitionList data={bannersObj.common.misc}/>

3 changes: 3 additions & 0 deletions api_docs/beats_management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the beatsManagement plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'beatsManagement']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import beatsManagementObj from './beats_management.json';
Expand All @@ -14,5 +15,7 @@ import beatsManagementObj from './beats_management.json';

### Objects
<DocDefinitionList data={beatsManagementObj.common.objects}/>

### Consts, variables and types
<DocDefinitionList data={beatsManagementObj.common.misc}/>

11 changes: 11 additions & 0 deletions api_docs/bfetch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the bfetch plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import bfetchObj from './bfetch.json';
Expand All @@ -14,25 +15,35 @@ import bfetchObj from './bfetch.json';

### Start
<DocDefinitionList data={[bfetchObj.client.start]}/>

### Functions
<DocDefinitionList data={bfetchObj.client.functions}/>

### Consts, variables and types
<DocDefinitionList data={bfetchObj.client.misc}/>

## Server

### Setup
<DocDefinitionList data={[bfetchObj.server.setup]}/>

### Start
<DocDefinitionList data={[bfetchObj.server.start]}/>

### Interfaces
<DocDefinitionList data={bfetchObj.server.interfaces}/>

### Consts, variables and types
<DocDefinitionList data={bfetchObj.server.misc}/>

## Common

### Functions
<DocDefinitionList data={bfetchObj.common.functions}/>

### Classes
<DocDefinitionList data={bfetchObj.common.classes}/>

### Interfaces
<DocDefinitionList data={bfetchObj.common.interfaces}/>

4 changes: 4 additions & 0 deletions api_docs/canvas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the canvas plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import canvasObj from './canvas.json';
Expand All @@ -14,7 +15,10 @@ import canvasObj from './canvas.json';

### Setup
<DocDefinitionList data={[canvasObj.client.setup]}/>

### Start
<DocDefinitionList data={[canvasObj.client.start]}/>

### Interfaces
<DocDefinitionList data={canvasObj.client.interfaces}/>

2 changes: 2 additions & 0 deletions api_docs/case.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the case plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'case']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import caseObj from './case.json';
Expand All @@ -14,3 +15,4 @@ import caseObj from './case.json';

### Interfaces
<DocDefinitionList data={caseObj.server.interfaces}/>

10 changes: 10 additions & 0 deletions api_docs/charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the charts plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import chartsObj from './charts.json';
Expand All @@ -14,21 +15,30 @@ import chartsObj from './charts.json';

### Start
<DocDefinitionList data={[chartsObj.client.start]}/>

### Objects
<DocDefinitionList data={chartsObj.client.objects}/>

### Functions
<DocDefinitionList data={chartsObj.client.functions}/>

### Interfaces
<DocDefinitionList data={chartsObj.client.interfaces}/>

### Enums
<DocDefinitionList data={chartsObj.client.enums}/>

### Consts, variables and types
<DocDefinitionList data={chartsObj.client.misc}/>

## Common

### Functions
<DocDefinitionList data={chartsObj.common.functions}/>

### Interfaces
<DocDefinitionList data={chartsObj.common.interfaces}/>

### Consts, variables and types
<DocDefinitionList data={chartsObj.common.misc}/>

4 changes: 4 additions & 0 deletions api_docs/cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the cloud plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import cloudObj from './cloud.json';
Expand All @@ -14,9 +15,12 @@ import cloudObj from './cloud.json';

### Setup
<DocDefinitionList data={[cloudObj.client.setup]}/>

### Interfaces
<DocDefinitionList data={cloudObj.client.interfaces}/>

## Server

### Setup
<DocDefinitionList data={[cloudObj.server.setup]}/>

3 changes: 3 additions & 0 deletions api_docs/console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the console plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import consoleObj from './console.json';
Expand All @@ -14,5 +15,7 @@ import consoleObj from './console.json';

### Setup
<DocDefinitionList data={[consoleObj.server.setup]}/>

### Start
<DocDefinitionList data={[consoleObj.server.start]}/>

9 changes: 9 additions & 0 deletions api_docs/core.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ image: https://source.unsplash.com/400x175/?github
summary: API docs for the core plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

import coreObj from './core.json';
Expand All @@ -14,19 +15,27 @@ import coreObj from './core.json';

### Objects
<DocDefinitionList data={coreObj.client.objects}/>

### Classes
<DocDefinitionList data={coreObj.client.classes}/>

### Interfaces
<DocDefinitionList data={coreObj.client.interfaces}/>

### Consts, variables and types
<DocDefinitionList data={coreObj.client.misc}/>

## Server

### Objects
<DocDefinitionList data={coreObj.server.objects}/>

### Classes
<DocDefinitionList data={coreObj.server.classes}/>

### Interfaces
<DocDefinitionList data={coreObj.server.interfaces}/>

### Consts, variables and types
<DocDefinitionList data={coreObj.server.misc}/>

Loading

0 comments on commit aa8fccf

Please sign in to comment.