Skip to content

Commit

Permalink
Add platform's missing READMEs (#82268)
Browse files Browse the repository at this point in the history
* add missing readme

* update ascidoc
  • Loading branch information
pgayvallet authored Nov 5, 2020
1 parent ef650f4 commit 926fe89
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/developer/plugin-list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand All @@ -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]
Expand Down
3 changes: 3 additions & 0 deletions src/plugins/legacy_export/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `legacyExport` plugin

The `legacyExport` plugin adds support for the legacy saved objects export format.
3 changes: 3 additions & 0 deletions src/plugins/saved_objects/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `savedObjects` plugin

The `savedObjects` plugin exposes utilities to manipulate saved objects on the client side.
3 changes: 3 additions & 0 deletions src/plugins/saved_objects_management/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `savedObjectsManagement` plugin

The `savedObjectsManagement` plugin manages the `Saved Objects` management section.
3 changes: 3 additions & 0 deletions x-pack/plugins/cloud/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `cloud` plugin

The `cloud` plugin adds cloud specific features to Kibana.
3 changes: 3 additions & 0 deletions x-pack/plugins/features/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `features` plugin

The `features` plugin enhance Kibana with a per-feature privilege system.
15 changes: 15 additions & 0 deletions x-pack/plugins/global_search_providers/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 926fe89

Please sign in to comment.