mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
* 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> # Conflicts: # .github/CODEOWNERS * update docs (#74364) * Remove CODEOWNERS Co-authored-by: Mikhail Shustov <restrry@gmail.com>
This commit is contained in:
parent
128e433357
commit
94720bbf0a
19 changed files with 65 additions and 34 deletions
|
@ -58,9 +58,9 @@ The Charts plugin is a way to create easier integration of shared colors, themes
|
|||
WARNING: Missing README.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/dashboard[dashboard]
|
||||
- {kib-repo}blob/{branch}/src/plugins/dashboard/README.md[dashboard]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains the dashboard application.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/data/README.md[data]
|
||||
|
@ -76,9 +76,9 @@ 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]
|
||||
- {kib-repo}blob/{branch}/src/plugins/discover/README.md[discover]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains the Discover application and the saved search embeddable.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/embeddable/README.md[embeddable]
|
||||
|
@ -109,9 +109,9 @@ Moves the legacy ui/registry/feature_catalogue module for registering "features"
|
|||
WARNING: Missing README.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/input_control_vis[inputControlVis]
|
||||
- {kib-repo}blob/{branch}/src/plugins/input_control_vis/README.md[inputControlVis]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains the input control visualization allowing to place custom filter controls on a dashboard.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/inspector/README.md[inspector]
|
||||
|
@ -206,9 +206,10 @@ This plugin adds the Advanced Settings section for the Usage Data collection (ak
|
|||
WARNING: Missing README.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/timelion[timelion]
|
||||
- {kib-repo}blob/{branch}/src/plugins/timelion/README.md[timelion]
|
||||
|
||||
WARNING: Missing README.
|
||||
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]
|
||||
|
@ -222,59 +223,63 @@ Usage Collection allows collecting usage data for other services to consume (tel
|
|||
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]
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_markdown/README.md[visTypeMarkdown]
|
||||
|
||||
WARNING: Missing README.
|
||||
The markdown visualization that can be used to place text panels on dashboards.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_metric[visTypeMetric]
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_metric/README.md[visTypeMetric]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains the metric visualization.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_table[visTypeTable]
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_table/README.md[visTypeTable]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains the data table visualization, that allows presenting data in a simple table format.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_tagcloud[visTypeTagcloud]
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_tagcloud/README.md[visTypeTagcloud]
|
||||
|
||||
WARNING: Missing README.
|
||||
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]
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_timeseries/README.md[visTypeTimeseries]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains everything around TSVB (the editor, visualizatin implementations and backends).
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_vega[visTypeVega]
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_vega/README.md[visTypeVega]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains the Vega visualization.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_vislib[visTypeVislib]
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_vislib/README.md[visTypeVislib]
|
||||
|
||||
WARNING: Missing README.
|
||||
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]
|
||||
- {kib-repo}blob/{branch}/src/plugins/vis_type_xy/README.md[visTypeXy]
|
||||
|
||||
WARNING: Missing README.
|
||||
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]
|
||||
- {kib-repo}blob/{branch}/src/plugins/visualizations/README.md[visualizations]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains most of the visualization infrastructure, e.g. the visualization type registry or the
|
||||
visualization embeddable.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/src/plugins/visualize[visualize]
|
||||
- {kib-repo}blob/{branch}/src/plugins/visualize/README.md[visualize]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains the visualize application which includes the listing page and the app frame,
|
||||
which will load the visualization's editor.
|
||||
|
||||
|
||||
[discrete]
|
||||
|
@ -345,9 +350,12 @@ You can run a local cluster and simulate a remote cluster within a single Kibana
|
|||
|
||||
- {kib-repo}blob/{branch}/x-pack/plugins/dashboard_enhanced/README.md[dashboardEnhanced]
|
||||
|
||||
- {kib-repo}blob/{branch}/x-pack/plugins/dashboard_mode[dashboardMode]
|
||||
Contains the enhancements to the OSS dashboard app.
|
||||
|
||||
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]
|
||||
|
@ -355,9 +363,9 @@ WARNING: Missing README.
|
|||
WARNING: Missing README.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/x-pack/plugins/discover_enhanced[discoverEnhanced]
|
||||
- {kib-repo}blob/{branch}/x-pack/plugins/discover_enhanced/README.md[discoverEnhanced]
|
||||
|
||||
WARNING: Missing README.
|
||||
Contains the enhancements to the OSS discover app.
|
||||
|
||||
|
||||
- {kib-repo}blob/{branch}/x-pack/plugins/embeddable_enhanced[embeddableEnhanced]
|
||||
|
|
1
src/plugins/dashboard/README.md
Normal file
1
src/plugins/dashboard/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
Contains the dashboard application.
|
1
src/plugins/discover/README.md
Normal file
1
src/plugins/discover/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
Contains the Discover application and the saved search embeddable.
|
1
src/plugins/input_control_vis/README.md
Normal file
1
src/plugins/input_control_vis/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
Contains the input control visualization allowing to place custom filter controls on a dashboard.
|
2
src/plugins/timelion/README.md
Normal file
2
src/plugins/timelion/README.md
Normal file
|
@ -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.
|
1
src/plugins/vis_type_markdown/README.md
Normal file
1
src/plugins/vis_type_markdown/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
The markdown visualization that can be used to place text panels on dashboards.
|
1
src/plugins/vis_type_metric/README.md
Normal file
1
src/plugins/vis_type_metric/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
Contains the metric visualization.
|
1
src/plugins/vis_type_table/README.md
Normal file
1
src/plugins/vis_type_table/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
Contains the data table visualization, that allows presenting data in a simple table format.
|
1
src/plugins/vis_type_tagcloud/README.md
Normal file
1
src/plugins/vis_type_tagcloud/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
Contains the tagcloud visualization.
|
|
@ -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:
|
||||
|
||||
|
|
1
src/plugins/vis_type_timeseries/README.md
Normal file
1
src/plugins/vis_type_timeseries/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
Contains everything around TSVB (the editor, visualizatin implementations and backends).
|
1
src/plugins/vis_type_vega/README.md
Normal file
1
src/plugins/vis_type_vega/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
Contains the Vega visualization.
|
2
src/plugins/vis_type_vislib/README.md
Normal file
2
src/plugins/vis_type_vislib/README.md
Normal file
|
@ -0,0 +1,2 @@
|
|||
Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and
|
||||
heatmap charts.
|
2
src/plugins/vis_type_xy/README.md
Normal file
2
src/plugins/vis_type_xy/README.md
Normal file
|
@ -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.
|
2
src/plugins/visualizations/README.md
Normal file
2
src/plugins/visualizations/README.md
Normal file
|
@ -0,0 +1,2 @@
|
|||
Contains most of the visualization infrastructure, e.g. the visualization type registry or the
|
||||
visualization embeddable.
|
2
src/plugins/visualize/README.md
Normal file
2
src/plugins/visualize/README.md
Normal file
|
@ -0,0 +1,2 @@
|
|||
Contains the visualize application which includes the listing page and the app frame,
|
||||
which will load the visualization's editor.
|
|
@ -1 +1 @@
|
|||
# X-Pack part of Dashboard app
|
||||
Contains the enhancements to the OSS dashboard app.
|
1
x-pack/plugins/dashboard_mode/README.md
Normal file
1
x-pack/plugins/dashboard_mode/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
The deprecated dashboard only mode.
|
1
x-pack/plugins/discover_enhanced/README.md
Normal file
1
x-pack/plugins/discover_enhanced/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
Contains the enhancements to the OSS discover app.
|
Loading…
Add table
Add a link
Reference in a new issue