github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.18] Fix plugin list for 8.x (asciidoc-based) docs (#215671) (#215703)

Browse source 
# Backport

This will backport the following commits from `8.x` to `8.18`:
- [Fix plugin list for 8.x (asciidoc-based) docs
(#215671)](https://github.com/elastic/kibana/pull/215671)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Gerard
Soldevila","email":"gerard.soldevila@elastic.co"},"sourceCommit":{"committedDate":"2025-03-24T13:33:38Z","message":"Fix
plugin list for 8.x (asciidoc-based) docs (#215671)\n\n##
Summary\n\nApply the same fixes as
https://github.com/elastic/kibana/pull/215648,\nbut for 8.x
series.","sha":"35f17542d096452067bf792d99ed60fc0c981759","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","backport:all-open"],"title":"Fix
plugin list for 8.x (asciidoc-based)
docs","number":215671,"url":"https://github.com/elastic/kibana/pull/215671","mergeCommit":{"message":"Fix
plugin list for 8.x (asciidoc-based) docs (#215671)\n\n##
Summary\n\nApply the same fixes as
https://github.com/elastic/kibana/pull/215648,\nbut for 8.x
series.","sha":"35f17542d096452067bf792d99ed60fc0c981759"}},"sourceBranch":"8.x","suggestedTargetBranches":[],"targetPullRequestStates":[]}]
BACKPORT-->
This commit is contained in:
Gerard Soldevila 2025-03-25 11:44:32 +01:00 • committed by GitHub
parent e49cff31cb
commit dae17b1f42
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 28 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

42
docs/developer/plugin-list.asciidoc
View file

@ -74,7 +74,7 @@ as uiSettings within the code.
|{kib-repo}blob/{branch}/src/platform/plugins/shared/data_view_management[dataViewManagement]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/shared/data_views/README.mdx[dataViews]
@ -107,7 +107,7 @@ This API doesn't support angular, for registering angular dev tools, bootstrap a
|{kib-repo}blob/{branch}/src/platform/plugins/shared/esql_datagrid/README.md[esqlDataGrid]
|Contains a Discover-like table specifically for ES|QL queries:
|Contains a Discover-like table specifically for ES\|QL queries:
|{kib-repo}blob/{branch}/src/platform/plugins/shared/es_ui_shared/README.md[esUiShared]
@ -127,11 +127,11 @@ This API doesn't support angular, for registering angular dev tools, bootstrap a
|{kib-repo}blob/{branch}/src/platform/plugins/shared/chart_expressions/expression_gauge[expressionGauge]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/shared/chart_expressions/expression_heatmap[expressionHeatmap]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/shared/expression_image/README.md[expressionImage]
@ -389,11 +389,11 @@ The plugin exposes the static DefaultEditorController class to consume.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/gauge[visTypeGauge]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/heatmap[visTypeHeatmap]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_type_markdown/README.md[visTypeMarkdown]
@ -401,11 +401,11 @@ The plugin exposes the static DefaultEditorController class to consume.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/metric[visTypeMetric]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/pie[visTypePie]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/table/README.md[visTypeTable]
@ -413,7 +413,7 @@ The plugin exposes the static DefaultEditorController class to consume.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/tagcloud[visTypeTagcloud]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/timelion/README.md[visTypeTimelion]
@ -421,23 +421,23 @@ The plugin exposes the static DefaultEditorController class to consume.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/timeseries[visTypeTimeseries]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/vega[visTypeVega]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/vislib[visTypeVislib]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/private/vis_types/xy[visTypeXy]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/src/platform/plugins/shared/visualizations[visualizations]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|===
@ -468,7 +468,7 @@ The plugin exposes the static DefaultEditorController class to consume.
|{kib-repo}blob/{branch}/x-pack/solutions/observability/plugins/apm_data_access[apmDataAccess]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/x-pack/platform/plugins/private/banners/README.md[banners]
@ -602,7 +602,7 @@ activities.
|{kib-repo}blob/{branch}/x-pack/platform/plugins/private/file_upload[fileUpload]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/x-pack/platform/plugins/shared/fleet/README.md[fleet]
@ -667,11 +667,11 @@ the infrastructure monitoring use-case within Kibana.
|{kib-repo}blob/{branch}/x-pack/solutions/observability/plugins/investigate/README.md[investigate]
|undefined
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/x-pack/solutions/observability/plugins/investigate_app/README.md[investigateApp]
|undefined
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/x-pack/solutions/security/plugins/kubernetes_security/README.md[kubernetesSecurity]
@ -716,7 +716,7 @@ using the CURL scripts in the scripts folder.
|{kib-repo}blob/{branch}/x-pack/platform/plugins/private/logstash[logstash]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/x-pack/platform/plugins/shared/maps/README.md[maps]
@ -789,7 +789,7 @@ Elastic.
|{kib-repo}blob/{branch}/x-pack/solutions/observability/plugins/profiling_data_access[profilingDataAccess]
|WARNING: Missing README.
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/x-pack/platform/plugins/private/remote_clusters/README.md[remoteClusters]
@ -884,7 +884,7 @@ This plugin is only enabled when the application is built for serverless project
|{kib-repo}blob/{branch}/x-pack/platform/plugins/shared/serverless/README.mdx[serverless]
|
|WARNING: Missing or empty README.
|{kib-repo}blob/{branch}/x-pack/solutions/observability/plugins/serverless_observability/README.mdx[serverlessObservability]

10
src/platform/packages/shared/kbn-dev-utils/src/plugin_list/generate_plugin_list.ts
View file

@ -16,6 +16,10 @@ import { Plugins } from './discover_plugins';
const sortPlugins = (plugins: Plugins) => plugins.sort((a, b) => a.id.localeCompare(b.id));
function markdownEscape(snippet: string): string {
return snippet.replaceAll('|', '\\|');
}
function* printPlugins(plugins: Plugins, includes: string[]) {
for (const plugin of sortPlugins(plugins)) {
const path = normalizePath(plugin.relativeReadmePath || plugin.relativeDir);
@ -29,9 +33,9 @@ function* printPlugins(plugins: Plugins, includes: string[]) {
yield `|{kib-repo}blob/{branch}/${path}[${plugin.id}]`;
}
yield plugin.relativeReadmePath === undefined
? '|WARNING: Missing README.'
: `|${plugin.readmeSnippet}`;
yield plugin.relativeReadmePath && plugin.readmeSnippet
? `|${markdownEscape(plugin.readmeSnippet)}`
: '|WARNING: Missing or empty README.';
yield '';
}