From 926fe8915dcb1e1bcfb1519f3ef6dd86c344978a Mon Sep 17 00:00:00 2001 From: Pierre Gayvallet Date: Thu, 5 Nov 2020 10:40:15 +0100 Subject: [PATCH] Add platform's missing READMEs (#82268) * add missing readme * update ascidoc --- docs/developer/plugin-list.asciidoc | 24 +++++++++---------- src/plugins/legacy_export/README.md | 3 +++ src/plugins/saved_objects/README.md | 3 +++ .../saved_objects_management/README.md | 3 +++ x-pack/plugins/cloud/README.md | 3 +++ x-pack/plugins/features/README.md | 3 +++ .../plugins/global_search_providers/README.md | 15 ++++++++++++ 7 files changed, 42 insertions(+), 12 deletions(-) create mode 100644 src/plugins/legacy_export/README.md create mode 100644 src/plugins/saved_objects/README.md create mode 100644 src/plugins/saved_objects_management/README.md create mode 100644 x-pack/plugins/cloud/README.md create mode 100644 x-pack/plugins/features/README.md create mode 100644 x-pack/plugins/global_search_providers/README.md diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 9a32f3b3adb3c..9235fc1198b12 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -128,8 +128,8 @@ in Kibana, e.g. visualizations. It has the form of a flyout panel. |Utilities for building Kibana plugins. -|{kib-repo}blob/{branch}/src/plugins/legacy_export[legacyExport] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/legacy_export/README.md[legacyExport] +|The legacyExport plugin adds support for the legacy saved objects export format. |{kib-repo}blob/{branch}/src/plugins/management/README.md[management] @@ -156,12 +156,12 @@ Content is fetched from the remote (https://feeds.elastic.co and https://feeds-s |Create choropleth maps. Display the results of a term-aggregation as e.g. countries, zip-codes, states. -|{kib-repo}blob/{branch}/src/plugins/saved_objects[savedObjects] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/saved_objects/README.md[savedObjects] +|The savedObjects plugin exposes utilities to manipulate saved objects on the client side. -|{kib-repo}blob/{branch}/src/plugins/saved_objects_management[savedObjectsManagement] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/saved_objects_management/README.md[savedObjectsManagement] +|The savedObjectsManagement plugin manages the Saved Objects management section. |{kib-repo}blob/{branch}/src/plugins/saved_objects_tagging_oss/README.md[savedObjectsTaggingOss] @@ -309,8 +309,8 @@ Failure to have auth enabled in Kibana will make for a broken UI. UI-based error |Experimental Feature -|{kib-repo}blob/{branch}/x-pack/plugins/cloud[cloud] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/x-pack/plugins/cloud/README.md[cloud] +|The cloud plugin adds cloud specific features to Kibana. |{kib-repo}blob/{branch}/x-pack/plugins/code[code] @@ -361,8 +361,8 @@ occuring in Kibana, initially just for the Make It Action project - alerts and actions. -|{kib-repo}blob/{branch}/x-pack/plugins/features[features] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/x-pack/plugins/features/README.md[features] +|The features plugin enhance Kibana with a per-feature privilege system. |{kib-repo}blob/{branch}/x-pack/plugins/file_upload/README.md[fileUpload] @@ -378,8 +378,8 @@ or dashboards from the Kibana instance, from both server and client-side plugins |The GlobalSearchBar plugin provides a search interface for navigating Kibana. (It is the UI to the GlobalSearch plugin.) -|{kib-repo}blob/{branch}/x-pack/plugins/global_search_providers[globalSearchProviders] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/x-pack/plugins/global_search_providers/README.md[globalSearchProviders] +|The globalSearchProviders plugin provides Kibana default search providers for the GlobalSearch plugin. |{kib-repo}blob/{branch}/x-pack/plugins/graph/README.md[graph] diff --git a/src/plugins/legacy_export/README.md b/src/plugins/legacy_export/README.md new file mode 100644 index 0000000000000..050e39b8f19e4 --- /dev/null +++ b/src/plugins/legacy_export/README.md @@ -0,0 +1,3 @@ +# `legacyExport` plugin + +The `legacyExport` plugin adds support for the legacy saved objects export format. diff --git a/src/plugins/saved_objects/README.md b/src/plugins/saved_objects/README.md new file mode 100644 index 0000000000000..2f8dd44a2c5fa --- /dev/null +++ b/src/plugins/saved_objects/README.md @@ -0,0 +1,3 @@ +# `savedObjects` plugin + +The `savedObjects` plugin exposes utilities to manipulate saved objects on the client side. \ No newline at end of file diff --git a/src/plugins/saved_objects_management/README.md b/src/plugins/saved_objects_management/README.md new file mode 100644 index 0000000000000..cdaf027e7d2de --- /dev/null +++ b/src/plugins/saved_objects_management/README.md @@ -0,0 +1,3 @@ +# `savedObjectsManagement` plugin + +The `savedObjectsManagement` plugin manages the `Saved Objects` management section. diff --git a/x-pack/plugins/cloud/README.md b/x-pack/plugins/cloud/README.md new file mode 100644 index 0000000000000..13172e0a6ddc0 --- /dev/null +++ b/x-pack/plugins/cloud/README.md @@ -0,0 +1,3 @@ +# `cloud` plugin + +The `cloud` plugin adds cloud specific features to Kibana. diff --git a/x-pack/plugins/features/README.md b/x-pack/plugins/features/README.md new file mode 100644 index 0000000000000..0951b0c13c314 --- /dev/null +++ b/x-pack/plugins/features/README.md @@ -0,0 +1,3 @@ +# `features` plugin + +The `features` plugin enhance Kibana with a per-feature privilege system. \ No newline at end of file diff --git a/x-pack/plugins/global_search_providers/README.md b/x-pack/plugins/global_search_providers/README.md new file mode 100644 index 0000000000000..da78f5adbfb09 --- /dev/null +++ b/x-pack/plugins/global_search_providers/README.md @@ -0,0 +1,15 @@ +# Kibana `GlobalSearchProviders` plugin + +The globalSearchProviders plugin provides Kibana default search providers for the `GlobalSearch` plugin. + +## Server-side providers + +### SavedObjects + +This provider returns results for all saved object types that are searchable. + +## Client-side providers + +### Applications + +This provider returns results for the applications that are currently registered on the client-side.