Skip to content

Commit 3ce386a

Browse files
committed
update docs
1 parent f9fc83f commit 3ce386a

File tree

1 file changed

+41
-33
lines changed

1 file changed

+41
-33
lines changed

docs/developer/architecture/code-exploration.asciidoc

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ The Charts plugin is a way to create easier integration of shared colors, themes
5858
WARNING: Missing README.
5959
6060
61-
- {kib-repo}blob/{branch}/src/plugins/dashboard[dashboard]
61+
- {kib-repo}blob/{branch}/src/plugins/dashboard/README.md[dashboard]
6262
63-
WARNING: Missing README.
63+
Contains the dashboard application.
6464
6565
6666
- {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
7676
This API doesn't support angular, for registering angular dev tools, bootstrap a local module on mount into the given HTML element.
7777
7878
79-
- {kib-repo}blob/{branch}/src/plugins/discover[discover]
79+
- {kib-repo}blob/{branch}/src/plugins/discover/README.md[discover]
8080
81-
WARNING: Missing README.
81+
Contains the Discover application and the saved search embeddable.
8282
8383
8484
- {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"
109109
WARNING: Missing README.
110110
111111
112-
- {kib-repo}blob/{branch}/src/plugins/input_control_vis[inputControlVis]
112+
- {kib-repo}blob/{branch}/src/plugins/input_control_vis/README.md[inputControlVis]
113113
114-
WARNING: Missing README.
114+
Contains the input control visualization allowing to place custom filter controls on a dashboard.
115115
116116
117117
- {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
206206
WARNING: Missing README.
207207
208208
209-
- {kib-repo}blob/{branch}/src/plugins/timelion[timelion]
209+
- {kib-repo}blob/{branch}/src/plugins/timelion/README.md[timelion]
210210
211-
WARNING: Missing README.
211+
Contains the deprecated timelion application. For the timelion visualization,
212+
which also contains the timelion APIs and backend, look at the vis_type_timelion plugin.
212213
213214
214215
- {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
222223
To integrate with the telemetry services for usage collection of your feature, there are 2 steps:
223224
224225
225-
- {kib-repo}blob/{branch}/src/plugins/vis_type_markdown[visTypeMarkdown]
226+
- {kib-repo}blob/{branch}/src/plugins/vis_type_markdown/README.md[visTypeMarkdown]
226227
227-
WARNING: Missing README.
228+
The markdown visualization that can be used to place text panels on dashboards.
228229
229230
230-
- {kib-repo}blob/{branch}/src/plugins/vis_type_metric[visTypeMetric]
231+
- {kib-repo}blob/{branch}/src/plugins/vis_type_metric/README.md[visTypeMetric]
231232
232-
WARNING: Missing README.
233+
Contains the metric visualization.
233234
234235
235-
- {kib-repo}blob/{branch}/src/plugins/vis_type_table[visTypeTable]
236+
- {kib-repo}blob/{branch}/src/plugins/vis_type_table/README.md[visTypeTable]
236237
237-
WARNING: Missing README.
238+
Contains the data table visualization, that allows presenting data in a simple table format.
238239
239240
240-
- {kib-repo}blob/{branch}/src/plugins/vis_type_tagcloud[visTypeTagcloud]
241+
- {kib-repo}blob/{branch}/src/plugins/vis_type_tagcloud/README.md[visTypeTagcloud]
241242
242-
WARNING: Missing README.
243+
Contains the tagcloud visualization.
243244
244245
245246
- {kib-repo}blob/{branch}/src/plugins/vis_type_timelion/README.md[visTypeTimelion]
246247
247-
If your grammar was changed in public/chain.peg you need to re-generate the static parser. You could use a grunt task:
248+
Contains the timelion visualization and the timelion backend.
248249
249250
250-
- {kib-repo}blob/{branch}/src/plugins/vis_type_timeseries[visTypeTimeseries]
251+
- {kib-repo}blob/{branch}/src/plugins/vis_type_timeseries/README.md[visTypeTimeseries]
251252
252-
WARNING: Missing README.
253+
Contains everything around TSVB (the editor, visualizatin implementations and backends).
253254
254255
255-
- {kib-repo}blob/{branch}/src/plugins/vis_type_vega[visTypeVega]
256+
- {kib-repo}blob/{branch}/src/plugins/vis_type_vega/README.md[visTypeVega]
256257
257-
WARNING: Missing README.
258+
Contains the Vega visualization.
258259
259260
260-
- {kib-repo}blob/{branch}/src/plugins/vis_type_vislib[visTypeVislib]
261+
- {kib-repo}blob/{branch}/src/plugins/vis_type_vislib/README.md[visTypeVislib]
261262
262-
WARNING: Missing README.
263+
Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and
264+
heatmap charts.
263265
264266
265-
- {kib-repo}blob/{branch}/src/plugins/vis_type_xy[visTypeXy]
267+
- {kib-repo}blob/{branch}/src/plugins/vis_type_xy/README.md[visTypeXy]
266268
267-
WARNING: Missing README.
269+
Contains the new xy-axis chart using the elastic-charts library, which will eventually
270+
replace the vislib xy-axis (bar, area, line) charts.
268271
269272
270-
- {kib-repo}blob/{branch}/src/plugins/visualizations[visualizations]
273+
- {kib-repo}blob/{branch}/src/plugins/visualizations/README.md[visualizations]
271274
272-
WARNING: Missing README.
275+
Contains most of the visualization infrastructure, e.g. the visualization type registry or the
276+
visualization embeddable.
273277
274278
275-
- {kib-repo}blob/{branch}/src/plugins/visualize[visualize]
279+
- {kib-repo}blob/{branch}/src/plugins/visualize/README.md[visualize]
276280
277-
WARNING: Missing README.
281+
Contains the visualize application which includes the listing page and the app frame,
282+
which will load the visualization's editor.
278283
279284
280285
[discrete]
@@ -345,19 +350,22 @@ You can run a local cluster and simulate a remote cluster within a single Kibana
345350
346351
- {kib-repo}blob/{branch}/x-pack/plugins/dashboard_enhanced/README.md[dashboardEnhanced]
347352
348-
- {kib-repo}blob/{branch}/x-pack/plugins/dashboard_mode[dashboardMode]
353+
Contains the enhancements to the OSS dashboard app.
349354
350-
WARNING: Missing README.
355+
356+
- {kib-repo}blob/{branch}/x-pack/plugins/dashboard_mode/README.md[dashboardMode]
357+
358+
The deprecated dashboard only mode.
351359
352360
353361
- {kib-repo}blob/{branch}/x-pack/plugins/data_enhanced[dataEnhanced]
354362
355363
WARNING: Missing README.
356364
357365
358-
- {kib-repo}blob/{branch}/x-pack/plugins/discover_enhanced[discoverEnhanced]
366+
- {kib-repo}blob/{branch}/x-pack/plugins/discover_enhanced/README.md[discoverEnhanced]
359367
360-
WARNING: Missing README.
368+
Contains the enhancements to the OSS discover app.
361369
362370
363371
- {kib-repo}blob/{branch}/x-pack/plugins/embeddable_enhanced[embeddableEnhanced]

0 commit comments

Comments
 (0)