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: 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']
|
||||
---
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue