diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index f729ce0fc107d..ee999b8df613f 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -58,8 +58,8 @@ Routing will be handled by the id of the dev tool - your dev tool will be mounte This API doesn't support angular, for registering angular dev tools, bootstrap a local module on mount into the given HTML element. -|{kib-repo}blob/{branch}/src/plugins/discover[discover] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/discover/README.md[discover] +|Contains the Discover application and the saved search embeddable. |{kib-repo}blob/{branch}/src/plugins/embeddable/README.md[embeddable] @@ -85,8 +85,8 @@ for use in their own application. |WARNING: Missing README. -|{kib-repo}blob/{branch}/src/plugins/input_control_vis[inputControlVis] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/input_control_vis/README.md[inputControlVis] +|Contains the input control visualization allowing to place custom filter controls on a dashboard. |{kib-repo}blob/{branch}/src/plugins/inspector/README.md[inspector] @@ -163,8 +163,9 @@ It also provides a stateful version of it on the start contract. |WARNING: Missing README. -|{kib-repo}blob/{branch}/src/plugins/timelion[timelion] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/timelion/README.md[timelion] +|Contains the deprecated timelion application. For the timelion visualization, +which also contains the timelion APIs and backend, look at the vis_type_timelion plugin. |{kib-repo}blob/{branch}/src/plugins/ui_actions/README.md[uiActions] @@ -176,48 +177,52 @@ It also provides a stateful version of it on the start contract. To integrate with the telemetry services for usage collection of your feature, there are 2 steps: -|{kib-repo}blob/{branch}/src/plugins/vis_type_markdown[visTypeMarkdown] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/vis_type_markdown/README.md[visTypeMarkdown] +|The markdown visualization that can be used to place text panels on dashboards. -|{kib-repo}blob/{branch}/src/plugins/vis_type_metric[visTypeMetric] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/vis_type_metric/README.md[visTypeMetric] +|Contains the metric visualization. -|{kib-repo}blob/{branch}/src/plugins/vis_type_table[visTypeTable] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/vis_type_table/README.md[visTypeTable] +|Contains the data table visualization, that allows presenting data in a simple table format. -|{kib-repo}blob/{branch}/src/plugins/vis_type_tagcloud[visTypeTagcloud] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/vis_type_tagcloud/README.md[visTypeTagcloud] +|Contains the tagcloud visualization. |{kib-repo}blob/{branch}/src/plugins/vis_type_timelion/README.md[visTypeTimelion] -|If your grammar was changed in public/chain.peg you need to re-generate the static parser. You could use a grunt task: +|Contains the timelion visualization and the timelion backend. -|{kib-repo}blob/{branch}/src/plugins/vis_type_timeseries[visTypeTimeseries] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/vis_type_timeseries/README.md[visTypeTimeseries] +|Contains everything around TSVB (the editor, visualizatin implementations and backends). -|{kib-repo}blob/{branch}/src/plugins/vis_type_vega[visTypeVega] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/vis_type_vega/README.md[visTypeVega] +|Contains the Vega visualization. -|{kib-repo}blob/{branch}/src/plugins/vis_type_vislib[visTypeVislib] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/vis_type_vislib/README.md[visTypeVislib] +|Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and +heatmap charts. -|{kib-repo}blob/{branch}/src/plugins/vis_type_xy[visTypeXy] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/vis_type_xy/README.md[visTypeXy] +|Contains the new xy-axis chart using the elastic-charts library, which will eventually +replace the vislib xy-axis (bar, area, line) charts. -|{kib-repo}blob/{branch}/src/plugins/visualizations[visualizations] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/visualizations/README.md[visualizations] +|Contains most of the visualization infrastructure, e.g. the visualization type registry or the +visualization embeddable. -|{kib-repo}blob/{branch}/src/plugins/visualize[visualize] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/src/plugins/visualize/README.md[visualize] +|Contains the visualize application which includes the listing page and the app frame, +which will load the visualization's editor. |=== @@ -286,16 +291,16 @@ routes, etc. |Adds drilldown capabailities to dashboard. Owned by the Kibana App team. -|{kib-repo}blob/{branch}/x-pack/plugins/dashboard_mode[dashboardMode] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/x-pack/plugins/dashboard_mode/README.md[dashboardMode] +|The deprecated dashboard only mode. |{kib-repo}blob/{branch}/x-pack/plugins/data_enhanced[dataEnhanced] |WARNING: Missing README. -|{kib-repo}blob/{branch}/x-pack/plugins/discover_enhanced[discoverEnhanced] -|WARNING: Missing README. +|{kib-repo}blob/{branch}/x-pack/plugins/discover_enhanced/README.md[discoverEnhanced] +|Contains the enhancements to the OSS discover app. |<>