diff --git a/STYLEGUIDE.mdx b/STYLEGUIDE.mdx index b06cfa44a4973..8e043cba92249 100644 --- a/STYLEGUIDE.mdx +++ b/STYLEGUIDE.mdx @@ -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'] --- diff --git a/dev_docs/contributing/best_practices.mdx b/dev_docs/contributing/best_practices.mdx index 3e7fca5539d77..16c66417b89c1 100644 --- a/dev_docs/contributing/best_practices.mdx +++ b/dev_docs/contributing/best_practices.mdx @@ -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'] --- diff --git a/dev_docs/contributing/code_walkthrough.mdx b/dev_docs/contributing/code_walkthrough.mdx index 74995c246503c..bae394887c20e 100644 --- a/dev_docs/contributing/code_walkthrough.mdx +++ b/dev_docs/contributing/code_walkthrough.mdx @@ -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'] --- diff --git a/dev_docs/contributing/dev_principles.mdx b/dev_docs/contributing/dev_principles.mdx index 0b8f68d232367..cbea79e658684 100644 --- a/dev_docs/contributing/dev_principles.mdx +++ b/dev_docs/contributing/dev_principles.mdx @@ -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'] --- diff --git a/dev_docs/contributing/documentation.mdx b/dev_docs/contributing/documentation.mdx index caf2f439548bc..50cc0c8761400 100644 --- a/dev_docs/contributing/documentation.mdx +++ b/dev_docs/contributing/documentation.mdx @@ -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'] --- diff --git a/dev_docs/contributing/how_we_use_github.mdx b/dev_docs/contributing/how_we_use_github.mdx index 339eebc89197b..d427ba7d44f2e 100644 --- a/dev_docs/contributing/how_we_use_github.mdx +++ b/dev_docs/contributing/how_we_use_github.mdx @@ -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'] --- diff --git a/dev_docs/contributing/standards.mdx b/dev_docs/contributing/standards.mdx index cef9199aee924..1bb54ada1509c 100644 --- a/dev_docs/contributing/standards.mdx +++ b/dev_docs/contributing/standards.mdx @@ -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'] --- diff --git a/dev_docs/getting_started/dev_welcome.mdx b/dev_docs/getting_started/dev_welcome.mdx index 4080e0850b946..4f5115af6b731 100644 --- a/dev_docs/getting_started/dev_welcome.mdx +++ b/dev_docs/getting_started/dev_welcome.mdx @@ -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'] --- diff --git a/dev_docs/getting_started/hello_world_plugin.mdx b/dev_docs/getting_started/hello_world_plugin.mdx index 8fa4ea4316129..08fd7e4a721c2 100644 --- a/dev_docs/getting_started/hello_world_plugin.mdx +++ b/dev_docs/getting_started/hello_world_plugin.mdx @@ -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'] --- diff --git a/dev_docs/getting_started/setting_up_a_development_env.mdx b/dev_docs/getting_started/setting_up_a_development_env.mdx index bbbb356d9ea08..8599adf0e53b3 100644 --- a/dev_docs/getting_started/setting_up_a_development_env.mdx +++ b/dev_docs/getting_started/setting_up_a_development_env.mdx @@ -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'] --- diff --git a/dev_docs/getting_started/troubleshooting.mdx b/dev_docs/getting_started/troubleshooting.mdx index b224a3200eefb..cb0e1bad1bef5 100644 --- a/dev_docs/getting_started/troubleshooting.mdx +++ b/dev_docs/getting_started/troubleshooting.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/anatomy_of_a_plugin.mdx b/dev_docs/key_concepts/anatomy_of_a_plugin.mdx index f99c41ff18d07..a126477ea4c2f 100644 --- a/dev_docs/key_concepts/anatomy_of_a_plugin.mdx +++ b/dev_docs/key_concepts/anatomy_of_a_plugin.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/audit_logging.mdx b/dev_docs/key_concepts/audit_logging.mdx index 6ec4de320d582..5546e52bf5dd8 100644 --- a/dev_docs/key_concepts/audit_logging.mdx +++ b/dev_docs/key_concepts/audit_logging.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/building_blocks.mdx b/dev_docs/key_concepts/building_blocks.mdx index aeb2d2be7d6c9..5a7b79b93debf 100644 --- a/dev_docs/key_concepts/building_blocks.mdx +++ b/dev_docs/key_concepts/building_blocks.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/data_views.mdx b/dev_docs/key_concepts/data_views.mdx index 6a0c2a701fae2..59853f8e0c67e 100644 --- a/dev_docs/key_concepts/data_views.mdx +++ b/dev_docs/key_concepts/data_views.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/embeddables.mdx b/dev_docs/key_concepts/embeddables.mdx index 2d5e14b7d4669..f1a2bea5b9b12 100644 --- a/dev_docs/key_concepts/embeddables.mdx +++ b/dev_docs/key_concepts/embeddables.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/kibana_platform_plugin_intro.mdx b/dev_docs/key_concepts/kibana_platform_plugin_intro.mdx index 417d6e4983d4f..98de7d082bc55 100644 --- a/dev_docs/key_concepts/kibana_platform_plugin_intro.mdx +++ b/dev_docs/key_concepts/kibana_platform_plugin_intro.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/navigation.mdx b/dev_docs/key_concepts/navigation.mdx index 6f3a5e737f91f..e383f21187d41 100644 --- a/dev_docs/key_concepts/navigation.mdx +++ b/dev_docs/key_concepts/navigation.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/performance.mdx b/dev_docs/key_concepts/performance.mdx index c57630f508dcd..4d808ed402d32 100644 --- a/dev_docs/key_concepts/performance.mdx +++ b/dev_docs/key_concepts/performance.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/persistable_state.mdx b/dev_docs/key_concepts/persistable_state.mdx index 25d3f37a86be4..75dae5447ffa0 100644 --- a/dev_docs/key_concepts/persistable_state.mdx +++ b/dev_docs/key_concepts/persistable_state.mdx @@ -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'] --- diff --git a/dev_docs/key_concepts/saved_objects.mdx b/dev_docs/key_concepts/saved_objects.mdx index 159e6e90a4037..ee974267c0bb9 100644 --- a/dev_docs/key_concepts/saved_objects.mdx +++ b/dev_docs/key_concepts/saved_objects.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/advanced_settings.mdx b/dev_docs/tutorials/advanced_settings.mdx index b0c12ad5e5edd..d14da92edc93c 100644 --- a/dev_docs/tutorials/advanced_settings.mdx +++ b/dev_docs/tutorials/advanced_settings.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/building_a_kibana_distributable.mdx b/dev_docs/tutorials/building_a_kibana_distributable.mdx index e73481058ab35..d95f6246434b9 100644 --- a/dev_docs/tutorials/building_a_kibana_distributable.mdx +++ b/dev_docs/tutorials/building_a_kibana_distributable.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/ci.mdx b/dev_docs/tutorials/ci.mdx index 32e5a8503a22c..6598ed9855dc0 100644 --- a/dev_docs/tutorials/ci.mdx +++ b/dev_docs/tutorials/ci.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/data/search.mdx b/dev_docs/tutorials/data/search.mdx index d422eb811b60b..4c64dc0b02164 100644 --- a/dev_docs/tutorials/data/search.mdx +++ b/dev_docs/tutorials/data/search.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/data_views.mdx b/dev_docs/tutorials/data_views.mdx index eda4b34ac2fd4..51aac0e321692 100644 --- a/dev_docs/tutorials/data_views.mdx +++ b/dev_docs/tutorials/data_views.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/debugging.mdx b/dev_docs/tutorials/debugging.mdx index d5d86a9025303..fabd475f88d77 100644 --- a/dev_docs/tutorials/debugging.mdx +++ b/dev_docs/tutorials/debugging.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/development_windows.mdx b/dev_docs/tutorials/development_windows.mdx index 0a39714dfd8ec..ea872072057a3 100644 --- a/dev_docs/tutorials/development_windows.mdx +++ b/dev_docs/tutorials/development_windows.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/endpoints.mdx b/dev_docs/tutorials/endpoints.mdx index ab7aeda0e5693..851c3046fead6 100644 --- a/dev_docs/tutorials/endpoints.mdx +++ b/dev_docs/tutorials/endpoints.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/expressions.mdx b/dev_docs/tutorials/expressions.mdx index d9abf3dd57eb8..36df396306cac 100644 --- a/dev_docs/tutorials/expressions.mdx +++ b/dev_docs/tutorials/expressions.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/kibana_page_template.mdx b/dev_docs/tutorials/kibana_page_template.mdx index f7169ea33cea7..5c037f4f3d062 100644 --- a/dev_docs/tutorials/kibana_page_template.mdx +++ b/dev_docs/tutorials/kibana_page_template.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/saved_objects.mdx b/dev_docs/tutorials/saved_objects.mdx index a9d8cd7c6ec1c..f922077cb5e54 100644 --- a/dev_docs/tutorials/saved_objects.mdx +++ b/dev_docs/tutorials/saved_objects.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/screenshotting.mdx b/dev_docs/tutorials/screenshotting.mdx index 76f2859928491..5d506e2cb13b4 100644 --- a/dev_docs/tutorials/screenshotting.mdx +++ b/dev_docs/tutorials/screenshotting.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/submit_a_pull_request.mdx b/dev_docs/tutorials/submit_a_pull_request.mdx index f7d530f6cec66..0402a533b2498 100644 --- a/dev_docs/tutorials/submit_a_pull_request.mdx +++ b/dev_docs/tutorials/submit_a_pull_request.mdx @@ -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'] --- diff --git a/dev_docs/tutorials/testing_plugins.mdx b/dev_docs/tutorials/testing_plugins.mdx index b43fa19927cc4..4fbfd1b257443 100644 --- a/dev_docs/tutorials/testing_plugins.mdx +++ b/dev_docs/tutorials/testing_plugins.mdx @@ -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'] --- diff --git a/packages/home/sample_data_card/README.mdx b/packages/home/sample_data_card/README.mdx index 5e2fa83830573..a4cf6faddfac2 100644 --- a/packages/home/sample_data_card/README.mdx +++ b/packages/home/sample_data_card/README.mdx @@ -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 --- diff --git a/packages/home/sample_data_tab/README.mdx b/packages/home/sample_data_tab/README.mdx index 7ad4ad5dab3e0..8e9b6a373129b 100644 --- a/packages/home/sample_data_tab/README.mdx +++ b/packages/home/sample_data_tab/README.mdx @@ -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 --- diff --git a/packages/kbn-docs-utils/src/api_docs/auto_generated_warning.ts b/packages/kbn-docs-utils/src/api_docs/auto_generated_warning.ts new file mode 100644 index 0000000000000..055648f7b5669 --- /dev/null +++ b/packages/kbn-docs-utils/src/api_docs/auto_generated_warning.ts @@ -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. +####`; diff --git a/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc_by_api.ts b/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc_by_api.ts index 156e09b2fce1b..06532dc8a027f 100644 --- a/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc_by_api.ts +++ b/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc_by_api.ts @@ -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 diff --git a/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc_by_plugin.ts b/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc_by_plugin.ts index e79c109311c0b..d25a42d7de50e 100644 --- a/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc_by_plugin.ts +++ b/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc_by_plugin.ts @@ -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} `); diff --git a/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_due_by_team.ts b/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_due_by_team.ts index 712dd9c8e637f..2defdb49aeaa0 100644 --- a/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_due_by_team.ts +++ b/packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_due_by_team.ts @@ -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} `); diff --git a/packages/kbn-docs-utils/src/api_docs/mdx/write_plugin_directory_doc.ts b/packages/kbn-docs-utils/src/api_docs/mdx/write_plugin_directory_doc.ts index c98621356439c..129e1212625e3 100644 --- a/packages/kbn-docs-utils/src/api_docs/mdx/write_plugin_directory_doc.ts +++ b/packages/kbn-docs-utils/src/api_docs/mdx/write_plugin_directory_doc.ts @@ -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
public API | Number of teams | +| Count | Plugins or Packages with a
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
comments | Missing
exports | +| Plugin name           | Maintaining team | Description | API Cnt | Any Cnt | Missing
comments | Missing
exports | |--------------|----------------|-----------|--------------|----------|---------------|--------| ${getDirectoryTable(pluginApiMap, pluginStatsMap, true)} ## Package Directory -| Package name           | Maintaining team | Description | API Cnt | Any Cnt | Missing
comments | Missing
exports | +| Package name           | Maintaining team | Description | API Cnt | Any Cnt | Missing
comments | Missing
exports | |--------------|----------------|-----------|--------------|----------|---------------|--------| ${getDirectoryTable(pluginApiMap, pluginStatsMap, false)} diff --git a/packages/kbn-docs-utils/src/api_docs/mdx/write_plugin_mdx_docs.ts b/packages/kbn-docs-utils/src/api_docs/mdx/write_plugin_mdx_docs.ts index 562d2a8981764..da65c9f6b3357 100644 --- a/packages/kbn-docs-utils/src/api_docs/mdx/write_plugin_mdx_docs.ts +++ b/packages/kbn-docs-utils/src/api_docs/mdx/write_plugin_mdx_docs.ts @@ -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'; diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.mdx b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.mdx index 6a66fa74f7c01..b72bb38869f78 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.mdx +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.mdx @@ -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'; diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.mdx b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.mdx index 4082de6306895..f1b79e0d69ce5 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.mdx +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.mdx @@ -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'; diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.mdx b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.mdx index d69da971f7e3e..2d0c28885f8d3 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.mdx +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.mdx @@ -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'; diff --git a/packages/kbn-shared-ux-components/README.mdx b/packages/kbn-shared-ux-components/README.mdx index 8fee1571e5220..f4673a0804f31 100644 --- a/packages/kbn-shared-ux-components/README.mdx +++ b/packages/kbn-shared-ux-components/README.mdx @@ -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'] --- diff --git a/packages/kbn-shared-ux-components/src/page_template/page_template.mdx b/packages/kbn-shared-ux-components/src/page_template/page_template.mdx index 59acf8910cf29..fbaada158e277 100644 --- a/packages/kbn-shared-ux-components/src/page_template/page_template.mdx +++ b/packages/kbn-shared-ux-components/src/page_template/page_template.mdx @@ -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 --- diff --git a/packages/kbn-shared-ux-services/README.mdx b/packages/kbn-shared-ux-services/README.mdx index 2ef3040128c87..589aae4cc7ed2 100755 --- a/packages/kbn-shared-ux-services/README.mdx +++ b/packages/kbn-shared-ux-services/README.mdx @@ -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'] --- diff --git a/packages/kbn-shared-ux-storybook/README.mdx b/packages/kbn-shared-ux-storybook/README.mdx index cfebeedcd1ac3..11992e336e627 100644 --- a/packages/kbn-shared-ux-storybook/README.mdx +++ b/packages/kbn-shared-ux-storybook/README.mdx @@ -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'] --- diff --git a/packages/kbn-shared-ux-utility/README.mdx b/packages/kbn-shared-ux-utility/README.mdx index a3a3ee965f699..ec91bc4b16ab8 100644 --- a/packages/kbn-shared-ux-utility/README.mdx +++ b/packages/kbn-shared-ux-utility/README.mdx @@ -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'] --- diff --git a/packages/shared-ux/avatar/solution/README.mdx b/packages/shared-ux/avatar/solution/README.mdx index 841274441f6ed..86f5bed3cc8c2 100644 --- a/packages/shared-ux/avatar/solution/README.mdx +++ b/packages/shared-ux/avatar/solution/README.mdx @@ -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 --- diff --git a/packages/shared-ux/button/exit_full_screen/impl/README.mdx b/packages/shared-ux/button/exit_full_screen/impl/README.mdx index 03a885ba6151c..790cff6a72f23 100644 --- a/packages/shared-ux/button/exit_full_screen/impl/README.mdx +++ b/packages/shared-ux/button/exit_full_screen/impl/README.mdx @@ -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 --- diff --git a/packages/shared-ux/button_toolbar/README.mdx b/packages/shared-ux/button_toolbar/README.mdx index fb693dab44498..c073ef003cda4 100644 --- a/packages/shared-ux/button_toolbar/README.mdx +++ b/packages/shared-ux/button_toolbar/README.mdx @@ -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 --- diff --git a/packages/shared-ux/button_toolbar/src/popover/popover.mdx b/packages/shared-ux/button_toolbar/src/popover/popover.mdx index d1ade51485ae4..dcdeb01de3f04 100644 --- a/packages/shared-ux/button_toolbar/src/popover/popover.mdx +++ b/packages/shared-ux/button_toolbar/src/popover/popover.mdx @@ -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 --- diff --git a/packages/shared-ux/card/no_data/impl/README.mdx b/packages/shared-ux/card/no_data/impl/README.mdx index e2b044c27ac44..02b626fcc700b 100644 --- a/packages/shared-ux/card/no_data/impl/README.mdx +++ b/packages/shared-ux/card/no_data/impl/README.mdx @@ -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 --- diff --git a/packages/shared-ux/link/redirect_app/impl/README.mdx b/packages/shared-ux/link/redirect_app/impl/README.mdx index 07d4f75ab764d..337ea5e0d8450 100644 --- a/packages/shared-ux/link/redirect_app/impl/README.mdx +++ b/packages/shared-ux/link/redirect_app/impl/README.mdx @@ -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 --- diff --git a/packages/shared-ux/page/analytics_no_data/impl/README.mdx b/packages/shared-ux/page/analytics_no_data/impl/README.mdx index 6ba0e9298c264..0d5a5bae445ef 100644 --- a/packages/shared-ux/page/analytics_no_data/impl/README.mdx +++ b/packages/shared-ux/page/analytics_no_data/impl/README.mdx @@ -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 --- diff --git a/packages/shared-ux/page/kibana_no_data/impl/README.mdx b/packages/shared-ux/page/kibana_no_data/impl/README.mdx index afa1bd95c19bd..bc5dc37ac679a 100644 --- a/packages/shared-ux/page/kibana_no_data/impl/README.mdx +++ b/packages/shared-ux/page/kibana_no_data/impl/README.mdx @@ -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 --- diff --git a/packages/shared-ux/page/solution_nav/README.mdx b/packages/shared-ux/page/solution_nav/README.mdx index abad92c1e4108..6ddd8462237ba 100644 --- a/packages/shared-ux/page/solution_nav/README.mdx +++ b/packages/shared-ux/page/solution_nav/README.mdx @@ -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 --- diff --git a/packages/shared-ux/prompt/no_data_views/impl/README.mdx b/packages/shared-ux/prompt/no_data_views/impl/README.mdx index a2bc63fed0765..26facfce8d86e 100644 --- a/packages/shared-ux/prompt/no_data_views/impl/README.mdx +++ b/packages/shared-ux/prompt/no_data_views/impl/README.mdx @@ -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 --- diff --git a/src/core/server/deprecations/README.mdx b/src/core/server/deprecations/README.mdx index ed542610e753f..2594bd2f0dd6b 100644 --- a/src/core/server/deprecations/README.mdx +++ b/src/core/server/deprecations/README.mdx @@ -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'] --- diff --git a/src/core/server/logging/README.mdx b/src/core/server/logging/README.mdx index 11437d1e8df20..9b3cf8f77e24e 100644 --- a/src/core/server/logging/README.mdx +++ b/src/core/server/logging/README.mdx @@ -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'] --- diff --git a/src/plugins/controls/README.mdx b/src/plugins/controls/README.mdx index 46ba1ed3ba9e7..d6805e814e7ff 100644 --- a/src/plugins/controls/README.mdx +++ b/src/plugins/controls/README.mdx @@ -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: [] diff --git a/src/plugins/data/README.mdx b/src/plugins/data/README.mdx index a8cb06ff9e60b..ca1bd6fd98954 100644 --- a/src/plugins/data/README.mdx +++ b/src/plugins/data/README.mdx @@ -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'] --- diff --git a/src/plugins/data_views/README.mdx b/src/plugins/data_views/README.mdx index 7fdd435db746e..6d2ef4c97bb33 100644 --- a/src/plugins/data_views/README.mdx +++ b/src/plugins/data_views/README.mdx @@ -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'] --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/default_value.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/default_value.mdx index 5e03d6ad16528..be5dc8034d039 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/default_value.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/default_value.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/field_hook.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/field_hook.mdx index c7be88c4336a6..8532a1857871c 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/field_hook.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/field_hook.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/form_component.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/form_component.mdx index df479b5c72f37..db642ef846fca 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/form_component.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/form_component.mdx @@ -2,7 +2,7 @@ id: formLibCoreFormComponent slug: /form-lib/core/form-component title:
-summary: The boundary of your form +description: The boundary of your form tags: ['forms', 'kibana', 'dev'] date: 2021-04-14 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/form_hook.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/form_hook.mdx index 46fac236123fd..824f9f6671384 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/form_hook.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/form_hook.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/fundamentals.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/fundamentals.mdx index c168cb4115bc2..4276519c54e87 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/fundamentals.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/fundamentals.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/use_array.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/use_array.mdx index b92880fdf806d..ca849fd067ccb 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/use_array.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/use_array.mdx @@ -2,7 +2,7 @@ id: formLibCoreUseArray slug: /form-lib/core/use-array title: -summary: The perfect companion to generate dynamic fields +description: The perfect companion to generate dynamic fields tags: ['forms', 'kibana', 'dev'] date: 2021-04-14 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/use_behavior_subject.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/use_behavior_subject.mdx index f7eca9c360ac4..40190343f5bfe 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/use_behavior_subject.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/use_behavior_subject.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/use_field.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/use_field.mdx index dd073e0b38d1f..d5729dc778816 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/use_field.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/use_field.mdx @@ -2,7 +2,7 @@ id: formLibCoreUseField slug: /form-lib/core/use-field title: -summary: Drop it anywhere in your and see the magic happen +description: Drop it anywhere in your and see the magic happen tags: ['forms', 'kibana', 'dev'] date: 2021-04-14 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/use_form_data.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/use_form_data.mdx index 0deb449591871..2e5f628a86370 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/use_form_data.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/use_form_data.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/use_form_hook.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/use_form_hook.mdx index 21c77afd6dbce..82cd0c88834a3 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/use_form_hook.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/use_form_hook.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/use_form_is_modified.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/use_form_is_modified.mdx index d90b9100a04af..d7c0603cc07c5 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/use_form_is_modified.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/use_form_is_modified.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/core/use_multi_fields.mdx b/src/plugins/es_ui_shared/static/forms/docs/core/use_multi_fields.mdx index 2a16b8e878be8..281db05d5f1a6 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/core/use_multi_fields.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/core/use_multi_fields.mdx @@ -2,7 +2,7 @@ id: formLibCoreUseMultiFields slug: /form-lib/core/use-multi-fields title: -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/examples/dynamic_fields.mdx b/src/plugins/es_ui_shared/static/forms/docs/examples/dynamic_fields.mdx index f2525d5a16fba..82516423424f6 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/examples/dynamic_fields.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/examples/dynamic_fields.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/examples/fields_composition.mdx b/src/plugins/es_ui_shared/static/forms/docs/examples/fields_composition.mdx index 260908f94a790..7e7cce5e81332 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/examples/fields_composition.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/examples/fields_composition.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/examples/listening_to_changes.mdx b/src/plugins/es_ui_shared/static/forms/docs/examples/listening_to_changes.mdx index c99184f5a5c0e..6574a7ca4e2d1 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/examples/listening_to_changes.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/examples/listening_to_changes.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/examples/serializers_deserializers.mdx b/src/plugins/es_ui_shared/static/forms/docs/examples/serializers_deserializers.mdx index 393711b393e0f..dd3b402e85e3f 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/examples/serializers_deserializers.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/examples/serializers_deserializers.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/examples/style_fields.mdx b/src/plugins/es_ui_shared/static/forms/docs/examples/style_fields.mdx index db7c98772eddb..81ed07ffd5daf 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/examples/style_fields.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/examples/style_fields.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/examples/validation.mdx b/src/plugins/es_ui_shared/static/forms/docs/examples/validation.mdx index 0f4e9617d9af3..c45cae8602f19 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/examples/validation.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/examples/validation.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/helpers/components.mdx b/src/plugins/es_ui_shared/static/forms/docs/helpers/components.mdx index 1b35e41a98739..97ea955aaecb1 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/helpers/components.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/helpers/components.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/helpers/validators.mdx b/src/plugins/es_ui_shared/static/forms/docs/helpers/validators.mdx index aba2d6dffb1ba..7fbe4c4e38dc3 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/helpers/validators.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/helpers/validators.mdx @@ -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 --- diff --git a/src/plugins/es_ui_shared/static/forms/docs/welcome.mdx b/src/plugins/es_ui_shared/static/forms/docs/welcome.mdx index 2d1156f403bff..8a356868e49c2 100644 --- a/src/plugins/es_ui_shared/static/forms/docs/welcome.mdx +++ b/src/plugins/es_ui_shared/static/forms/docs/welcome.mdx @@ -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 --- diff --git a/src/plugins/presentation_util/README.mdx b/src/plugins/presentation_util/README.mdx index 2cbb03232b9dd..2fc73204db4e1 100755 --- a/src/plugins/presentation_util/README.mdx +++ b/src/plugins/presentation_util/README.mdx @@ -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: [] diff --git a/src/plugins/share/README.mdx b/src/plugins/share/README.mdx index 1a1fef0587812..bb4433b54b480 100644 --- a/src/plugins/share/README.mdx +++ b/src/plugins/share/README.mdx @@ -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'] --- diff --git a/src/plugins/shared_ux/docs/about.mdx b/src/plugins/shared_ux/docs/about.mdx index a31a9b99195f2..213ce774be217 100644 --- a/src/plugins/shared_ux/docs/about.mdx +++ b/src/plugins/shared_ux/docs/about.mdx @@ -2,7 +2,7 @@ id: sharedUX/About slug: /shared-ux/about title: About Shared UX -summary: . +description: . date: 2021-01-05 tags: ['shared-ux'] --- diff --git a/src/plugins/usage_collection/README.mdx b/src/plugins/usage_collection/README.mdx index 03d8f7badb8c2..a703a3de00820 100644 --- a/src/plugins/usage_collection/README.mdx +++ b/src/plugins/usage_collection/README.mdx @@ -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'] --- diff --git a/x-pack/plugins/canvas/PLUGINS.mdx b/x-pack/plugins/canvas/PLUGINS.mdx index 77fe65f864607..c0e0bc9c92f5a 100644 --- a/x-pack/plugins/canvas/PLUGINS.mdx +++ b/x-pack/plugins/canvas/PLUGINS.mdx @@ -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: [] diff --git a/x-pack/plugins/canvas/shareable_runtime/README.mdx b/x-pack/plugins/canvas/shareable_runtime/README.mdx index a9d58bb3833d9..07fbe7af27825 100644 --- a/x-pack/plugins/canvas/shareable_runtime/README.mdx +++ b/x-pack/plugins/canvas/shareable_runtime/README.mdx @@ -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: []