From 4825941a908e43a07bf573d3fe8e82b494b9f222 Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Tue, 5 Jan 2021 12:41:18 -0500 Subject: [PATCH 1/5] Split up plugin dev docs from team docs. Add some welcome landing pages --- dev_docs/api_welcome.mdx | 15 +++++++++++++++ dev_docs/dev_welcome.mdx | 17 +++++++++++++++++ src/plugins/data/README.mdx | 2 +- 3 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 dev_docs/api_welcome.mdx create mode 100644 dev_docs/dev_welcome.mdx diff --git a/dev_docs/api_welcome.mdx b/dev_docs/api_welcome.mdx new file mode 100644 index 0000000000000..d45b011dc1cdb --- /dev/null +++ b/dev_docs/api_welcome.mdx @@ -0,0 +1,15 @@ +--- +id: kibDevDocsApiWelcome +slug: /kibana-dev-docs/api-welcome +title: Kibana plugin API documentation +summary: The home of automatically generated plugin API documentation using extracted TSDocs +date: 2021-01-02 +tags: ['kibana','dev', 'contributor', 'api docs'] +--- + +Welcome to Kibana's plugin API documentation. As a plugin developer, this is where you can +learn the details of every service you can take advantage of, to help you build awe-inspiring, creative solutions and applications! + +If you have any questions or issues, please reach out to the Kibana platform team or create an issue [here](https://github.com/elastic/kibana/issues). + + diff --git a/dev_docs/dev_welcome.mdx b/dev_docs/dev_welcome.mdx new file mode 100644 index 0000000000000..c5cbf200b71dd --- /dev/null +++ b/dev_docs/dev_welcome.mdx @@ -0,0 +1,17 @@ +--- +id: kibDevDocsWelcome +slug: /kibana-dev-docs/welcome +title: Kibana plugin developer documentation +summary: Build custom solutions and applications on top of Kibana. +date: 2021-01-02 +tags: ['kibana','dev', 'contributor'] +--- + +Welcome to Kibana's plugin developer documentation! + +Did you know that the vast majority of functionality built inside of Kibana is a plugin? A handful of core services hold the system together, +but it's our vast system of plugin developers that provide amazing, out of the box functionality, you can use when building your own set of +custom utilities and applications. + +Browse the `Services` section to view all the plugins that offer functionality you can take advantage of, or check out the +`API documentation` to dig into the nitty gritty details or every public plugin API. diff --git a/src/plugins/data/README.mdx b/src/plugins/data/README.mdx index 13bb8443ffef6..2448d5f22ced2 100644 --- a/src/plugins/data/README.mdx +++ b/src/plugins/data/README.mdx @@ -1,6 +1,6 @@ --- id: kibDataPlugin -slug: /kibana-dev-guide/services/data-plugin +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. From bac01953122e19b4e343cca546a41e24937db102 Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Tue, 5 Jan 2021 12:50:41 -0500 Subject: [PATCH 2/5] update titles --- dev_docs/api_welcome.mdx | 2 +- dev_docs/dev_welcome.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dev_docs/api_welcome.mdx b/dev_docs/api_welcome.mdx index d45b011dc1cdb..83b783d08fb60 100644 --- a/dev_docs/api_welcome.mdx +++ b/dev_docs/api_welcome.mdx @@ -1,7 +1,7 @@ --- id: kibDevDocsApiWelcome slug: /kibana-dev-docs/api-welcome -title: Kibana plugin API documentation +title: Welcome summary: The home of automatically generated plugin API documentation using extracted TSDocs date: 2021-01-02 tags: ['kibana','dev', 'contributor', 'api docs'] diff --git a/dev_docs/dev_welcome.mdx b/dev_docs/dev_welcome.mdx index c5cbf200b71dd..fb1af530dad57 100644 --- a/dev_docs/dev_welcome.mdx +++ b/dev_docs/dev_welcome.mdx @@ -1,7 +1,7 @@ --- id: kibDevDocsWelcome slug: /kibana-dev-docs/welcome -title: Kibana plugin developer documentation +title: Welcome summary: Build custom solutions and applications on top of Kibana. date: 2021-01-02 tags: ['kibana','dev', 'contributor'] From 72693a19367161ae11a58cd79e5f50eee280f7d4 Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Tue, 5 Jan 2021 12:51:20 -0500 Subject: [PATCH 3/5] sp --- dev_docs/dev_welcome.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev_docs/dev_welcome.mdx b/dev_docs/dev_welcome.mdx index fb1af530dad57..7248d4c208c5c 100644 --- a/dev_docs/dev_welcome.mdx +++ b/dev_docs/dev_welcome.mdx @@ -14,4 +14,4 @@ but it's our vast system of plugin developers that provide amazing, out of the b custom utilities and applications. Browse the `Services` section to view all the plugins that offer functionality you can take advantage of, or check out the -`API documentation` to dig into the nitty gritty details or every public plugin API. +`API documentation` to dig into the nitty gritty details of every public plugin API. From b1249a8cf0d50fbb52f5e1adf44bcaa0a7e6dbc4 Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Tue, 5 Jan 2021 19:34:55 -0500 Subject: [PATCH 4/5] Update dev_docs/dev_welcome.mdx Co-authored-by: Brandon Kobel --- dev_docs/dev_welcome.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev_docs/dev_welcome.mdx b/dev_docs/dev_welcome.mdx index 7248d4c208c5c..cc185e689fa43 100644 --- a/dev_docs/dev_welcome.mdx +++ b/dev_docs/dev_welcome.mdx @@ -10,7 +10,7 @@ tags: ['kibana','dev', 'contributor'] Welcome to Kibana's plugin developer documentation! Did you know that the vast majority of functionality built inside of Kibana is a plugin? A handful of core services hold the system together, -but it's our vast system of plugin developers that provide amazing, out of the box functionality, you can use when building your own set of +but it's our vast system of plugin developers that provide the amazing, out of the box, functionality you can use when building your own set of custom utilities and applications. Browse the `Services` section to view all the plugins that offer functionality you can take advantage of, or check out the From 108a35597364bda84c0855d8ba6825f816991997 Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Tue, 5 Jan 2021 19:35:23 -0500 Subject: [PATCH 5/5] Update dev_docs/api_welcome.mdx Co-authored-by: Brandon Kobel --- dev_docs/api_welcome.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/dev_docs/api_welcome.mdx b/dev_docs/api_welcome.mdx index 83b783d08fb60..692a1bb2e582e 100644 --- a/dev_docs/api_welcome.mdx +++ b/dev_docs/api_welcome.mdx @@ -8,8 +8,7 @@ tags: ['kibana','dev', 'contributor', 'api docs'] --- Welcome to Kibana's plugin API documentation. As a plugin developer, this is where you can -learn the details of every service you can take advantage of, to help you build awe-inspiring, creative solutions and applications! +learn the details of every service you can take advantage of to help you build awe-inspiring creative solutions and applications! If you have any questions or issues, please reach out to the Kibana platform team or create an issue [here](https://github.com/elastic/kibana/issues). -