mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 10:40:07 -04:00
[api-docs] follow the correct schema for frontmatter (#138348)
* [api-docs] follow the correct schema for frontmatter * rename non-generated summary: usage * fix yaml comment syntax
This commit is contained in:
Spencer
GitHub
parent
e49c8645e8
commit
6c438b331c
93 changed files with 138 additions and 112 deletions
|
|
@ -2,7 +2,7 @@
|
|||
id: kibStyleGuide
|
||||
slug: /kibana-dev-docs/contributing/styleguide
|
||||
title: Style Guide
|
||||
summary: JavaScript/TypeScript styleguide.
|
||||
description: JavaScript/TypeScript styleguide.
|
||||
date: 2021-05-06
|
||||
tags: ['kibana', 'onboarding', 'dev', 'styleguide', 'typescript', 'javascript']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibBestPractices
|
||||
slug: /kibana-dev-docs/contributing/best-practices
|
||||
title: Best practices
|
||||
summary: Best practices to follow when building a Kibana plugin.
|
||||
description: Best practices to follow when building a Kibana plugin.
|
||||
date: 2021-03-17
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibRepoStructure
|
||||
slug: /kibana-dev-docs/contributing/repo-structure
|
||||
title: Repository structure
|
||||
summary: High level walk-through of our repository structure.
|
||||
description: High level walk-through of our repository structure.
|
||||
date: 2021-10-07
|
||||
tags: ['contributor', 'dev', 'github', 'getting started', 'onboarding', 'kibana']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevPrinciples
|
||||
slug: /kibana-dev-docs/contributing/dev-principles
|
||||
title: Developer principles
|
||||
summary: Follow our development principles to help keep our code base stable, maintainable and scalable.
|
||||
description: Follow our development principles to help keep our code base stable, maintainable and scalable.
|
||||
date: 2021-03-04
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDocumentation
|
||||
slug: /kibana-dev-docs/contributing/documentation
|
||||
title: Documentation
|
||||
summary: Writing documentation during development
|
||||
description: Writing documentation during development
|
||||
date: 2022-03-01
|
||||
tags: ['kibana', 'onboarding', 'dev']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibGitHub
|
||||
slug: /kibana-dev-docs/contributing/github
|
||||
title: How we use Github
|
||||
summary: Forking, branching, committing and using labels in the Kibana GitHub repo
|
||||
description: Forking, branching, committing and using labels in the Kibana GitHub repo
|
||||
date: 2021-09-16
|
||||
tags: ['contributor', 'dev', 'github', 'getting started', 'onboarding', 'kibana']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibStandards
|
||||
slug: /kibana-dev-docs/standards
|
||||
title: Standards and guidelines
|
||||
summary: Standards and guidelines we expect every Kibana developer to abide by
|
||||
description: Standards and guidelines we expect every Kibana developer to abide by
|
||||
date: 2021-09-28
|
||||
tags: ['contributor', 'dev', 'github', 'getting started', 'onboarding', 'kibana']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevDocsWelcome
|
||||
slug: /kibana-dev-docs/getting-started/welcome
|
||||
title: Welcome
|
||||
summary: Build custom solutions and applications on top of Kibana.
|
||||
description: Build custom solutions and applications on top of Kibana.
|
||||
date: 2021-01-02
|
||||
tags: ['kibana', 'dev', 'contributor']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibHelloWorldApp
|
||||
slug: /kibana-dev-docs/getting-started/hello-world-app
|
||||
title: Hello World
|
||||
summary: Build a very basic plugin that registers an application that says "Hello World!".
|
||||
description: Build a very basic plugin that registers an application that says "Hello World!".
|
||||
date: 2021-08-03
|
||||
tags: ['kibana', 'dev', 'contributor', 'tutorials']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialSetupDevEnv
|
||||
slug: /kibana-dev-docs/getting-started/setup-dev-env
|
||||
title: Set up a Development Environment
|
||||
summary: Learn how to setup a development environment for contributing to the Kibana repository
|
||||
description: Learn how to setup a development environment for contributing to the Kibana repository
|
||||
date: 2022-07-07
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture', 'setup']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibTroubleshooting
|
||||
slug: /kibana-dev-docs/getting-started/troubleshooting
|
||||
title: Troubleshooting
|
||||
summary: A collection of tips for working around strange issues.
|
||||
description: A collection of tips for working around strange issues.
|
||||
date: 2021-09-08
|
||||
tags: ['kibana', 'onboarding', 'dev', 'troubleshooting']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevAnatomyOfAPlugin
|
||||
slug: /kibana-dev-docs/key-concepts/anatomy-of-a-plugin
|
||||
title: Anatomy of a plugin
|
||||
summary: Anatomy of a Kibana plugin.
|
||||
description: Anatomy of a Kibana plugin.
|
||||
date: 2021-08-03
|
||||
tags: ['kibana', 'onboarding', 'dev']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibAuditLogging
|
||||
slug: /kibana-dev-docs/key-concepts/audit-logging
|
||||
title: Audit Logging
|
||||
summary: Audit Logging
|
||||
description: Audit Logging
|
||||
date: 2022-06-15
|
||||
tags: ['kibana', 'onboarding', 'dev', 'logging', 'audit']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibBuildingBlocks
|
||||
slug: /kibana-dev-docs/key-concepts/building-blocks
|
||||
title: Building blocks
|
||||
summary: Consider these building blocks when developing your plugin.
|
||||
description: Consider these building blocks when developing your plugin.
|
||||
date: 2021-02-24
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDataViewsKeyConcepts
|
||||
slug: /kibana-dev-docs/key-concepts/data-view-intro
|
||||
title: Data Views
|
||||
summary: Data views are the central method of defining queryable data sets in Kibana
|
||||
description: Data views are the central method of defining queryable data sets in Kibana
|
||||
date: 2021-08-11
|
||||
tags: ['kibana', 'dev', 'contributor', 'api docs']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevDocsEmbeddables
|
||||
slug: /kibana-dev-docs/key-concepts/embeddables
|
||||
title: Embeddables
|
||||
summary: Embeddables provide a way to expose a reusable widget.
|
||||
description: Embeddables provide a way to expose a reusable widget.
|
||||
date: 2022-07-27
|
||||
tags: ['kibana', 'dev', 'contributor', 'api docs']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibPlatformIntro
|
||||
slug: /kibana-dev-docs/key-concepts/platform-intro
|
||||
title: Plugins, packages, and the platform
|
||||
summary: An introduction to the Kibana platform and how to use it to build a plugin.
|
||||
description: An introduction to the Kibana platform and how to use it to build a plugin.
|
||||
date: 2021-01-06
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevKeyConceptsNavigation
|
||||
slug: /kibana-dev-docs/routing-and-navigation
|
||||
title: Routing, Navigation and URL
|
||||
summary: Learn best practices about navigation inside Kibana
|
||||
description: Learn best practices about navigation inside Kibana
|
||||
date: 2021-10-05
|
||||
tags: ['kibana', 'dev', 'architecture', 'contributor']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevPerformance
|
||||
slug: /kibana-dev-docs/key-concepts/performance
|
||||
title: Performance
|
||||
summary: Performance tips for Kibana development.
|
||||
description: Performance tips for Kibana development.
|
||||
date: 2021-12-03
|
||||
tags: ['kibana', 'onboarding', 'dev', 'performance']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevDocsPersistableStateIntro
|
||||
slug: /kibana-dev-docs/key-concepts/persistable-state-intro
|
||||
title: Persistable State
|
||||
summary: Persitable state is a key concept to understand when building a Kibana plugin.
|
||||
description: Persitable state is a key concept to understand when building a Kibana plugin.
|
||||
date: 2021-02-02
|
||||
tags: ['kibana', 'dev', 'contributor', 'api docs']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevDocsSavedObjectsIntro
|
||||
slug: /kibana-dev-docs/key-concepts/saved-objects-intro
|
||||
title: Saved Objects
|
||||
summary: Saved Objects are a key concept to understand when building a Kibana plugin.
|
||||
description: Saved Objects are a key concept to understand when building a Kibana plugin.
|
||||
date: 2021-02-02
|
||||
tags: ['kibana', 'dev', 'contributor', 'api docs']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialAdvancedSettings
|
||||
slug: /kibana-dev-docs/tutorials/advanced-settings
|
||||
title: How to register a new advanced setting
|
||||
summary: Learn how to add and use a new advanced setting
|
||||
description: Learn how to add and use a new advanced setting
|
||||
date: 2022-02-07
|
||||
tags: ['kibana','onboarding', 'dev', 'architecture', 'tutorials']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialBuildingDistributable
|
||||
slug: /kibana-dev-docs/tutorials/building-distributable
|
||||
title: Building a Kibana distributable
|
||||
summary: Learn how to build a Kibana distributable
|
||||
description: Learn how to build a Kibana distributable
|
||||
date: 2021-05-10
|
||||
tags: ['kibana', 'onboarding', 'dev', 'tutorials', 'build', 'distributable']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialCI
|
||||
slug: /kibana-dev-docs/tutorials/ci
|
||||
title: CI
|
||||
summary: CI
|
||||
description: CI
|
||||
date: 2022-02-03
|
||||
tags: ['kibana', 'onboarding', 'dev', 'ci']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialDataSearchAndSessions
|
||||
slug: /kibana-dev-docs/tutorials/data/search-and-sessions
|
||||
title: Kibana data.search Services
|
||||
summary: Kibana Search Services
|
||||
description: Kibana Search Services
|
||||
date: 2021-02-10
|
||||
tags: ['kibana', 'onboarding', 'dev', 'tutorials', 'search', 'sessions', 'search-sessions']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialDataViews
|
||||
slug: /kibana-dev-docs/tutorials/data-views
|
||||
title: Data views API
|
||||
summary: Data views API
|
||||
description: Data views API
|
||||
date: 2021-08-11
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialDebugging
|
||||
slug: /kibana-dev-docs/tutorials/debugging
|
||||
title: Debugging in development
|
||||
summary: Learn how to debug Kibana while running from source
|
||||
description: Learn how to debug Kibana while running from source
|
||||
date: 2021-04-26
|
||||
tags: ['kibana', 'onboarding', 'dev', 'tutorials', 'debugging']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialSetupWindowsDevWSL
|
||||
slug: /kibana-dev-docs/tutorial/setup-windows-development-wsl
|
||||
title: WSL on Windows Development
|
||||
summary: Learn how to setup a Windows development environment using WSL
|
||||
description: Learn how to setup a Windows development environment using WSL
|
||||
date: 2022-07-07
|
||||
tags: ['kibana', 'onboarding', 'setup', 'windows', 'development', 'wsl']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialServerEndpoint
|
||||
slug: /kibana-dev-docs/tutorials/registering-endpoints
|
||||
title: Registering and accessing an endpoint
|
||||
summary: Learn how to register a new endpoint and access it
|
||||
description: Learn how to register a new endpoint and access it
|
||||
date: 2021-11-24
|
||||
tags: ['kibana', 'dev', 'architecture', 'tutorials']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialExpressions
|
||||
slug: /kibana-dev-docs/tutorials/expressions
|
||||
title: Kibana Expressions Service
|
||||
summary: Kibana Expressions Service
|
||||
description: Kibana Expressions Service
|
||||
date: 2021-06-01
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevDocsKPTTutorial
|
||||
slug: /kibana-dev-docs/tutorials/kibana-page-template
|
||||
title: Kibana Page Template
|
||||
summary: Learn how to create pages in Kibana
|
||||
description: Learn how to create pages in Kibana
|
||||
date: 2021-03-20
|
||||
tags: ['kibana', 'dev', 'ui', 'tutorials']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialSavedObject
|
||||
slug: /kibana-dev-docs/tutorials/saved-objects
|
||||
title: Register a new saved object type
|
||||
summary: Learn how to register a new saved object type.
|
||||
description: Learn how to register a new saved object type.
|
||||
date: 2021-02-05
|
||||
tags: ['kibana','onboarding', 'dev', 'architecture', 'tutorials']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialScreenshotting
|
||||
slug: /kibana-dev-docs/tutorials/screenshotting
|
||||
title: Kibana Screenshotting Service
|
||||
summary: Kibana Screenshotting Service
|
||||
description: Kibana Screenshotting Service
|
||||
date: 2022-04-12
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialSubmitPullRequest
|
||||
slug: /kibana-dev-docs/tutorials/submit-pull-request
|
||||
title: Submitting a Kibana pull request
|
||||
summary: Learn how to submit a Kibana pull request
|
||||
description: Learn how to submit a Kibana pull request
|
||||
date: 2021-06-24
|
||||
tags: ['kibana', 'onboarding', 'dev', 'tutorials', 'github', 'pr', 'pull request', 'ci']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevTutorialTestingPlugins
|
||||
slug: /kibana-dev-docs/tutorials/testing-plugins
|
||||
title: Testing Kibana Plugins
|
||||
summary: Learn how to test different aspects of Kibana plugins
|
||||
description: Learn how to test different aspects of Kibana plugins
|
||||
date: 2021-07-05
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture', 'testing']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: home/SampleData/Cards
|
||||
slug: /home/sample-data/cards
|
||||
title: Sample Data Cards
|
||||
summary: A component that displays Sample Data Sets as cards and grid of cards.
|
||||
description: A component that displays Sample Data Sets as cards and grid of cards.
|
||||
tags: ['home', 'component', 'sample-data']
|
||||
date: 2022-06-30
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: home/SampleData/Tab
|
||||
slug: /home/sample-data/tab
|
||||
title: Sample Data Tab
|
||||
summary: A component that displays the content of the Sample Data tab in the `home` plugin.
|
||||
description: A component that displays the content of the Sample Data tab in the `home` plugin.
|
||||
tags: ['home', 'component', 'sample-data']
|
||||
date: 2022-06-30
|
||||
---
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
/*
|
||||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
||||
* or more contributor license agreements. Licensed under the Elastic License
|
||||
* 2.0 and the Server Side Public License, v 1; you may not use this file except
|
||||
* in compliance with, at your election, the Elastic License 2.0 or the Server
|
||||
* Side Public License, v 1.
|
||||
*/
|
||||
|
||||
export const AUTO_GENERATED_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.
|
||||
####`;
|
||||
|
|
@ -17,6 +17,7 @@ import {
|
|||
ReferencedDeprecationsByPlugin,
|
||||
UnreferencedDeprecationsByPlugin,
|
||||
} from '../types';
|
||||
import { AUTO_GENERATED_WARNING } from '../auto_generated_warning';
|
||||
import { getPluginApiDocId } from '../utils';
|
||||
|
||||
export function writeDeprecationDocByApi(
|
||||
|
|
@ -76,18 +77,18 @@ export function writeDeprecationDocByApi(
|
|||
|
||||
const mdx = dedent(`
|
||||
---
|
||||
${AUTO_GENERATED_WARNING}
|
||||
id: kibDevDocsDeprecationsByApi
|
||||
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
|
||||
title: Deprecated API usage by API
|
||||
summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
date: ${moment().format('YYYY-MM-DD')}
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
---
|
||||
|
||||
## Referenced deprecated APIs
|
||||
|
||||
${tableMdx}
|
||||
${tableMdx}
|
||||
|
||||
## Unreferenced deprecated APIs
|
||||
|
||||
|
|
|
|||
|
|
@ -12,6 +12,7 @@ import dedent from 'dedent';
|
|||
import fs from 'fs';
|
||||
import Path from 'path';
|
||||
import { ApiDeclaration, ApiReference, ReferencedDeprecationsByPlugin } from '../types';
|
||||
import { AUTO_GENERATED_WARNING } from '../auto_generated_warning';
|
||||
import { getPluginApiDocId } from '../utils';
|
||||
|
||||
export function writeDeprecationDocByPlugin(
|
||||
|
|
@ -34,7 +35,7 @@ export function writeDeprecationDocByPlugin(
|
|||
|
||||
return `
|
||||
## ${key}
|
||||
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
${Object.keys(groupedDeprecationReferences)
|
||||
|
|
@ -70,16 +71,16 @@ export function writeDeprecationDocByPlugin(
|
|||
|
||||
const mdx = dedent(`
|
||||
---
|
||||
${AUTO_GENERATED_WARNING}
|
||||
id: kibDevDocsDeprecationsByPlugin
|
||||
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
|
||||
title: Deprecated API usage by plugin
|
||||
summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
date: ${moment().format('YYYY-MM-DD')}
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
---
|
||||
|
||||
${tableMdx}
|
||||
${tableMdx}
|
||||
|
||||
`);
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ import {
|
|||
PluginOrPackage,
|
||||
ReferencedDeprecationsByPlugin,
|
||||
} from '../types';
|
||||
import { AUTO_GENERATED_WARNING } from '../auto_generated_warning';
|
||||
import { getPluginApiDocId } from '../utils';
|
||||
|
||||
export function writeDeprecationDueByTeam(
|
||||
|
|
@ -58,7 +59,7 @@ export function writeDeprecationDueByTeam(
|
|||
|
||||
return `
|
||||
## ${key}
|
||||
|
||||
|
||||
| Plugin | Deprecated API | Reference location(s) | Remove By |
|
||||
| --------|-------|-----------|-----------|
|
||||
${Object.keys(groupedDeprecationReferences)
|
||||
|
|
@ -97,16 +98,16 @@ export function writeDeprecationDueByTeam(
|
|||
|
||||
const mdx = dedent(`
|
||||
---
|
||||
${AUTO_GENERATED_WARNING}
|
||||
id: kibDevDocsDeprecationsDueByTeam
|
||||
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
|
||||
title: Deprecated APIs due to be removed, by team
|
||||
summary: Lists the teams that are referencing deprecated APIs with a remove by date.
|
||||
description: Lists the teams that are referencing deprecated APIs with a remove by date.
|
||||
date: ${moment().format('YYYY-MM-DD')}
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
---
|
||||
|
||||
${tableMdx}
|
||||
${tableMdx}
|
||||
|
||||
`);
|
||||
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ import Path from 'path';
|
|||
import dedent from 'dedent';
|
||||
import { ToolingLog } from '@kbn/tooling-log';
|
||||
import { PluginApi, PluginMetaInfo } from '../types';
|
||||
import { AUTO_GENERATED_WARNING } from '../auto_generated_warning';
|
||||
import { getPluginApiDocId } from '../utils';
|
||||
|
||||
function hasPublicApi(doc: PluginApi): boolean {
|
||||
|
|
@ -74,24 +75,24 @@ export function writePluginDirectoryDoc(
|
|||
const mdx =
|
||||
dedent(`
|
||||
---
|
||||
${AUTO_GENERATED_WARNING}
|
||||
id: kibDevDocsPluginDirectory
|
||||
slug: /kibana-dev-docs/api-meta/plugin-api-directory
|
||||
title: Directory
|
||||
summary: Directory of public APIs available through plugins or packages.
|
||||
description: Directory of public APIs available through plugins or packages.
|
||||
date: ${moment().format('YYYY-MM-DD')}
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
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.
|
||||
---
|
||||
|
||||
### Overall stats
|
||||
|
||||
| Count | Plugins or Packages with a <br /> public API | Number of teams |
|
||||
| Count | Plugins or Packages with a <br /> public API | Number of teams |
|
||||
|--------------|----------|------------------------|
|
||||
| ${totalStats.pluginCnt} | ${totalStats.pluginCntWithPublicApi} | ${totalStats.teamCnt} |
|
||||
|
||||
### Public API health stats
|
||||
|
||||
| API Count | Any Count | Missing comments | Missing exports |
|
||||
| API Count | Any Count | Missing comments | Missing exports |
|
||||
|--------------|----------|-----------------|--------|
|
||||
| ${totalStats.totalApiCnt} | ${totalStats.anyCnt} | ${totalStats.missingCommentCnt} | ${
|
||||
totalStats.missingExportCnt
|
||||
|
|
@ -99,13 +100,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
## Plugin Directory
|
||||
|
||||
| Plugin name | Maintaining team | Description | API Cnt | Any Cnt | Missing<br />comments | Missing<br />exports |
|
||||
| Plugin name | Maintaining team | Description | API Cnt | Any Cnt | Missing<br />comments | Missing<br />exports |
|
||||
|--------------|----------------|-----------|--------------|----------|---------------|--------|
|
||||
${getDirectoryTable(pluginApiMap, pluginStatsMap, true)}
|
||||
|
||||
## Package Directory
|
||||
|
||||
| Package name | Maintaining team | Description | API Cnt | Any Cnt | Missing<br />comments | Missing<br />exports |
|
||||
| Package name | Maintaining team | Description | API Cnt | Any Cnt | Missing<br />comments | Missing<br />exports |
|
||||
|--------------|----------------|-----------|--------------|----------|---------------|--------|
|
||||
${getDirectoryTable(pluginApiMap, pluginStatsMap, false)}
|
||||
|
||||
|
|
|
|||
|
|
@ -19,6 +19,7 @@ import {
|
|||
getSlug,
|
||||
} from '../utils';
|
||||
import { writePluginDocSplitByFolder } from './write_plugin_split_by_folder';
|
||||
import { AUTO_GENERATED_WARNING } from '../auto_generated_warning';
|
||||
import { WritePluginDocsOpts } from './types';
|
||||
|
||||
/**
|
||||
|
|
@ -75,14 +76,14 @@ export function writePluginDoc(
|
|||
let mdx =
|
||||
dedent(`
|
||||
---
|
||||
${AUTO_GENERATED_WARNING}
|
||||
id: ${getPluginApiDocId(doc.id)}
|
||||
slug: /kibana-dev-docs/api/${slug}
|
||||
title: "${doc.id}"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the ${doc.id} plugin
|
||||
description: API docs for the ${doc.id} plugin
|
||||
date: ${moment().format('YYYY-MM-DD')}
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '${doc.id}']
|
||||
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 ${json} from './${fileName}.devdocs.json';
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,15 @@
|
|||
---
|
||||
####
|
||||
#### 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.
|
||||
####
|
||||
id: kibPluginAPluginApi
|
||||
slug: /kibana-dev-docs/api/pluginA
|
||||
title: "pluginA"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the pluginA plugin
|
||||
date: 2022-04-30
|
||||
description: API docs for the pluginA plugin
|
||||
date: 2022-08-08
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'pluginA']
|
||||
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 pluginAObj from './plugin_a.devdocs.json';
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,15 @@
|
|||
---
|
||||
####
|
||||
#### 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.
|
||||
####
|
||||
id: kibPluginAFooPluginApi
|
||||
slug: /kibana-dev-docs/api/pluginA-foo
|
||||
title: "pluginA.foo"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the pluginA.foo plugin
|
||||
date: 2022-04-30
|
||||
description: API docs for the pluginA.foo plugin
|
||||
date: 2022-08-08
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'pluginA.foo']
|
||||
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 pluginAFooObj from './plugin_a_foo.devdocs.json';
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,15 @@
|
|||
---
|
||||
####
|
||||
#### 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.
|
||||
####
|
||||
id: kibPluginBPluginApi
|
||||
slug: /kibana-dev-docs/api/pluginB
|
||||
title: "pluginB"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the pluginB plugin
|
||||
date: 2022-04-30
|
||||
description: API docs for the pluginB plugin
|
||||
date: 2022-08-08
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'pluginB']
|
||||
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 pluginBObj from './plugin_b.devdocs.json';
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibSharedUXComponents
|
||||
slug: /kibana-dev-docs/shared-ux/packages/kbn-shared-ux-components
|
||||
title: Shared UX Components
|
||||
summary:
|
||||
description:
|
||||
date: 2022-03-11
|
||||
tags: ['kibana', 'dev', 'sharedUX']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Components/PageTemplate
|
||||
slug: /shared-ux-components/page_template/page_template
|
||||
title: Page Template
|
||||
summary: A Kibana-specific wrapper around `EuiTemplate`
|
||||
description: A Kibana-specific wrapper around `EuiTemplate`
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2022-04-04
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibSharedUXServices
|
||||
slug: /kibana-dev-docs/shared-ux/packages/kbn-shared-ux-services
|
||||
title: Shared UX Services
|
||||
summary: The `@kbn/shared-ux-services` package provides a thin service abstraction for components and solutions created by the Shared UX team.
|
||||
description: The `@kbn/shared-ux-services` package provides a thin service abstraction for components and solutions created by the Shared UX team.
|
||||
date: 2022-03-11
|
||||
tags: ['kibana', 'dev', 'sharedUX']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibSharedUXStorybook
|
||||
slug: /kibana-dev-docs/shared-ux/packages/kbn-shared-ux-storybook
|
||||
title: Shared UX Storybook
|
||||
summary: The `@kbn/shared-ux-storybook` package provides Storybook assets for Shared UX and other teams.
|
||||
description: The `@kbn/shared-ux-storybook` package provides Storybook assets for Shared UX and other teams.
|
||||
date: 2022-03-11
|
||||
tags: ['kibana', 'dev', 'sharedUX']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibSharedUXUtility
|
||||
slug: /kibana-dev-docs/shared-ux/packages/kbn-shared-ux-utility
|
||||
title: Shared UX Utilities
|
||||
summary: The `@kbn/shared-ux-utility` package contains a set of React, DOM and other utilities.
|
||||
description: The `@kbn/shared-ux-utility` package contains a set of React, DOM and other utilities.
|
||||
date: 2022-03-11
|
||||
tags: ['kibana', 'dev', 'sharedUX']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Components/KibanaSolutionAvatar
|
||||
slug: /shared-ux/components/avatar-solution
|
||||
title: Solution Avatar
|
||||
summary: A wrapper around `EuiAvatar` tailored for use in Kibana solutions.
|
||||
description: A wrapper around `EuiAvatar` tailored for use in Kibana solutions.
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2022-05-04
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Components/ExitFullScreenButton
|
||||
slug: /shared-ux/components/exit-full-screen-button
|
||||
title: Exit Full Screen Button
|
||||
summary: A button that floats over the plugin workspace and allows someone to exit "full screen" mode.
|
||||
description: A button that floats over the plugin workspace and allows someone to exit "full screen" mode.
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2021-12-28
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/ButtonToolbar
|
||||
slug: /shared-ux/button-toolbar
|
||||
title: Button Toolbar
|
||||
summary:
|
||||
description:
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2022-06-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Components/Popover
|
||||
slug: /shared-ux/components/toolbar/popovers/popover
|
||||
title: Toolbar Popover
|
||||
summary: A popover component that can be placed within a toolbar button.
|
||||
description: A popover component that can be placed within a toolbar button.
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2022-03-28
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Components/NoDataCard
|
||||
slug: /shared-ux/components/no-data-card
|
||||
title: No Data Card
|
||||
summary: A card displayed when no data is available is available in Kibana.
|
||||
description: A card displayed when no data is available is available in Kibana.
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2022-06-15
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Components/AppLink
|
||||
slug: /shared-ux/components/redirect-app-links
|
||||
title: Redirect App Links
|
||||
summary: A component for redirecting links contained within it to the appropriate Kibana solution without a page refresh.
|
||||
description: A component for redirecting links contained within it to the appropriate Kibana solution without a page refresh.
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2022-05-04
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Page/AnalyticsNoDataPage
|
||||
slug: /shared-ux/page/analytics-no-data-page
|
||||
title: Analytics "No Data" Page
|
||||
summary: An entire page that can be displayed when Kibana "has no data", specifically for Analytics.
|
||||
description: An entire page that can be displayed when Kibana "has no data", specifically for Analytics.
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2021-12-28
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Page/KibanaNoDataPage
|
||||
slug: /shared-ux/page/kibana-no-data
|
||||
title: Kibana No Data Page
|
||||
summary: A page to be displayed when there is no data in Elasticsearch, or no data views.
|
||||
description: A page to be displayed when there is no data in Elasticsearch, or no data views.
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2022-04-20
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Page/SolutionNav
|
||||
slug: /shared-ux/page/solution-nav
|
||||
title: Solution Page Navigation
|
||||
summary: A customized `EuiSideNav` for pages within Solutions in Kibana.
|
||||
description: A customized `EuiSideNav` for pages within Solutions in Kibana.
|
||||
tags: ['shared-ux', 'component']
|
||||
date: 2022-06-30
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/Prompt/NoDataViews
|
||||
slug: /shared-ux/prompt/no-data-views
|
||||
title: No Data Views Prompt
|
||||
summary: A prompt to be displayed when there is data in Elasticsearch, but no data views
|
||||
description: A prompt to be displayed when there is data in Elasticsearch, but no data views
|
||||
tags: ['shared-ux', 'component', 'prompt', 'no-data']
|
||||
date: 2022-02-09
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibCoreDeprecationsService
|
||||
slug: /kibana-dev-docs/services/deprecations-service
|
||||
title: Core Deprecations service
|
||||
summary: The Deprecations service helps surface deprecated configs and features for plugins to our users
|
||||
description: The Deprecations service helps surface deprecated configs and features for plugins to our users
|
||||
date: 2021-06-27
|
||||
tags: ['kibana','dev', 'contributor', 'api docs']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: kibCoreLogging
|
|||
slug: /kibana-dev-docs/services/logging
|
||||
title: Logging system
|
||||
image: https://source.unsplash.com/400x175/?Logging
|
||||
summary: Core logging contains the system and service for Kibana logs.
|
||||
description: Core logging contains the system and service for Kibana logs.
|
||||
date: 2020-12-02
|
||||
tags: ['kibana','dev', 'contributor', 'api docs']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: controls
|
||||
slug: /kibana-dev-docs/controls
|
||||
title: Controls Plugin
|
||||
summary: Introduction to the Controls Plugin.
|
||||
description: Introduction to the Controls Plugin.
|
||||
date: 2020-01-12
|
||||
tags: ['kibana', 'controls', 'dashboard']
|
||||
related: []
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: kibDataPlugin
|
|||
slug: /kibana-dev-docs/key-concepts/data-plugin
|
||||
title: Data services
|
||||
image: https://source.unsplash.com/400x175/?Search
|
||||
summary: The data plugin contains services for searching, querying and filtering.
|
||||
description: The data plugin contains services for searching, querying and filtering.
|
||||
date: 2020-12-02
|
||||
tags: ['kibana', 'dev', 'contributor', 'api docs']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: kibDataPlugin
|
|||
slug: /kibana-dev-docs/services/data-plugin
|
||||
title: Data services
|
||||
image: https://source.unsplash.com/400x175/?Search
|
||||
summary: The data plugin contains services for searching, querying and filtering.
|
||||
description: The data plugin contains services for searching, querying and filtering.
|
||||
date: 2020-12-02
|
||||
tags: ['kibana', 'dev', 'contributor', 'api docs']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreDefaultValue
|
||||
slug: /form-lib/core/default-value
|
||||
title: Default value
|
||||
summary: Initiate a field with the correct value
|
||||
description: Initiate a field with the correct value
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreFieldHook
|
||||
slug: /form-lib/core/field-hook
|
||||
title: Field hook
|
||||
summary: You don't manually create them but you'll get all the love from them
|
||||
description: You don't manually create them but you'll get all the love from them
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreFormComponent
|
||||
slug: /form-lib/core/form-component
|
||||
title: <Form />
|
||||
summary: The boundary of your form
|
||||
description: The boundary of your form
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreFormHook
|
||||
slug: /form-lib/core/form-hook
|
||||
title: Form hook
|
||||
summary: The heart of the lib; It manages your fields so you don't have to
|
||||
description: The heart of the lib; It manages your fields so you don't have to
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreFundamentals
|
||||
slug: /form-lib/core/fundamentals
|
||||
title: Fundamentals
|
||||
summary: Let's understand the basics
|
||||
description: Let's understand the basics
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2022-03-18
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreUseArray
|
||||
slug: /form-lib/core/use-array
|
||||
title: <UseArray />
|
||||
summary: The perfect companion to generate dynamic fields
|
||||
description: The perfect companion to generate dynamic fields
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreUseBehaviorSubject
|
||||
slug: /form-lib/utils/use-behavior-subject
|
||||
title: useBehaviorSubject()
|
||||
summary: Util to create a rxjs BehaviorSubject with a handler to change its value
|
||||
description: Util to create a rxjs BehaviorSubject with a handler to change its value
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-08-20
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreUseField
|
||||
slug: /form-lib/core/use-field
|
||||
title: <UseField />
|
||||
summary: Drop it anywhere in your <Form /> and see the magic happen
|
||||
description: Drop it anywhere in your <Form /> and see the magic happen
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreUseFormData
|
||||
slug: /form-lib/core/use-form-data
|
||||
title: useFormData()
|
||||
summary: Get fields value updates from anywhere
|
||||
description: Get fields value updates from anywhere
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreUseForm
|
||||
slug: /form-lib/core/use-form
|
||||
title: useForm()
|
||||
summary: The only hook you'll need to declare a new form
|
||||
description: The only hook you'll need to declare a new form
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreUseFormIsModified
|
||||
slug: /form-lib/core/use-form-is-modified
|
||||
title: useFormIsModified()
|
||||
summary: Know when your form has been modified by the user
|
||||
description: Know when your form has been modified by the user
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2022-03-18
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibCoreUseMultiFields
|
||||
slug: /form-lib/core/use-multi-fields
|
||||
title: <UseMultiFields />
|
||||
summary: Because sometimes you need more than one field
|
||||
description: Because sometimes you need more than one field
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibExampleDynamicFields
|
||||
slug: /form-lib/examples/dynamic-fields
|
||||
title: Dynamic fields
|
||||
summary: Let the user add any number of fields on the fly
|
||||
description: Let the user add any number of fields on the fly
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibExampleFieldsComposition
|
||||
slug: /form-lib/examples/fields-composition
|
||||
title: Fields composition
|
||||
summary: Be DRY and compose your form
|
||||
description: Be DRY and compose your form
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibExampleListeningToChanges
|
||||
slug: /form-lib/examples/listening-to-changes
|
||||
title: Listening to changes
|
||||
summary: React to changes deep down the tree
|
||||
description: React to changes deep down the tree
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibExampleSerializersDeserializers
|
||||
slug: /form-lib/examples/serializers-deserializers
|
||||
title: Serializers & Deserializers
|
||||
summary: No need for a 1:1 map of your API with your form fields, be creative!
|
||||
description: No need for a 1:1 map of your API with your form fields, be creative!
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibExampleStyleFields
|
||||
slug: /form-lib/examples/styles-fields
|
||||
title: Style fields
|
||||
summary: Customize your fields however you want
|
||||
description: Customize your fields however you want
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibExampleValidation
|
||||
slug: /form-lib/examples/validation
|
||||
title: Validation
|
||||
summary: Don't let invalid data leak out of your form!
|
||||
description: Don't let invalid data leak out of your form!
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibHelpersComponents
|
||||
slug: /form-lib/helpers/components
|
||||
title: Components
|
||||
summary: Build complex forms the easy way
|
||||
description: Build complex forms the easy way
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibHelpersValidators
|
||||
slug: /form-lib/helpers/validators
|
||||
title: Validators
|
||||
summary: Build complex forms the easy way
|
||||
description: Build complex forms the easy way
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: formLibWelcome
|
||||
slug: /form-lib/welcome
|
||||
title: Welcome
|
||||
summary: Build complex forms the easy way
|
||||
description: Build complex forms the easy way
|
||||
tags: ['forms', 'kibana', 'dev']
|
||||
date: 2021-04-14
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: presentationUtilPlugin
|
||||
slug: /kibana-dev-docs/presentationPlugin
|
||||
title: Presentation Utility Plugin
|
||||
summary: Introduction to the Presentation Utility Plugin.
|
||||
description: Introduction to the Presentation Utility Plugin.
|
||||
date: 2020-01-12
|
||||
tags: ['kibana', 'presentation', 'services']
|
||||
related: []
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibDevSharePluginReadme
|
||||
slug: /kibana-dev-docs/tutorials/share
|
||||
title: Kibana share Plugin
|
||||
summary: Introduction to Kibana "share" plugin services (sharing popup menu, URL locators, and short URLs).
|
||||
description: Introduction to Kibana "share" plugin services (sharing popup menu, URL locators, and short URLs).
|
||||
date: 2022-02-21
|
||||
tags: ['kibana', 'onboarding', 'dev', 'tutorials', 'share', 'url', 'short-url', 'locator']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: sharedUX/About
|
||||
slug: /shared-ux/about
|
||||
title: About Shared UX
|
||||
summary: .
|
||||
description: .
|
||||
date: 2021-01-05
|
||||
tags: ['shared-ux']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: kibUsageCollectionPlugin
|
||||
slug: /kibana-dev-docs/key-concepts/usage-collection-plugin
|
||||
title: Usage collection service
|
||||
summary: The Usage Collection Service defines a set of APIs for other plugins to report the usage of their features.
|
||||
description: The Usage Collection Service defines a set of APIs for other plugins to report the usage of their features.
|
||||
date: 2021-02-24
|
||||
tags: ['kibana','dev', 'contributor', 'api docs']
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: canvasPlugins
|
||||
slug: /playground/kibana/canvas-plugins
|
||||
title: Develop Canvas plugins
|
||||
summary: Introduction to
|
||||
description: Introduction to
|
||||
date: 2021-02-18
|
||||
tags: ['kibana', 'canvas', 'plugins']
|
||||
related: []
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: canvasShareableWorkpads
|
||||
slug: /playground/kibana/canvas-shareable-workpads
|
||||
title: Share a Canvas Workpad on a Website
|
||||
summary: How to share a static snapshot of a workpad on an external website.
|
||||
description: How to share a static snapshot of a workpad on an external website.
|
||||
date: 2021-02-18
|
||||
tags: ['kibana', 'canvas', 'share']
|
||||
related: []
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue