Add README files for Kibana app plugins (#74277)

* Add README files for Kibana app plugins * Update src/plugins/timelion/README.md Co-authored-by: Matthias Wilhelm <ankertal@gmail.com> * Update src/plugins/vis_type_vislib/README.md Co-authored-by: Matthias Wilhelm <ankertal@gmail.com> Co-authored-by: Matthias Wilhelm <ankertal@gmail.com>
elastic · Aug 5, 2020 · f9fc83f · f9fc83f
1 parent 7a1b09d
commit f9fc83f
Show file tree

Hide file tree

Showing 19 changed files with 24 additions and 2 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -7,7 +7,6 @@
 /x-pack/plugins/discover_enhanced/ @elastic/kibana-app
 /x-pack/plugins/lens/ @elastic/kibana-app
 /x-pack/plugins/graph/ @elastic/kibana-app
-/src/legacy/core_plugins/kibana/public/local_application_service/ @elastic/kibana-app
 /src/plugins/dashboard/ @elastic/kibana-app
 /src/plugins/discover/ @elastic/kibana-app
 /src/plugins/input_control_vis/ @elastic/kibana-app

diff --git a/src/plugins/dashboard/README.md b/src/plugins/dashboard/README.md
@@ -0,0 +1 @@
+Contains the dashboard application.
diff --git a/src/plugins/discover/README.md b/src/plugins/discover/README.md
@@ -0,0 +1 @@
+Contains the Discover application and the saved search embeddable.
diff --git a/src/plugins/input_control_vis/README.md b/src/plugins/input_control_vis/README.md
@@ -0,0 +1 @@
+Contains the input control visualization allowing to place custom filter controls on a dashboard.
diff --git a/src/plugins/timelion/README.md b/src/plugins/timelion/README.md
@@ -0,0 +1,2 @@
+Contains the deprecated timelion application. For the timelion visualization,
+which also contains the timelion APIs and backend, look at the vis_type_timelion plugin.
diff --git a/src/plugins/vis_type_markdown/README.md b/src/plugins/vis_type_markdown/README.md
@@ -0,0 +1 @@
+The markdown visualization that can be used to place text panels on dashboards.
diff --git a/src/plugins/vis_type_metric/README.md b/src/plugins/vis_type_metric/README.md
@@ -0,0 +1 @@
+Contains the metric visualization.
diff --git a/src/plugins/vis_type_table/README.md b/src/plugins/vis_type_table/README.md
@@ -0,0 +1 @@
+Contains the data table visualization, that allows presenting data in a simple table format.
diff --git a/src/plugins/vis_type_tagcloud/README.md b/src/plugins/vis_type_tagcloud/README.md
@@ -0,0 +1 @@
+Contains the tagcloud visualization.
diff --git a/src/plugins/vis_type_timelion/README.md b/src/plugins/vis_type_timelion/README.md
@@ -1,5 +1,7 @@
 # Vis type Timelion
 
+Contains the timelion visualization and the timelion backend.
+
 # Generate a parser
 If your grammar was changed in `public/chain.peg` you need to re-generate the static parser. You could use a grunt task:
 

diff --git a/src/plugins/vis_type_timeseries/README.md b/src/plugins/vis_type_timeseries/README.md
@@ -0,0 +1 @@
+Contains everything around TSVB (the editor, visualizatin implementations and backends).
diff --git a/src/plugins/vis_type_vega/README.md b/src/plugins/vis_type_vega/README.md
@@ -0,0 +1 @@
+Contains the Vega visualization.
diff --git a/src/plugins/vis_type_vislib/README.md b/src/plugins/vis_type_vislib/README.md
@@ -0,0 +1,2 @@
+Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and 
+heatmap charts.
diff --git a/src/plugins/vis_type_xy/README.md b/src/plugins/vis_type_xy/README.md
@@ -0,0 +1,2 @@
+Contains the new xy-axis chart using the elastic-charts library, which will eventually
+replace the vislib xy-axis (bar, area, line) charts.
diff --git a/src/plugins/visualizations/README.md b/src/plugins/visualizations/README.md
@@ -0,0 +1,2 @@
+Contains most of the visualization infrastructure, e.g. the visualization type registry or the 
+visualization embeddable.
diff --git a/src/plugins/visualize/README.md b/src/plugins/visualize/README.md
@@ -0,0 +1,2 @@
+Contains the visualize application which includes the listing page and the app frame,
+which will load the visualization's editor.
diff --git a/x-pack/plugins/dashboard_enhanced/README.md b/x-pack/plugins/dashboard_enhanced/README.md
@@ -1 +1 @@
-# X-Pack part of Dashboard app
+Contains the enhancements to the OSS dashboard app.
diff --git a/x-pack/plugins/dashboard_mode/README.md b/x-pack/plugins/dashboard_mode/README.md
@@ -0,0 +1 @@
+The deprecated dashboard only mode.
diff --git a/x-pack/plugins/discover_enhanced/README.md b/x-pack/plugins/discover_enhanced/README.md
@@ -0,0 +1 @@
+Contains the enhancements to the OSS discover app.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Contains the Discover application and the saved search embeddable.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Contains the input control visualization allowing to place custom filter controls on a dashboard.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Contains the deprecated timelion application. For the timelion visualization,
		which also contains the timelion APIs and backend, look at the vis_type_timelion plugin.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		The markdown visualization that can be used to place text panels on dashboards.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Contains the data table visualization, that allows presenting data in a simple table format.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Contains everything around TSVB (the editor, visualizatin implementations and backends).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and
		heatmap charts.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Contains the new xy-axis chart using the elastic-charts library, which will eventually
		replace the vislib xy-axis (bar, area, line) charts.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Contains most of the visualization infrastructure, e.g. the visualization type registry or the
		visualization embeddable.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Contains the visualize application which includes the listing page and the app frame,
		which will load the visualization's editor.