From 7eb17bcccae0881d794f02ceb39bf80e5709810b Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 18 Jul 2023 09:10:12 +0100 Subject: [PATCH] Explicitly set all front matter labels in the source files (#71548) * Set every page to have defaults of 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry * Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels Signed-off-by: Jack Baldry * Set administration/enterprise-licensing pages to have 'Enterprise' labels Signed-off-by: Jack Baldry * Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry * Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry * Set administration/recorded-queries pages to have labels cloud,enterprise * Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise Signed-off-by: Jack Baldry * Set administration/stats-and-license pages to have labels cloud,enterprise * Set alerting pages to have labels cloud,enterprise,oss * Set breaking-changes pages to have labels cloud,enterprise,oss * Set dashboards pages to have labels cloud,enterprise,oss * Set datasources pages to have labels cloud,enterprise,oss * Set explore pages to have labels cloud,enterprise,oss * Set fundamentals pages to have labels cloud,enterprise,oss * Set introduction/grafana-cloud pages to have labels cloud Signed-off-by: Jack Baldry * Fix introduction pages products Signed-off-by: Jack Baldry * Set panels-visualizations pages to have labels cloud,enterprise,oss * Set release-notes pages to have labels cloud,enterprise,oss * Set search pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise Signed-off-by: Jack Baldry * Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss Signed-off-by: Jack Baldry * Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise Signed-off-by: Jack Baldry * Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise Signed-off-by: Jack Baldry * Set troubleshooting pages to have labels cloud,enterprise,oss * Set whatsnew pages to have labels cloud,enterprise,oss * Apply updated labels from review Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Signed-off-by: Jack Baldry Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --- docs/sources/_index.md | 197 +----------------- docs/sources/administration/_index.md | 4 + docs/sources/administration/api-keys/index.md | 4 + .../administration/correlations/_index.md | 8 +- .../index.md | 6 +- .../correlation-configuration/index.md | 4 + .../correlation-permissions/index.md | 4 + .../create-a-new-correlation/index.md | 4 + .../index.md | 4 + .../index.md | 4 + .../data-source-management/index.md | 4 + .../enterprise-licensing/_index.md | 4 + .../_index.md | 4 + .../activate-license-on-ecs/index.md | 4 + .../activate-license-on-eks/index.md | 4 + .../index.md | 4 + .../index.md | 4 + .../transfer-ge-license/index.md | 4 + .../organization-management/index.md | 4 + .../organization-preferences/index.md | 4 + .../administration/plugin-management/index.md | 4 + .../administration/provisioning/index.md | 4 + .../administration/recorded-queries/index.md | 4 + .../roles-and-permissions/_index.md | 4 + .../access-control/_index.md | 4 + .../access-control/assign-rbac-roles/index.md | 4 + .../access-control/configure-rbac/index.md | 4 + .../custom-role-actions-scopes/index.md | 4 + .../access-control/manage-rbac-roles/index.md | 4 + .../plan-rbac-rollout-strategy/index.md | 4 + .../index.md | 4 + .../rbac-grafana-provisioning/index.md | 4 + .../rbac-terraform-provisioning/index.md | 4 + .../access-control/troubleshooting/index.md | 3 +- .../administration/service-accounts/index.md | 4 + .../administration/stats-and-license/index.md | 4 + .../administration/team-management/index.md | 4 + .../administration/user-management/_index.md | 4 + .../manage-dashboard-permissions/index.md | 4 + .../user-management/manage-org-users/index.md | 4 + .../server-user-management/_index.md | 4 + .../add-remove-user-to-org/index.md | 4 + .../index.md | 4 + .../change-user-org-permissions/index.md | 4 + .../grant-editor-admin-permissions/index.md | 4 + .../user-management/user-preferences/index.md | 4 + docs/sources/alerting/_index.md | 5 + .../sources/alerting/alerting-rules/_index.md | 7 +- .../create-grafana-managed-rule.md | 5 + ...reate-mimir-loki-managed-recording-rule.md | 5 + .../create-mimir-loki-managed-rule.md | 5 + .../create-notification-policy.md | 5 + .../edit-mimir-loki-namespace-group.md | 5 + .../manage-contact-points/_index.md | 5 + .../configure-integrations.md | 5 + .../manage-contact-points/webhook-notifier.md | 5 + docs/sources/alerting/difference-old-new.md | 5 + docs/sources/alerting/fundamentals/_index.md | 7 +- .../fundamentals/alert-rules/_index.md | 5 + .../alert-rules/alert-instances.md | 5 + .../alert-rules/alert-rule-types.md | 5 + .../alert-rules/message-templating.md | 5 + .../alert-rules/organising-alerts.md | 5 + .../alert-rules/queries-conditions/_index.md | 9 +- .../alert-rules/rule-evaluation/_index.md | 9 +- .../alert-rules/state-and-health.md | 5 + .../alerting/fundamentals/alertmanager.md | 5 + .../fundamentals/annotation-label/_index.md | 5 + .../annotation-label/how-to-use-labels.md | 5 + .../labels-and-label-matchers.md | 7 +- .../variables-label-annotation.md | 5 + .../fundamentals/contact-points/index.md | 5 + .../fundamentals/data-source-alerting.md | 5 + .../fundamentals/evaluate-grafana-alerts.md | 5 + .../fundamentals/high-availability/_index.md | 5 + .../notification-policies/_index.md | 9 +- .../notification-policies/notifications.md | 5 + .../alerting/manage-notifications/_index.md | 7 +- .../manage-notifications/create-silence.md | 5 + .../declare-incident-from-alert.md | 5 + .../images-in-notifications.md | 5 + .../manage-notifications/mute-timings.md | 5 + .../template-notifications/_index.md | 7 +- .../create-notification-templates.md | 7 +- .../template-notifications/reference.md | 7 +- .../use-notification-templates.md | 7 +- .../using-go-templating-language.md | 7 +- .../manage-notifications/view-alert-groups.md | 5 + .../manage-notifications/view-alert-rules.md | 5 + .../view-notification-errors.md | 7 +- .../manage-notifications/view-state-health.md | 5 + docs/sources/alerting/set-up/_index.md | 4 +- .../configure-alert-state-history/index.md | 8 +- .../set-up/configure-alertmanager/index.md | 4 + .../configure-high-availability/_index.md | 4 + .../alerting/set-up/meta-monitoring/_index.md | 4 + .../set-up/migrating-alerts/_index.md | 4 + .../legacy-alerting-deprecation.md | 8 +- .../legacy-alerting/_index.md | 4 + .../grafana-cloud-alerting/_index.md | 3 + .../grafana-cloud-alerting/alertmanager.md | 5 + .../create-edit-rules.md | 5 + .../namespaces-and-groups.md | 5 + .../grafana-cloud-alerting/silences.md | 5 + .../view-filter-rules.md | 5 + .../set-up/performance-limitations/index.md | 5 + .../provision-alerting-resources/_index.md | 5 + .../file-provisioning/index.md | 5 + .../terraform-provisioning/index.md | 4 + .../view-provisioned-resources/index.md | 7 +- .../alerting/set-up/set-up-cloud/_index.md | 2 +- docs/sources/breaking-changes/_index.md | 5 + .../breaking-changes-v10-0.md | 5 + docs/sources/cli.md | 4 + docs/sources/dashboards/_index.md | 5 + .../assess-dashboard-usage/index.md | 4 + .../dashboards/build-dashboards/_index.md | 11 +- .../annotate-visualizations/index.md | 5 + .../build-dashboards/best-practices/index.md | 5 + .../create-dashboard-url-variables/index.md | 5 + .../create-dashboard/index.md | 5 + .../manage-dashboard-links/index.md | 5 + .../manage-library-panels/index.md | 5 + .../manage-version-history/index.md | 5 + .../modify-dashboard-settings/index.md | 11 +- .../view-dashboard-json-model/index.md | 5 + .../create-manage-playlists/index.md | 5 + .../dashboards/dashboard-public/index.md | 5 + .../dashboards/manage-dashboards/index.md | 5 + .../share-dashboards-panels/index.md | 5 + .../dashboards/use-dashboards/index.md | 5 + docs/sources/dashboards/variables/_index.md | 5 + .../variables/add-template-variables/index.md | 5 + .../variables/inspect-variable/index.md | 5 + .../variables/variable-syntax/index.md | 5 + docs/sources/datasources/_index.md | 5 + .../datasources/alertmanager/_index.md | 5 + .../datasources/aws-cloudwatch/_index.md | 5 + .../aws-authentication/index.md | 5 + .../aws-cloudwatch/query-editor/index.md | 5 + .../template-variables/index.md | 5 + .../datasources/azure-monitor/_index.md | 5 + .../azure-monitor/query-editor/index.md | 5 + .../azure-monitor/template-variables/index.md | 5 + .../datasources/elasticsearch/_index.md | 5 + .../elasticsearch/query-editor/index.md | 5 + .../elasticsearch/template-variables/index.md | 5 + .../google-cloud-monitoring/_index.md | 5 + .../google-authentication/index.md | 5 + .../query-editor/index.md | 5 + .../template-variables/index.md | 5 + docs/sources/datasources/grafana-pyroscope.md | 5 + docs/sources/datasources/graphite/_index.md | 5 + .../graphite/query-editor/index.md | 5 + .../graphite/template-variables/index.md | 5 + docs/sources/datasources/influxdb/_index.md | 5 + .../influxdb/query-editor/index.md | 5 + .../influxdb/template-variables/index.md | 5 + docs/sources/datasources/jaeger/_index.md | 5 + docs/sources/datasources/loki/_index.md | 5 + .../datasources/loki/query-editor/index.md | 5 + .../loki/template-variables/index.md | 5 + docs/sources/datasources/mssql/_index.md | 5 + .../datasources/mssql/query-editor/index.md | 5 + .../mssql/template-variables/index.md | 5 + docs/sources/datasources/mysql/_index.md | 5 + docs/sources/datasources/opentsdb/_index.md | 5 + docs/sources/datasources/parca.md | 5 + docs/sources/datasources/postgres/_index.md | 5 + docs/sources/datasources/prometheus/_index.md | 5 + .../configure-prometheus-data-source.md | 5 + .../prometheus/query-editor/index.md | 5 + .../prometheus/template-variables/index.md | 5 + docs/sources/datasources/tempo/_index.md | 5 + .../datasources/tempo/query-editor/index.md | 5 + docs/sources/datasources/testdata/_index.md | 5 + docs/sources/datasources/zipkin/_index.md | 5 + docs/sources/developers/_index.md | 4 + .../developers/angular_deprecation/_index.md | 4 + .../angular_deprecation/angular-plugins.md | 4 + docs/sources/developers/cla.md | 4 + docs/sources/developers/contribute.md | 4 + docs/sources/developers/http_api/_index.md | 4 + .../developers/http_api/access_control.md | 4 + docs/sources/developers/http_api/admin.md | 4 + docs/sources/developers/http_api/alerting.md | 4 + .../alerting_notification_channels.md | 4 + .../http_api/alerting_provisioning.md | 4 + .../developers/http_api/annotations.md | 4 + docs/sources/developers/http_api/auth.md | 4 + .../developers/http_api/correlations.md | 4 + .../http_api/create-api-tokens-for-org.md | 4 + .../developers/http_api/curl-examples.md | 4 + docs/sources/developers/http_api/dashboard.md | 4 + .../http_api/dashboard_permissions.md | 4 + .../developers/http_api/dashboard_versions.md | 4 + .../developers/http_api/data_source.md | 4 + .../http_api/datasource_permissions.md | 4 + docs/sources/developers/http_api/folder.md | 4 + .../http_api/folder_dashboard_search.md | 4 + .../developers/http_api/folder_permissions.md | 4 + .../developers/http_api/library_element.md | 4 + docs/sources/developers/http_api/licensing.md | 4 + docs/sources/developers/http_api/org.md | 4 + docs/sources/developers/http_api/other.md | 4 + docs/sources/developers/http_api/playlist.md | 4 + .../developers/http_api/preferences.md | 4 + .../http_api/query_and_resource_caching.md | 4 + .../developers/http_api/query_history.md | 4 + docs/sources/developers/http_api/reporting.md | 4 + .../developers/http_api/serviceaccount.md | 4 + docs/sources/developers/http_api/short_url.md | 4 + docs/sources/developers/http_api/snapshot.md | 4 + docs/sources/developers/http_api/team.md | 4 + docs/sources/developers/http_api/team_sync.md | 4 + docs/sources/developers/http_api/user.md | 4 + docs/sources/developers/kinds/_index.md | 15 +- .../developers/kinds/composable/_index.md | 4 + .../alertgroups/panelcfg/schema-reference.md | 18 +- .../alertgroupspanelcfg/schema-reference.md | 18 +- .../panelcfg/schema-reference.md | 18 +- .../schema-reference.md | 18 +- .../dataquery/schema-reference.md | 16 +- .../azuremonitordataquery/schema-reference.md | 16 +- .../barchart/panelcfg/schema-reference.md | 68 +++--- .../barchartpanelcfg/schema-reference.md | 68 +++--- .../bargauge/panelcfg/schema-reference.md | 44 ++-- .../bargaugepanelcfg/schema-reference.md | 44 ++-- .../candlestick/panelcfg/schema-reference.md | 130 ++++++------ .../candlestickpanelcfg/schema-reference.md | 54 ++--- .../canvas/panelcfg/schema-reference.md | 48 +++-- .../cloudwatch/dataquery/schema-reference.md | 16 +- .../cloudwatchdataquery/schema-reference.md | 16 +- .../panelcfg/schema-reference.md | 18 +- .../dashboardlistpanelcfg/schema-reference.md | 18 +- .../datagrid/panelcfg/schema-reference.md | 18 +- .../datagridpanelcfg/schema-reference.md | 18 +- .../debug/panelcfg/schema-reference.md | 20 +- .../debugpanelcfg/schema-reference.md | 20 +- .../dataquery/schema-reference.md | 186 +++++++++-------- .../schema-reference.md | 186 +++++++++-------- .../gauge/panelcfg/schema-reference.md | 44 ++-- .../gaugepanelcfg/schema-reference.md | 44 ++-- .../geomap/panelcfg/schema-reference.md | 28 +-- .../geomappanelcfg/schema-reference.md | 28 +-- .../dataquery/schema-reference.md | 16 +- .../schema-reference.md | 16 +- .../dataquery/schema-reference.md | 16 +- .../schema-reference.md | 16 +- .../heatmap/panelcfg/schema-reference.md | 102 ++++----- .../heatmappanelcfg/schema-reference.md | 102 ++++----- .../histogram/panelcfg/schema-reference.md | 60 +++--- .../histogrampanelcfg/schema-reference.md | 60 +++--- .../logs/panelcfg/schema-reference.md | 18 +- .../logspanelcfg/schema-reference.md | 18 +- .../loki/dataquery/schema-reference.md | 16 +- .../lokidataquery/schema-reference.md | 16 +- .../news/panelcfg/schema-reference.md | 18 +- .../newspanelcfg/schema-reference.md | 18 +- .../nodegraph/panelcfg/schema-reference.md | 24 ++- .../nodegraphpanelcfg/schema-reference.md | 24 ++- .../parca/dataquery/schema-reference.md | 16 +- .../parcadataquery/schema-reference.md | 16 +- .../piechart/panelcfg/schema-reference.md | 76 +++---- .../piechartpanelcfg/schema-reference.md | 76 +++---- .../prometheus/dataquery/schema-reference.md | 16 +- .../prometheusdataquery/schema-reference.md | 16 +- .../stat/panelcfg/schema-reference.md | 44 ++-- .../panelcfg/schema-reference.md | 42 ++-- .../statetimelinepanelcfg/schema-reference.md | 42 ++-- .../statpanelcfg/schema-reference.md | 44 ++-- .../panelcfg/schema-reference.md | 42 ++-- .../statushistorypanelcfg/schema-reference.md | 42 ++-- .../table/panelcfg/schema-reference.md | 22 +- .../tablepanelcfg/schema-reference.md | 22 +- .../tempo/dataquery/schema-reference.md | 16 +- .../tempodataquery/schema-reference.md | 16 +- .../testdata/dataquery/schema-reference.md | 32 +-- .../testdatadataquery/schema-reference.md | 32 +-- .../text/panelcfg/schema-reference.md | 20 +- .../textpanelcfg/schema-reference.md | 20 +- .../timeseries/panelcfg/schema-reference.md | 126 +++++------ .../timeseriespanelcfg/schema-reference.md | 126 +++++------ .../trend/panelcfg/schema-reference.md | 122 +++++------ .../trendpanelcfg/schema-reference.md | 122 +++++------ .../xychart/panelcfg/schema-reference.md | 116 ++++++----- .../xychartpanelcfg/schema-reference.md | 124 +++++------ docs/sources/developers/kinds/core/_index.md | 4 + .../core/accesspolicy/schema-reference.md | 58 +++--- .../kinds/core/dashboard/schema-reference.md | 162 +++++++------- .../kinds/core/folder/schema-reference.md | 48 +++-- .../core/librarypanel/schema-reference.md | 54 ++--- .../kinds/core/playlist/schema-reference.md | 50 +++-- .../core/preferences/schema-reference.md | 50 +++-- .../core/publicdashboard/schema-reference.md | 48 +++-- .../kinds/core/role/schema-reference.md | 48 +++-- .../core/rolebinding/schema-reference.md | 56 ++--- .../core/serviceaccount/schema-reference.md | 48 +++-- .../kinds/core/team/schema-reference.md | 48 +++-- docs/sources/developers/kinds/maturity.md | 124 +++++------ docs/sources/developers/plugins/_index.md | 8 +- .../plugins/create-a-grafana-plugin/_index.md | 10 +- .../develop-a-plugin/_index.md | 10 +- .../build-a-data-source-backend-plugin.md | 8 +- .../build-a-data-source-plugin.md | 8 +- .../build-a-logs-data-source-plugin.md | 8 +- .../build-a-panel-plugin-with-d3.md | 8 +- .../develop-a-plugin/build-a-panel-plugin.md | 8 +- .../build-a-streaming-data-source-plugin.md | 6 +- .../develop-a-plugin/build-an-app-plugin.md | 8 +- .../working-with-data-frames.md | 6 +- .../extend-a-plugin/_index.md | 10 +- .../add-anonymous-usage-reporting.md | 8 +- ...-authentication-for-data-source-plugins.md | 14 +- ...distributed-tracing-for-backend-plugins.md | 8 +- .../extend-a-plugin/add-query-editor-help.md | 8 +- .../add-support-for-annotations.md | 8 +- .../add-support-for-explore-queries.md | 6 +- .../add-support-for-variables.md | 6 +- .../extend-a-plugin/cross-plugin-linking.md | 8 +- .../custom-panel-option-editors.md | 6 +- .../extend-the-grafana-ui-with-links.md | 8 +- .../get-started-with-plugins/_index.md | 10 +- .../development-with-local-grafana.md | 6 +- .../_index.md | 10 +- .../backend/_index.md | 9 +- .../backend/grafana-plugin-sdk-for-go.md | 9 +- .../backend/plugin-protocol.md | 9 +- .../data-frames.md | 6 +- .../error-handling.md | 6 +- .../developers/plugins/legacy/_index.md | 6 +- .../sources/developers/plugins/legacy/apps.md | 8 +- .../developers/plugins/legacy/data-sources.md | 8 +- .../legacy/defaults-and-editor-mode.md | 6 +- .../developers/plugins/legacy/panels.md | 8 +- .../plugins/legacy/review-guidelines.md | 6 +- .../plugins/legacy/snapshot-mode.md | 6 +- .../developers/plugins/legacy/style-guide.md | 6 +- docs/sources/developers/plugins/metadata.md | 8 +- .../plugins/migration-guide/_index.md | 6 +- .../migration-guide/angular-react/_index.md | 8 +- .../migration-guide/v10.0.x-v10.1.x/_index.md | 6 +- .../migration-guide/v6.x-v7.x/_index.md | 8 +- .../migration-guide/v7.x-v8.x/_index.md | 8 +- .../migration-guide/v8.3.x-8.4.x/_index.md | 8 +- .../migration-guide/v8.x-v9.x/_index.md | 8 +- .../migration-guide/v9.1.x-v9.2.x/_index.md | 8 +- .../migration-guide/v9.3.x-9.4.x/_index.md | 8 +- .../migration-guide/v9.x-v10.x/_index.md | 8 +- .../developers/plugins/plugin-spellcheck.md | 6 +- .../plugins/publish-a-plugin/_index.md | 10 +- .../publish-a-plugin/package-a-plugin.md | 12 +- .../publish-or-update-a-plugin.md | 8 +- .../publishing-and-signing-criteria.md | 8 +- .../plugins/publish-a-plugin/sign-a-plugin.md | 6 +- docs/sources/explore/_index.md | 5 + docs/sources/explore/explore-inspector.md | 5 + docs/sources/explore/logs-integration.md | 5 + docs/sources/explore/query-management.md | 5 + docs/sources/explore/trace-integration.md | 5 + docs/sources/fundamentals/_index.md | 7 +- .../fundamentals/dashboards-overview/index.md | 7 +- docs/sources/fundamentals/exemplars/index.md | 5 + docs/sources/fundamentals/glossary/index.md | 5 + .../fundamentals/intro-histograms/index.md | 5 + .../fundamentals/intro-to-prometheus/index.md | 5 + .../timeseries-dimensions/index.md | 5 + docs/sources/fundamentals/timeseries/index.md | 5 + docs/sources/getting-started/_index.md | 6 +- .../getting-started/build-first-dashboard.md | 4 + .../get-started-grafana-influxdb.md | 4 + .../get-started-grafana-ms-sql-server.md | 4 + .../get-started-grafana-prometheus.md | 4 + docs/sources/introduction/_index.md | 7 +- docs/sources/introduction/grafana-cloud.md | 5 +- .../introduction/grafana-enterprise.md | 3 + docs/sources/old-alerting/_index.md | 4 + .../old-alerting/add-notification-template.md | 4 + docs/sources/old-alerting/create-alerts.md | 4 + docs/sources/old-alerting/notifications.md | 4 + .../old-alerting/pause-an-alert-rule.md | 4 + .../old-alerting/troubleshoot-alerts.md | 4 + docs/sources/old-alerting/view-alerts.md | 6 +- docs/sources/panels-visualizations/_index.md | 5 + .../calculation-types/index.md | 5 + .../configure-data-links/index.md | 5 + .../configure-legend/index.md | 5 + .../configure-overrides/index.md | 5 + .../configure-panel-options/index.md | 5 + .../configure-standard-options/index.md | 5 + .../configure-thresholds/index.md | 5 + .../configure-value-mappings/index.md | 5 + .../panel-editor-overview/index.md | 5 + .../panel-inspector/index.md | 5 + .../query-transform-data/_index.md | 5 + .../expression-queries/index.md | 5 + .../query-transform-data/share-query/index.md | 5 + .../transform-data/index.md | 5 + .../troubleshoot-queries/index.md | 5 + .../visualizations/_index.md | 5 + .../visualizations/alert-list/index.md | 5 + .../visualizations/annotations/index.md | 5 + .../visualizations/bar-chart/index.md | 5 + .../visualizations/bar-gauge/index.md | 5 + .../visualizations/candlestick/index.md | 5 + .../visualizations/canvas/index.md | 5 + .../visualizations/dashboard-list/index.md | 5 + .../visualizations/datagrid/index.md | 5 + .../visualizations/flame-graph/index.md | 5 + .../visualizations/gauge/index.md | 5 + .../visualizations/geomap/index.md | 5 + .../visualizations/heatmap/index.md | 5 + .../visualizations/histogram/index.md | 5 + .../visualizations/logs/index.md | 5 + .../visualizations/news/index.md | 5 + .../visualizations/node-graph/index.md | 5 + .../visualizations/pie-chart/index.md | 5 + .../visualizations/stat/index.md | 5 + .../visualizations/state-timeline/index.md | 5 + .../visualizations/status-history/index.md | 5 + .../visualizations/table/index.md | 5 + .../visualizations/text/index.md | 5 + .../visualizations/time-series/index.md | 5 + .../visualizations/traces/index.md | 5 + .../visualizations/trend/index.md | 5 + docs/sources/release-notes/_index.md | 5 + .../release-notes/release-notes-7-3-0.md | 5 + .../release-notes/release-notes-7-3-1.md | 5 + .../release-notes/release-notes-7-3-10.md | 5 + .../release-notes/release-notes-7-3-2.md | 5 + .../release-notes/release-notes-7-3-3.md | 5 + .../release-notes/release-notes-7-3-4.md | 5 + .../release-notes/release-notes-7-3-5.md | 5 + .../release-notes/release-notes-7-3-6.md | 5 + .../release-notes/release-notes-7-3-7.md | 5 + .../release-notes/release-notes-7-4-0.md | 5 + .../release-notes/release-notes-7-4-1.md | 5 + .../release-notes/release-notes-7-4-2.md | 5 + .../release-notes/release-notes-7-4-3.md | 5 + .../release-notes/release-notes-7-4-5.md | 5 + .../release-notes-7-5-0-beta1.md | 5 + .../release-notes-7-5-0-beta2.md | 5 + .../release-notes/release-notes-7-5-0.md | 5 + .../release-notes/release-notes-7-5-1.md | 5 + .../release-notes/release-notes-7-5-10.md | 5 + .../release-notes/release-notes-7-5-11.md | 5 + .../release-notes/release-notes-7-5-12.md | 5 + .../release-notes/release-notes-7-5-13.md | 5 + .../release-notes/release-notes-7-5-15.md | 5 + .../release-notes/release-notes-7-5-2.md | 5 + .../release-notes/release-notes-7-5-3.md | 5 + .../release-notes/release-notes-7-5-4.md | 5 + .../release-notes/release-notes-7-5-5.md | 5 + .../release-notes/release-notes-7-5-6.md | 5 + .../release-notes/release-notes-7-5-7.md | 5 + .../release-notes/release-notes-7-5-8.md | 5 + .../release-notes/release-notes-7-5-9.md | 5 + .../release-notes-8-0-0-beta1.md | 5 + .../release-notes-8-0-0-beta2.md | 5 + .../release-notes-8-0-0-beta3.md | 5 + .../release-notes/release-notes-8-0-0.md | 5 + .../release-notes/release-notes-8-0-1.md | 5 + .../release-notes/release-notes-8-0-2.md | 5 + .../release-notes/release-notes-8-0-3.md | 5 + .../release-notes/release-notes-8-0-4.md | 5 + .../release-notes/release-notes-8-0-5.md | 5 + .../release-notes/release-notes-8-0-6.md | 5 + .../release-notes/release-notes-8-0-7.md | 5 + .../release-notes-8-1-0-beta1.md | 5 + .../release-notes-8-1-0-beta2.md | 5 + .../release-notes-8-1-0-beta3.md | 5 + .../release-notes/release-notes-8-1-0.md | 5 + .../release-notes/release-notes-8-1-1.md | 5 + .../release-notes/release-notes-8-1-2.md | 5 + .../release-notes/release-notes-8-1-3.md | 5 + .../release-notes/release-notes-8-1-4.md | 5 + .../release-notes/release-notes-8-1-5.md | 5 + .../release-notes/release-notes-8-1-6.md | 5 + .../release-notes/release-notes-8-1-7.md | 5 + .../release-notes/release-notes-8-1-8.md | 5 + .../release-notes-8-2-0-beta1.md | 5 + .../release-notes-8-2-0-beta2.md | 5 + .../release-notes/release-notes-8-2-0.md | 5 + .../release-notes/release-notes-8-2-1.md | 5 + .../release-notes/release-notes-8-2-2.md | 5 + .../release-notes/release-notes-8-2-3.md | 5 + .../release-notes/release-notes-8-2-4.md | 5 + .../release-notes/release-notes-8-2-5.md | 5 + .../release-notes/release-notes-8-2-6.md | 5 + .../release-notes/release-notes-8-2-7.md | 5 + .../release-notes-8-3-0-beta1.md | 5 + .../release-notes-8-3-0-beta2.md | 5 + .../release-notes/release-notes-8-3-0.md | 5 + .../release-notes/release-notes-8-3-1.md | 5 + .../release-notes/release-notes-8-3-11.md | 5 + .../release-notes/release-notes-8-3-2.md | 5 + .../release-notes/release-notes-8-3-3.md | 5 + .../release-notes/release-notes-8-3-4.md | 5 + .../release-notes/release-notes-8-3-5.md | 5 + .../release-notes/release-notes-8-3-6.md | 5 + .../release-notes/release-notes-8-3-7.md | 5 + .../release-notes-8-4-0-beta1.md | 5 + .../release-notes/release-notes-8-4-0.md | 5 + .../release-notes/release-notes-8-4-1.md | 5 + .../release-notes/release-notes-8-4-10.md | 5 + .../release-notes/release-notes-8-4-11.md | 5 + .../release-notes/release-notes-8-4-2.md | 5 + .../release-notes/release-notes-8-4-3.md | 5 + .../release-notes/release-notes-8-4-4.md | 5 + .../release-notes/release-notes-8-4-5.md | 5 + .../release-notes/release-notes-8-4-6.md | 5 + .../release-notes/release-notes-8-4-7.md | 5 + .../release-notes-8-5-0-beta1.md | 5 + .../release-notes/release-notes-8-5-0.md | 5 + .../release-notes/release-notes-8-5-1.md | 5 + .../release-notes/release-notes-8-5-10.md | 5 + .../release-notes/release-notes-8-5-11.md | 5 + .../release-notes/release-notes-8-5-13.md | 5 + .../release-notes/release-notes-8-5-2.md | 5 + .../release-notes/release-notes-8-5-3.md | 5 + .../release-notes/release-notes-8-5-4.md | 5 + .../release-notes/release-notes-8-5-5.md | 5 + .../release-notes/release-notes-8-5-6.md | 5 + .../release-notes/release-notes-8-5-9.md | 5 + .../release-notes-9-0-0-beta1.md | 5 + .../release-notes-9-0-0-beta2.md | 5 + .../release-notes-9-0-0-beta3.md | 5 + .../release-notes/release-notes-9-0-0.md | 5 + .../release-notes/release-notes-9-0-1.md | 5 + .../release-notes/release-notes-9-0-2.md | 5 + .../release-notes/release-notes-9-0-3.md | 5 + .../release-notes/release-notes-9-0-4.md | 5 + .../release-notes/release-notes-9-0-5.md | 5 + .../release-notes/release-notes-9-0-6.md | 5 + .../release-notes/release-notes-9-0-7.md | 5 + .../release-notes/release-notes-9-0-8.md | 5 + .../release-notes/release-notes-9-0-9.md | 5 + .../release-notes-9-1-0-beta1.md | 5 + .../release-notes/release-notes-9-1-0.md | 5 + .../release-notes/release-notes-9-1-1.md | 5 + .../release-notes/release-notes-9-1-2.md | 5 + .../release-notes/release-notes-9-1-3.md | 5 + .../release-notes/release-notes-9-1-4.md | 5 + .../release-notes/release-notes-9-1-5.md | 5 + .../release-notes/release-notes-9-1-6.md | 5 + .../release-notes/release-notes-9-1-7.md | 5 + .../release-notes/release-notes-v7-4-2.md | 5 + docs/sources/search/_index.md | 5 + docs/sources/setup-grafana/_index.md | 6 +- .../sources/setup-grafana/configure-docker.md | 6 +- .../setup-grafana/configure-grafana/_index.md | 4 + .../configure-custom-branding/index.md | 4 + .../configure-tracing/index.md | 6 +- .../enterprise-configuration/index.md | 4 + .../feature-toggles/index.md | 4 + .../configure-grafana/proxy/index.md | 6 +- .../settings-updates-at-runtime/index.md | 4 + .../configure-security/_index.md | 4 + .../configure-security/audit-grafana.md | 4 + .../configure-authentication/_index.md | 1 + .../auth-proxy/index.md | 7 +- .../configure-authentication/azuread/index.md | 7 +- .../enhanced-ldap/index.md | 6 +- .../generic-oauth/index.md | 7 +- .../configure-authentication/github/index.md | 7 +- .../configure-authentication/gitlab/index.md | 7 +- .../configure-authentication/google/index.md | 7 +- .../grafana-com/index.md | 7 +- .../configure-authentication/grafana/index.md | 7 +- .../configure-authentication/jwt/index.md | 7 +- .../keycloak/index.md | 7 +- .../configure-authentication/ldap/index.md | 7 +- .../configure-authentication/okta/index.md | 7 +- .../configure-authentication/saml-ui/index.md | 5 + .../configure-authentication/saml/index.md | 5 +- .../configure-database-encryption/_index.md | 4 + .../encrypt-secrets-using-aws-kms/index.md | 4 + .../index.md | 4 + .../index.md | 4 + .../index.md | 4 + .../integrate-with-hashicorp-vault/index.md | 4 + .../configure-request-security.md | 5 + .../configure-security-hardening/index.md | 7 +- .../configure-security/configure-team-sync.md | 4 + .../configure-security/export-logs.md | 4 + .../configure-security/secret-scan.md | 3 +- .../setup-grafana/image-rendering/_index.md | 4 + .../image-rendering/monitoring/index.md | 4 + .../image-rendering/troubleshooting/index.md | 4 + .../setup-grafana/installation/_index.md | 4 + .../installation/debian/index.md | 6 +- .../installation/docker/index.md | 4 + .../installation/kubernetes/index.md | 4 + .../setup-grafana/installation/mac/index.md | 6 +- .../installation/redhat-rhel-fedora/index.md | 6 +- .../installation/suse-opensuse/index.md | 6 +- .../installation/windows/index.md | 6 +- .../set-up-for-high-availability.md | 8 +- .../setup-grafana/set-up-grafana-live.md | 4 + .../set-up-grafana-monitoring.md | 4 + docs/sources/setup-grafana/set-up-https.md | 8 +- .../setup-grafana/sign-in-to-grafana.md | 4 + .../setup-grafana/start-restart-grafana.md | 6 +- docs/sources/shared/alerts/first-step.md | 4 + .../shared/alerts/grafana-managed-alerts.md | 4 + docs/sources/shared/auth/intro.md | 4 + docs/sources/shared/basics/grafana-cloud.md | 4 + .../shared/basics/grafana-enterprise.md | 4 + docs/sources/shared/basics/what-is-grafana.md | 4 + .../datasources/tempo-search-traceql.md | 4 + docs/sources/shared/example.md | 4 + docs/sources/shared/index.md | 4 + docs/sources/shared/influxdb/intro.md | 4 + .../view-server-org-list-and-edit.md | 4 + .../manage-users/view-server-org-list.md | 4 + .../view-server-user-list-search.md | 4 + .../manage-users/view-server-user-list.md | 4 + .../shared/manage-users/view-team-list.md | 4 + .../shared/panels/panel-links-intro.md | 4 + .../shared/panels/repeat-panel-intro.md | 4 + .../navigate-to-the-dashboard-list.md | 4 + .../navigate-user-preferences-list.md | 4 + .../preferences/org-preferences-list.md | 4 + .../preferences/select-home-dashboard-list.md | 4 + .../preferences/select-timezone-list.md | 4 + .../preferences/select-ui-theme-list.md | 4 + .../some-tasks-require-permissions.md | 4 + .../shared/systemd/bind-net-capabilities.md | 4 + docs/sources/shared/test.md | 4 + .../sources/shared/tutorials/create-plugin.md | 4 + .../shared/tutorials/plugin-anatomy.md | 4 + .../shared/tutorials/publish-your-plugin.md | 4 + .../shared/tutorials/set-up-environment.md | 4 + .../shared/upgrade/upgrade-common-tasks.md | 4 + docs/sources/shared/view-server-org-list.md | 4 + .../shared/view-server-user-list-search.md | 4 + .../shared/visualizations/change-axis-link.md | 4 + .../shared/visualizations/legend-mode.md | 4 + .../visualizations/stack-series-link.md | 4 + .../shared/visualizations/tooltip-mode.md | 4 + docs/sources/troubleshooting/_index.md | 5 + .../send-panel-to-grafana-support/index.md | 7 +- .../troubleshooting/support-bundles/index.md | 7 +- docs/sources/tutorials/_index.md | 10 +- .../create-alerts-from-flux-queries/index.md | 19 +- .../tutorials/create-users-and-teams/index.md | 19 +- .../tutorials/grafana-fundamentals/index.md | 19 +- docs/sources/tutorials/iis/index.md | 22 +- .../install-grafana-on-raspberry-pi/index.md | 19 +- .../tutorials/integrate-hubot/index.md | 22 +- .../index.md | 19 +- .../run-grafana-behind-a-proxy/index.md | 22 +- .../index.md | 19 +- docs/sources/upgrade-guide/_index.md | 4 + .../upgrade-guide/upgrade-v10.0/index.md | 6 +- .../upgrade-guide/upgrade-v8.0/index.md | 6 +- .../upgrade-guide/upgrade-v8.1/index.md | 6 +- .../upgrade-guide/upgrade-v8.2/index.md | 6 +- .../upgrade-guide/upgrade-v8.3/index.md | 6 +- .../upgrade-guide/upgrade-v8.4/index.md | 6 +- .../upgrade-guide/upgrade-v8.5/index.md | 6 +- .../upgrade-guide/upgrade-v9.0/index.md | 6 +- .../upgrade-guide/upgrade-v9.1/index.md | 6 +- .../upgrade-guide/upgrade-v9.2/index.md | 6 +- .../upgrade-guide/upgrade-v9.3/index.md | 6 +- .../upgrade-guide/upgrade-v9.4/index.md | 6 +- .../upgrade-guide/upgrade-v9.5/index.md | 6 +- docs/sources/whatsnew/_index.md | 7 +- docs/sources/whatsnew/whats-new-in-v10-0.md | 5 + docs/sources/whatsnew/whats-new-in-v7-0.md | 5 + docs/sources/whatsnew/whats-new-in-v7-1.md | 5 + docs/sources/whatsnew/whats-new-in-v7-2.md | 5 + docs/sources/whatsnew/whats-new-in-v7-3.md | 5 + docs/sources/whatsnew/whats-new-in-v7-4.md | 5 + docs/sources/whatsnew/whats-new-in-v7-5.md | 5 + docs/sources/whatsnew/whats-new-in-v8-0.md | 5 + docs/sources/whatsnew/whats-new-in-v8-1.md | 5 + docs/sources/whatsnew/whats-new-in-v8-2.md | 5 + docs/sources/whatsnew/whats-new-in-v8-3.md | 5 + docs/sources/whatsnew/whats-new-in-v8-4.md | 5 + docs/sources/whatsnew/whats-new-in-v8-5.md | 5 + docs/sources/whatsnew/whats-new-in-v9-0.md | 5 + docs/sources/whatsnew/whats-new-in-v9-1.md | 5 + docs/sources/whatsnew/whats-new-in-v9-2.md | 5 + docs/sources/whatsnew/whats-new-in-v9-3.md | 5 + docs/sources/whatsnew/whats-new-in-v9-4.md | 5 + docs/sources/whatsnew/whats-new-in-v9-5.md | 5 + 687 files changed, 5085 insertions(+), 2332 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index f34233db233..f455e5325db 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -3,204 +3,15 @@ aliases: - /docs/grafana/v1.1/ - /docs/grafana/v3.1/ - guides/reference/admin/ -cascade: - # Until a better mechanism for arrangement is thought of, the following sequence should be ordered alphabetically by the `_target.path` value. - - _target: { path: /docs/grafana/** } # Default to every page having "Enterprise" and "Open source" labels. - labels: - products: - - enterprise - - oss - - - _target: { path: /docs/grafana/** } - labels: - products: - - enterprise - - oss - - - _target: { path: /docs/grafana/*/administration/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/administration/enterprise-licensing/** } - labels: - products: - - enterprise - - - _target: { path: /docs/grafana/*/administration/organization-management/** } - labels: - products: - - enterprise - - oss - - - _target: { path: /docs/grafana/*/administration/provisioning/** } - labels: - products: - - enterprise - - oss - - - _target: { path: /docs/grafana/*/administration/recorded-queries/** } - labels: - products: - - cloud - - enterprise - - - _target: { path: /docs/grafana/*/administration/roles-and-permissions/access-control/** } - labels: - products: - - cloud - - enterprise - - - _target: { path: /docs/grafana/*/administration/stats-and-license/** } - labels: - products: - - enterprise - - oss - - - _target: { path: /docs/grafana/*/alerting/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/breaking-changes/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/dashboards/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/datasources/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/explore/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/fundamentals/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/introduction/grafana-cloud/** } - labels: - products: - - cloud - - - _target: { path: /docs/grafana/*/introduction/grafana-enterprise/** } - labels: - products: - - enterprise - - - _target: { path: /docs/grafana/*/panels-visualizations/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/release-notes/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/search/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/setup-grafana/configure-security/audit-grafana/** } - labels: - products: - - cloud - - enterprise - - - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-authentication/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-authentication/enhanced-ldap/** } - labels: - products: - - cloud - - enterprise - - - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-authentication/saml/** } - labels: - products: - - cloud - - enterprise - - - _target: - path: /docs/grafana/*/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/** - labels: - products: - - cloud - - enterprise - - - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-request-security/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/setup-grafana/configure-security/configure-team-sync/** } - labels: - products: - - cloud - - enterprise - - - _target: { path: /docs/grafana/*/setup-grafana/configure-security/export-logs/** } - labels: - products: - - cloud - - oss - - - _target: { path: /docs/grafana/*/troubleshooting/** } - labels: - products: - - cloud - - enterprise - - oss - - - _target: { path: /docs/grafana/*/whatsnew/** } - labels: - products: - - cloud - - enterprise - - oss description: Guides, installation, and feature documentation keywords: - grafana - installation - documentation +labels: + products: + - enterprise + - oss title: Grafana documentation --- diff --git a/docs/sources/administration/_index.md b/docs/sources/administration/_index.md index c9a8a8ea313..87739ebf35e 100644 --- a/docs/sources/administration/_index.md +++ b/docs/sources/administration/_index.md @@ -1,5 +1,9 @@ --- description: Administration +labels: + products: + - enterprise + - oss title: Administration weight: 40 --- diff --git a/docs/sources/administration/api-keys/index.md b/docs/sources/administration/api-keys/index.md index e7dd5bc385b..3352002fd68 100644 --- a/docs/sources/administration/api-keys/index.md +++ b/docs/sources/administration/api-keys/index.md @@ -6,6 +6,10 @@ description: This section contains information about API keys in Grafana keywords: - API keys - Service accounts +labels: + products: + - enterprise + - oss menuTitle: API keys title: API keys weight: 700 diff --git a/docs/sources/administration/correlations/_index.md b/docs/sources/administration/correlations/_index.md index 90381514d69..243bf1b0d6b 100644 --- a/docs/sources/administration/correlations/_index.md +++ b/docs/sources/administration/correlations/_index.md @@ -1,9 +1,13 @@ --- -title: Correlations -weight: 900 keywords: - correlations - Explore +labels: + products: + - enterprise + - oss +title: Correlations +weight: 900 --- # Correlations diff --git a/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md b/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md index bb644be513c..43793597dfe 100644 --- a/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md +++ b/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md @@ -1,6 +1,10 @@ --- -title: Add permissions to create new correlations +labels: + products: + - enterprise + - oss menuTitle: Add permissions +title: Add permissions to create new correlations weight: 30 --- diff --git a/docs/sources/administration/correlations/correlation-configuration/index.md b/docs/sources/administration/correlations/correlation-configuration/index.md index b83a8836552..34298a847ef 100644 --- a/docs/sources/administration/correlations/correlation-configuration/index.md +++ b/docs/sources/administration/correlations/correlation-configuration/index.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Correlation weight: 10 --- diff --git a/docs/sources/administration/correlations/correlation-permissions/index.md b/docs/sources/administration/correlations/correlation-permissions/index.md index 5e2391ca841..0ad1e2fb4cb 100644 --- a/docs/sources/administration/correlations/correlation-permissions/index.md +++ b/docs/sources/administration/correlations/correlation-permissions/index.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Permissions weight: 20 --- diff --git a/docs/sources/administration/correlations/create-a-new-correlation/index.md b/docs/sources/administration/correlations/create-a-new-correlation/index.md index c67a4af9c1d..edac5cf1747 100644 --- a/docs/sources/administration/correlations/create-a-new-correlation/index.md +++ b/docs/sources/administration/correlations/create-a-new-correlation/index.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Create a new correlation weight: 40 --- diff --git a/docs/sources/administration/correlations/use-correlations-in-visualizations/index.md b/docs/sources/administration/correlations/use-correlations-in-visualizations/index.md index a1ea800f08d..b742c509cc0 100644 --- a/docs/sources/administration/correlations/use-correlations-in-visualizations/index.md +++ b/docs/sources/administration/correlations/use-correlations-in-visualizations/index.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Use correlations in visualizations weight: 70 --- diff --git a/docs/sources/administration/correlations/use-variables-and-transformations/index.md b/docs/sources/administration/correlations/use-variables-and-transformations/index.md index d966506ab28..a40e0ef504f 100644 --- a/docs/sources/administration/correlations/use-variables-and-transformations/index.md +++ b/docs/sources/administration/correlations/use-variables-and-transformations/index.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Use variables and transformations in a correlation weight: 60 --- diff --git a/docs/sources/administration/data-source-management/index.md b/docs/sources/administration/data-source-management/index.md index af8d379c0c1..f614563b051 100644 --- a/docs/sources/administration/data-source-management/index.md +++ b/docs/sources/administration/data-source-management/index.md @@ -7,6 +7,10 @@ aliases: - ../features/datasources/add-a-data-source/ - ../permissions/datasource_permissions/ description: Data source management information for Grafana administrators +labels: + products: + - enterprise + - oss title: Data source management weight: 100 --- diff --git a/docs/sources/administration/enterprise-licensing/_index.md b/docs/sources/administration/enterprise-licensing/_index.md index b8b071be7ef..966e0889d72 100644 --- a/docs/sources/administration/enterprise-licensing/_index.md +++ b/docs/sources/administration/enterprise-licensing/_index.md @@ -13,6 +13,10 @@ keywords: - grafana - licensing - enterprise +labels: + products: + - enterprise + - oss title: Grafana Enterprise license weight: 500 --- diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md index e2145a9bd74..2ecc592a76d 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md @@ -11,6 +11,10 @@ keywords: - marketplace - enterprise - license +labels: + products: + - enterprise + - oss title: Activate a Grafana Enterprise license purchased through AWS Marketplace weight: 400 --- diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-ecs/index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-ecs/index.md index 2904522b1fa..6f6a35e5eea 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-ecs/index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-ecs/index.md @@ -10,6 +10,10 @@ keywords: - aws - marketplace - activate +labels: + products: + - enterprise + - oss title: Activate a Grafana Enterprise license from AWS Marketplace on ECS weight: 250 --- diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-eks/index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-eks/index.md index d4743b6abeb..a63c1af461d 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-eks/index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-eks/index.md @@ -10,6 +10,10 @@ keywords: - marketplace - eks - activate +labels: + products: + - enterprise + - oss title: Activate a Grafana Enterprise license from AWS Marketplace on EKS weight: 200 --- diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/index.md index 9ebb0382001..a205673c676 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/index.md @@ -10,6 +10,10 @@ keywords: - aws - marketplace - activate +labels: + products: + - enterprise + - oss title: Activate a Grafana Enterprise license from AWS on an instance deployed outside of AWS weight: 300 diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/manage-license-in-aws-marketplace/index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/manage-license-in-aws-marketplace/index.md index 1b0eeebf7da..74a1152a1a3 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/manage-license-in-aws-marketplace/index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/manage-license-in-aws-marketplace/index.md @@ -12,6 +12,10 @@ keywords: - add - remove - users +labels: + products: + - enterprise + - oss title: Manage your Grafana Enterprise license in AWS Marketplace weight: 400 --- diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/transfer-ge-license/index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/transfer-ge-license/index.md index 98b817b02a8..2bc99556500 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/transfer-ge-license/index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/transfer-ge-license/index.md @@ -10,6 +10,10 @@ keywords: - marketplace - transfer - move +labels: + products: + - enterprise + - oss title: Transfer your AWS Marketplace Grafana Enterprise license weight: 400 --- diff --git a/docs/sources/administration/organization-management/index.md b/docs/sources/administration/organization-management/index.md index b181824de55..0d93b93e5d6 100644 --- a/docs/sources/administration/organization-management/index.md +++ b/docs/sources/administration/organization-management/index.md @@ -8,6 +8,10 @@ description: Describes how to use organizations to isolate dashboard to users an keywords: - organizations - dashboards +labels: + products: + - enterprise + - oss menuTitle: Manage organizations title: Manage organizations weight: 200 diff --git a/docs/sources/administration/organization-preferences/index.md b/docs/sources/administration/organization-preferences/index.md index 3d9a4dd3ad1..211deadfa17 100644 --- a/docs/sources/administration/organization-preferences/index.md +++ b/docs/sources/administration/organization-preferences/index.md @@ -6,6 +6,10 @@ aliases: - preferences/change-grafana-theme/ - preferences/change-grafana-timezone/ - preferences/change-home-dashboard/ +labels: + products: + - enterprise + - oss title: Organization preferences weight: 500 --- diff --git a/docs/sources/administration/plugin-management/index.md b/docs/sources/administration/plugin-management/index.md index 127e0a05a86..101c38f3698 100644 --- a/docs/sources/administration/plugin-management/index.md +++ b/docs/sources/administration/plugin-management/index.md @@ -5,6 +5,10 @@ aliases: - ../plugins/installation/ - ../plugins/plugin-signature-verification/ - ../plugins/plugin-signatures/ +labels: + products: + - enterprise + - oss title: Plugin management weight: 600 --- diff --git a/docs/sources/administration/provisioning/index.md b/docs/sources/administration/provisioning/index.md index 999af309e41..61252affed8 100644 --- a/docs/sources/administration/provisioning/index.md +++ b/docs/sources/administration/provisioning/index.md @@ -5,6 +5,10 @@ description: Describes provisioning settings for Grafana using configuration fil keywords: - grafana - provisioning +labels: + products: + - enterprise + - oss title: Provision Grafana weight: 600 --- diff --git a/docs/sources/administration/recorded-queries/index.md b/docs/sources/administration/recorded-queries/index.md index d425d11ccfc..8851049d1cf 100644 --- a/docs/sources/administration/recorded-queries/index.md +++ b/docs/sources/administration/recorded-queries/index.md @@ -7,6 +7,10 @@ keywords: - query - queries - recorded +labels: + products: + - cloud + - enterprise title: Recorded queries weight: 300 --- diff --git a/docs/sources/administration/roles-and-permissions/_index.md b/docs/sources/administration/roles-and-permissions/_index.md index 8c081db0510..0bfc972eb38 100644 --- a/docs/sources/administration/roles-and-permissions/_index.md +++ b/docs/sources/administration/roles-and-permissions/_index.md @@ -6,6 +6,10 @@ aliases: - ../permissions/overview/ - manage-users-and-permissions/about-users-and-permissions/ description: Information about Grafana user, team, and organization roles and permissions +labels: + products: + - enterprise + - oss title: Roles and permissions weight: 300 --- diff --git a/docs/sources/administration/roles-and-permissions/access-control/_index.md b/docs/sources/administration/roles-and-permissions/access-control/_index.md index eede9eb4599..b8e14fe227a 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/_index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/_index.md @@ -6,6 +6,10 @@ aliases: description: Role-based access control (RBAC) provides a standardized way of granting, changing, and revoking access so that users can view and modify Grafana resources, such as users and reports. +labels: + products: + - cloud + - enterprise menuTitle: Role-based access control (RBAC) title: Grafana Role-based access control (RBAC) weight: 120 diff --git a/docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md b/docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md index e16bd31f7ae..a86cc311720 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md @@ -4,6 +4,10 @@ aliases: - ../../../enterprise/access-control/manage-role-assignments/manage-built-in-role-assignments/ - ../../../enterprise/access-control/manage-role-assignments/manage-user-role-assignments/ description: Learn how to assign RBAC roles to users and teams in Grafana. +labels: + products: + - cloud + - enterprise menuTitle: Assign RBAC roles title: Assign Grafana RBAC roles weight: 40 diff --git a/docs/sources/administration/roles-and-permissions/access-control/configure-rbac/index.md b/docs/sources/administration/roles-and-permissions/access-control/configure-rbac/index.md index d1c7055960e..ab8a5eaf47b 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/configure-rbac/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/configure-rbac/index.md @@ -2,6 +2,10 @@ aliases: - ../../../enterprise/access-control/configure-rbac/ description: Learn how to configure RBAC. +labels: + products: + - cloud + - enterprise menuTitle: Configure RBAC title: Configure RBAC in Grafana weight: 30 diff --git a/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md b/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md index fdf1793962e..0754a207309 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md @@ -3,6 +3,10 @@ aliases: - ../../../enterprise/access-control/custom-role-actions-scopes/ - ../../../enterprise/access-control/permissions/ description: Learn about Grafana RBAC permissions, actions, and scopes. +labels: + products: + - cloud + - enterprise menuTitle: RBAC permissions, actions, and scopes title: Grafana RBAC permissions, actions, and scopes weight: 80 diff --git a/docs/sources/administration/roles-and-permissions/access-control/manage-rbac-roles/index.md b/docs/sources/administration/roles-and-permissions/access-control/manage-rbac-roles/index.md index f2e86d71092..1c20f244614 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/manage-rbac-roles/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/manage-rbac-roles/index.md @@ -5,6 +5,10 @@ aliases: - ../../../enterprise/access-control/provisioning/ description: Learn how to view permissions associated with roles, create custom roles, and update and delete roles in Grafana. +labels: + products: + - cloud + - enterprise menuTitle: Manage RBAC roles title: Manage Grafana RBAC roles weight: 50 diff --git a/docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md b/docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md index ff3f58e0d88..fa7dcc070b5 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md @@ -4,6 +4,10 @@ aliases: - ../../../enterprise/access-control/usage-scenarios/ description: Plan your RBAC rollout strategy before you begin assigning roles to users and teams. +labels: + products: + - cloud + - enterprise menuTitle: Plan your RBAC rollout strategy title: Plan your Grafana RBAC rollout strategy weight: 20 diff --git a/docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md b/docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md index d67539879ac..fc24c05c13e 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md @@ -4,6 +4,10 @@ aliases: - ../../../enterprise/access-control/rbac-fixed-basic-role-definitions/ description: This topic includes a table that lists permission associated with Grafana fixed and basic roles. +labels: + products: + - cloud + - enterprise menuTitle: RBAC role definitions title: Grafana RBAC role definitions weight: 70 diff --git a/docs/sources/administration/roles-and-permissions/access-control/rbac-grafana-provisioning/index.md b/docs/sources/administration/roles-and-permissions/access-control/rbac-grafana-provisioning/index.md index 9eb81b4efd3..2d8b535c6a4 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/rbac-grafana-provisioning/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/rbac-grafana-provisioning/index.md @@ -4,6 +4,10 @@ aliases: - rbac-provisioning/ description: Learn about RBAC Grafana provisioning and view an example YAML provisioning file that configures Grafana role assignments. +labels: + products: + - cloud + - enterprise menuTitle: Provisioning RBAC with Grafana title: Provisioning RBAC with Grafana weight: 60 diff --git a/docs/sources/administration/roles-and-permissions/access-control/rbac-terraform-provisioning/index.md b/docs/sources/administration/roles-and-permissions/access-control/rbac-terraform-provisioning/index.md index c279bdb0ed3..5d841535473 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/rbac-terraform-provisioning/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/rbac-terraform-provisioning/index.md @@ -3,6 +3,10 @@ aliases: - ../../../enterprise/access-control/rbac-provisioning/rbac-terraform-provisioning/ description: Learn about RBAC Terraform provisioning and view an example of provisioning configuration for Grafana roles and role assignments. +labels: + products: + - cloud + - enterprise menuTitle: Provisioning RBAC with Terraform title: Provisioning RBAC with Terraform weight: 60 diff --git a/docs/sources/administration/roles-and-permissions/access-control/troubleshooting/index.md b/docs/sources/administration/roles-and-permissions/access-control/troubleshooting/index.md index ef4244e86b5..20bf252c363 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/troubleshooting/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/troubleshooting/index.md @@ -1,12 +1,11 @@ --- aliases: - ../../../enterprise/access-control/troubleshooting/ +description: RBAC troubleshooting guide. labels: products: - cloud - enterprise - - oss -description: RBAC troubleshooting guide. menuTitle: Troubleshooting RBAC title: Troubleshooting RBAC weight: 80 diff --git a/docs/sources/administration/service-accounts/index.md b/docs/sources/administration/service-accounts/index.md index 496b9b16ff5..200abe24399 100644 --- a/docs/sources/administration/service-accounts/index.md +++ b/docs/sources/administration/service-accounts/index.md @@ -8,6 +8,10 @@ description: This page contains information about service accounts in Grafana keywords: - API keys - Service accounts +labels: + products: + - enterprise + - oss menuTitle: Service accounts title: Service accounts weight: 800 diff --git a/docs/sources/administration/stats-and-license/index.md b/docs/sources/administration/stats-and-license/index.md index bc392180887..52255d2e021 100644 --- a/docs/sources/administration/stats-and-license/index.md +++ b/docs/sources/administration/stats-and-license/index.md @@ -11,6 +11,10 @@ keywords: - configuration - server - settings +labels: + products: + - cloud + - enterprise title: View server statistics and license weight: 400 --- diff --git a/docs/sources/administration/team-management/index.md b/docs/sources/administration/team-management/index.md index bbc75b9f7cf..9ade42e2555 100644 --- a/docs/sources/administration/team-management/index.md +++ b/docs/sources/administration/team-management/index.md @@ -4,6 +4,10 @@ aliases: - ../manage-users/create-or-remove-team/ - ../manage-users/manage-teams/ - manage-users-and-permissions/manage-teams/ +labels: + products: + - enterprise + - oss title: Team management weight: 400 --- diff --git a/docs/sources/administration/user-management/_index.md b/docs/sources/administration/user-management/_index.md index 4bbe8751545..27ca8ec0673 100644 --- a/docs/sources/administration/user-management/_index.md +++ b/docs/sources/administration/user-management/_index.md @@ -1,6 +1,10 @@ --- aliases: - manage-users-and-permissions/ +labels: + products: + - enterprise + - oss title: User management weight: 200 --- diff --git a/docs/sources/administration/user-management/manage-dashboard-permissions/index.md b/docs/sources/administration/user-management/manage-dashboard-permissions/index.md index 6dd965e7e50..5e181405478 100644 --- a/docs/sources/administration/user-management/manage-dashboard-permissions/index.md +++ b/docs/sources/administration/user-management/manage-dashboard-permissions/index.md @@ -2,6 +2,10 @@ aliases: - ../../permissions/dashboard_folder_permissions/ - ../manage-users-and-permissions/manage-dashboard-permissions/ +labels: + products: + - enterprise + - oss title: Manage dashboard permissions weight: 500 --- diff --git a/docs/sources/administration/user-management/manage-org-users/index.md b/docs/sources/administration/user-management/manage-org-users/index.md index 0bbb329fb3b..e7ea888692d 100644 --- a/docs/sources/administration/user-management/manage-org-users/index.md +++ b/docs/sources/administration/user-management/manage-org-users/index.md @@ -7,6 +7,10 @@ aliases: - ../manage-users-and-permissions/manage-org-users/manage-pending-invites/ - ../manage-users-and-permissions/manage-org-users/remove-user-from-org/ - ../manage-users-and-permissions/manage-org-users/view-list-org-users/ +labels: + products: + - enterprise + - oss title: Manage users in an organization weight: 400 --- diff --git a/docs/sources/administration/user-management/server-user-management/_index.md b/docs/sources/administration/user-management/server-user-management/_index.md index f5567d54a7d..50a38bed569 100644 --- a/docs/sources/administration/user-management/server-user-management/_index.md +++ b/docs/sources/administration/user-management/server-user-management/_index.md @@ -8,6 +8,10 @@ aliases: - ../manage-users-and-permissions/manage-server-users/view-edit-user-account/ - ../manage-users-and-permissions/manage-server-users/view-list-users/ - ../manage-users-and-permissions/manage-server-users/view-user-account-details/ +labels: + products: + - enterprise + - oss title: Server user management weight: 100 --- diff --git a/docs/sources/administration/user-management/server-user-management/add-remove-user-to-org/index.md b/docs/sources/administration/user-management/server-user-management/add-remove-user-to-org/index.md index 6504bfae8fa..1d8f5a70ac3 100644 --- a/docs/sources/administration/user-management/server-user-management/add-remove-user-to-org/index.md +++ b/docs/sources/administration/user-management/server-user-management/add-remove-user-to-org/index.md @@ -4,6 +4,10 @@ aliases: - ../../manage-users-and-permissions/manage-server-users/add-user-to-org/ description: Describes how a Grafana server administrator can add or remove users in an organization +labels: + products: + - enterprise + - oss title: Add or remove a user in an organization weight: 30 --- diff --git a/docs/sources/administration/user-management/server-user-management/assign-remove-server-admin-privileges/index.md b/docs/sources/administration/user-management/server-user-management/assign-remove-server-admin-privileges/index.md index 08c32924fdb..d02cc9c19a3 100644 --- a/docs/sources/administration/user-management/server-user-management/assign-remove-server-admin-privileges/index.md +++ b/docs/sources/administration/user-management/server-user-management/assign-remove-server-admin-privileges/index.md @@ -3,6 +3,10 @@ aliases: - ../../manage-users-and-permissions/manage-server-users/assign-remove-server-admin-privileges/ description: Describes how to assign and remove Grafana administrator privileges from a server user. +labels: + products: + - enterprise + - oss title: Assign or remove Grafana server administrator privileges weight: 20 --- diff --git a/docs/sources/administration/user-management/server-user-management/change-user-org-permissions/index.md b/docs/sources/administration/user-management/server-user-management/change-user-org-permissions/index.md index 28decb4b8c5..3a72c6b15b1 100644 --- a/docs/sources/administration/user-management/server-user-management/change-user-org-permissions/index.md +++ b/docs/sources/administration/user-management/server-user-management/change-user-org-permissions/index.md @@ -1,6 +1,10 @@ --- aliases: - ../../manage-users-and-permissions/manage-server-users/change-user-org-permissions/ +labels: + products: + - enterprise + - oss title: Change a user's organization permissions weight: 50 --- diff --git a/docs/sources/administration/user-management/server-user-management/grant-editor-admin-permissions/index.md b/docs/sources/administration/user-management/server-user-management/grant-editor-admin-permissions/index.md index 200ff8e9c65..875c7babec7 100644 --- a/docs/sources/administration/user-management/server-user-management/grant-editor-admin-permissions/index.md +++ b/docs/sources/administration/user-management/server-user-management/grant-editor-admin-permissions/index.md @@ -1,6 +1,10 @@ --- aliases: - ../../manage-users-and-permissions/manage-server-users/grant-editor-admin-permissions/ +labels: + products: + - enterprise + - oss title: Grant editors administrator permissions weight: 60 --- diff --git a/docs/sources/administration/user-management/user-preferences/index.md b/docs/sources/administration/user-management/user-preferences/index.md index 3706f79fa73..41166419d52 100644 --- a/docs/sources/administration/user-management/user-preferences/index.md +++ b/docs/sources/administration/user-management/user-preferences/index.md @@ -8,6 +8,10 @@ keywords: - change - organization - change +labels: + products: + - enterprise + - oss title: Manage user preferences weight: 400 --- diff --git a/docs/sources/alerting/_index.md b/docs/sources/alerting/_index.md index fe77120497b..0fc94bf325b 100644 --- a/docs/sources/alerting/_index.md +++ b/docs/sources/alerting/_index.md @@ -3,6 +3,11 @@ aliases: - about-alerting/ - unified-alerting/alerting/ description: Intro to key benefits and features of Grafana Alerting +labels: + products: + - cloud + - enterprise + - oss title: Alerting weight: 114 --- diff --git a/docs/sources/alerting/alerting-rules/_index.md b/docs/sources/alerting/alerting-rules/_index.md index c1b66ff6698..2549320d56b 100644 --- a/docs/sources/alerting/alerting-rules/_index.md +++ b/docs/sources/alerting/alerting-rules/_index.md @@ -1,11 +1,16 @@ --- -menuTitle: Configure aliases: - old-alerting/create-alerts/ - rules/ - unified-alerting/alerting-rules/ - ./create-alerts/ description: Configure alerting +labels: + products: + - cloud + - enterprise + - oss +menuTitle: Configure title: Configure Alerting weight: 130 --- diff --git a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md index 2e3d78e0e95..b5ff67b82d8 100644 --- a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md @@ -8,6 +8,11 @@ keywords: - guide - rules - create +labels: + products: + - cloud + - enterprise + - oss title: Create Grafana-managed alert rules weight: 400 --- diff --git a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md index 4d0c3480727..54c72a69e2e 100644 --- a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md +++ b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md @@ -10,6 +10,11 @@ keywords: - rules - recording rules - create +labels: + products: + - cloud + - enterprise + - oss title: Create Grafana Mimir or Loki managed recording rules weight: 400 --- diff --git a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md index bd82aad1183..ae6afe3e3de 100644 --- a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md @@ -10,6 +10,11 @@ keywords: - guide - rules - create +labels: + products: + - cloud + - enterprise + - oss title: Create Grafana Mimir or Loki managed alert rules weight: 400 --- diff --git a/docs/sources/alerting/alerting-rules/create-notification-policy.md b/docs/sources/alerting/alerting-rules/create-notification-policy.md index 01b2d8537ac..969962f61db 100644 --- a/docs/sources/alerting/alerting-rules/create-notification-policy.md +++ b/docs/sources/alerting/alerting-rules/create-notification-policy.md @@ -10,6 +10,11 @@ keywords: - guide - notification policies - routes +labels: + products: + - cloud + - enterprise + - oss title: Configure notification policies weight: 420 --- diff --git a/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md b/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md index d84c4c9ddd1..3861188e478 100644 --- a/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md +++ b/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md @@ -11,6 +11,11 @@ keywords: - namespace - grafana mimir - loki +labels: + products: + - cloud + - enterprise + - oss title: Grafana Mimir or Loki rule groups and namespaces weight: 405 --- diff --git a/docs/sources/alerting/alerting-rules/manage-contact-points/_index.md b/docs/sources/alerting/alerting-rules/manage-contact-points/_index.md index adf5669f456..af9e302dae9 100644 --- a/docs/sources/alerting/alerting-rules/manage-contact-points/_index.md +++ b/docs/sources/alerting/alerting-rules/manage-contact-points/_index.md @@ -13,6 +13,11 @@ keywords: - guide - contact point - templating +labels: + products: + - cloud + - enterprise + - oss title: Configure contact points weight: 410 --- diff --git a/docs/sources/alerting/alerting-rules/manage-contact-points/configure-integrations.md b/docs/sources/alerting/alerting-rules/manage-contact-points/configure-integrations.md index b89757d6ebf..a3dc8a533c6 100644 --- a/docs/sources/alerting/alerting-rules/manage-contact-points/configure-integrations.md +++ b/docs/sources/alerting/alerting-rules/manage-contact-points/configure-integrations.md @@ -9,6 +9,11 @@ keywords: - notifications - integrations - contact points +labels: + products: + - cloud + - enterprise + - oss title: Configure integrations weight: 100 --- diff --git a/docs/sources/alerting/alerting-rules/manage-contact-points/webhook-notifier.md b/docs/sources/alerting/alerting-rules/manage-contact-points/webhook-notifier.md index 7739617c312..73b1b0fc221 100644 --- a/docs/sources/alerting/alerting-rules/manage-contact-points/webhook-notifier.md +++ b/docs/sources/alerting/alerting-rules/manage-contact-points/webhook-notifier.md @@ -10,6 +10,11 @@ keywords: - guide - contact point - templating +labels: + products: + - cloud + - enterprise + - oss title: Configure the webhook notifier weight: 200 --- diff --git a/docs/sources/alerting/difference-old-new.md b/docs/sources/alerting/difference-old-new.md index 141839bd930..12339689866 100644 --- a/docs/sources/alerting/difference-old-new.md +++ b/docs/sources/alerting/difference-old-new.md @@ -7,6 +7,11 @@ keywords: - grafana - alerting - guide +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana Alerting weight: 108 --- diff --git a/docs/sources/alerting/fundamentals/_index.md b/docs/sources/alerting/fundamentals/_index.md index 948b09cdb2a..264b0289ad1 100644 --- a/docs/sources/alerting/fundamentals/_index.md +++ b/docs/sources/alerting/fundamentals/_index.md @@ -1,9 +1,14 @@ --- -menuTitle: Introduction aliases: - metrics/ - unified-alerting/fundamentals/ description: Intro to the key concepts in Alerting and how it works +labels: + products: + - cloud + - enterprise + - oss +menuTitle: Introduction title: Introduction to Alerting weight: 105 --- diff --git a/docs/sources/alerting/fundamentals/alert-rules/_index.md b/docs/sources/alerting/fundamentals/alert-rules/_index.md index 442c926b68e..51fb23c0620 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/_index.md +++ b/docs/sources/alerting/fundamentals/alert-rules/_index.md @@ -4,6 +4,11 @@ keywords: - grafana - alerting - rules +labels: + products: + - cloud + - enterprise + - oss title: Alert rules weight: 105 --- diff --git a/docs/sources/alerting/fundamentals/alert-rules/alert-instances.md b/docs/sources/alerting/fundamentals/alert-rules/alert-instances.md index f2d5b392e0e..c01d29b15ff 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/alert-instances.md +++ b/docs/sources/alerting/fundamentals/alert-rules/alert-instances.md @@ -4,6 +4,11 @@ keywords: - grafana - alerting - instances +labels: + products: + - cloud + - enterprise + - oss title: Alert instances weight: 104 --- diff --git a/docs/sources/alerting/fundamentals/alert-rules/alert-rule-types.md b/docs/sources/alerting/fundamentals/alert-rules/alert-rule-types.md index d89945d40ec..3aa4560e715 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/alert-rule-types.md +++ b/docs/sources/alerting/fundamentals/alert-rules/alert-rule-types.md @@ -4,6 +4,11 @@ keywords: - grafana - alerting - rule types +labels: + products: + - cloud + - enterprise + - oss title: Alert rule types weight: 102 --- diff --git a/docs/sources/alerting/fundamentals/alert-rules/message-templating.md b/docs/sources/alerting/fundamentals/alert-rules/message-templating.md index f816e690a07..617c9555bbb 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/message-templating.md +++ b/docs/sources/alerting/fundamentals/alert-rules/message-templating.md @@ -10,6 +10,11 @@ keywords: - guide - contact point - templating +labels: + products: + - cloud + - enterprise + - oss title: Notification templating weight: 415 --- diff --git a/docs/sources/alerting/fundamentals/alert-rules/organising-alerts.md b/docs/sources/alerting/fundamentals/alert-rules/organising-alerts.md index 93fbe228007..ba8dad47c82 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/organising-alerts.md +++ b/docs/sources/alerting/fundamentals/alert-rules/organising-alerts.md @@ -4,6 +4,11 @@ keywords: - grafana - alerting - organization +labels: + products: + - cloud + - enterprise + - oss title: Organising alert rules weight: 105 --- diff --git a/docs/sources/alerting/fundamentals/alert-rules/queries-conditions/_index.md b/docs/sources/alerting/fundamentals/alert-rules/queries-conditions/_index.md index e0b61e6d4ac..ba9d9ad19d5 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/queries-conditions/_index.md +++ b/docs/sources/alerting/fundamentals/alert-rules/queries-conditions/_index.md @@ -1,12 +1,17 @@ --- -title: Queries and conditions description: Introduction to queries and conditions -weight: 103 keywords: - grafana - alerting - queries - conditions +labels: + products: + - cloud + - enterprise + - oss +title: Queries and conditions +weight: 103 --- # Queries and conditions diff --git a/docs/sources/alerting/fundamentals/alert-rules/rule-evaluation/_index.md b/docs/sources/alerting/fundamentals/alert-rules/rule-evaluation/_index.md index 472eb935cf7..6c7f025b1a9 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/rule-evaluation/_index.md +++ b/docs/sources/alerting/fundamentals/alert-rules/rule-evaluation/_index.md @@ -1,11 +1,16 @@ --- -title: Alert rule evaluation description: Introduction to alert rule evaluation -weight: 106 keywords: - grafana - alerting - evaluation +labels: + products: + - cloud + - enterprise + - oss +title: Alert rule evaluation +weight: 106 --- # Alert rule evaluation diff --git a/docs/sources/alerting/fundamentals/alert-rules/state-and-health.md b/docs/sources/alerting/fundamentals/alert-rules/state-and-health.md index 147553ae712..84ce895433e 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/state-and-health.md +++ b/docs/sources/alerting/fundamentals/alert-rules/state-and-health.md @@ -7,6 +7,11 @@ keywords: - alerting - guide - state +labels: + products: + - cloud + - enterprise + - oss title: State and health of alerting rules weight: 405 --- diff --git a/docs/sources/alerting/fundamentals/alertmanager.md b/docs/sources/alerting/fundamentals/alertmanager.md index e9daa80c752..1c6ba9de551 100644 --- a/docs/sources/alerting/fundamentals/alertmanager.md +++ b/docs/sources/alerting/fundamentals/alertmanager.md @@ -5,6 +5,11 @@ aliases: - ../unified-alerting/fundamentals/alertmanager/ - alerting/manage-notifications/alertmanager/ description: Intro to the different Alertmanagers +labels: + products: + - cloud + - enterprise + - oss title: Alertmanager weight: 103 --- diff --git a/docs/sources/alerting/fundamentals/annotation-label/_index.md b/docs/sources/alerting/fundamentals/annotation-label/_index.md index 724bd3e1036..44cc44da99a 100644 --- a/docs/sources/alerting/fundamentals/annotation-label/_index.md +++ b/docs/sources/alerting/fundamentals/annotation-label/_index.md @@ -9,6 +9,11 @@ keywords: - guide - rules - create +labels: + products: + - cloud + - enterprise + - oss title: Labels and annotations weight: 110 --- diff --git a/docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md b/docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md index 798944db7d9..1987fcaf0a9 100644 --- a/docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md +++ b/docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md @@ -5,6 +5,11 @@ keywords: - alerting - guide - fundamentals +labels: + products: + - cloud + - enterprise + - oss title: Labels in Grafana Alerting weight: 117 --- diff --git a/docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md b/docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md index fb6bd1a7c1b..d469659252b 100644 --- a/docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md +++ b/docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md @@ -5,8 +5,13 @@ keywords: - alerting - guide - fundamentals -title: How label matching works +labels: + products: + - cloud + - enterprise + - oss menuTitle: Label matchers +title: How label matching works weight: 117 --- diff --git a/docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md b/docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md index 4dc112d7d85..5657998bc1b 100644 --- a/docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md +++ b/docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md @@ -6,6 +6,11 @@ keywords: - templating - labels - annotations +labels: + products: + - cloud + - enterprise + - oss title: Templating labels and annotations weight: 117 --- diff --git a/docs/sources/alerting/fundamentals/contact-points/index.md b/docs/sources/alerting/fundamentals/contact-points/index.md index f189b7537b9..f1f9b0fd71d 100644 --- a/docs/sources/alerting/fundamentals/contact-points/index.md +++ b/docs/sources/alerting/fundamentals/contact-points/index.md @@ -11,6 +11,11 @@ keywords: - contact point - notification channel - create +labels: + products: + - cloud + - enterprise + - oss title: Contact points weight: 106 --- diff --git a/docs/sources/alerting/fundamentals/data-source-alerting.md b/docs/sources/alerting/fundamentals/data-source-alerting.md index 030a00379f4..cd84695a738 100644 --- a/docs/sources/alerting/fundamentals/data-source-alerting.md +++ b/docs/sources/alerting/fundamentals/data-source-alerting.md @@ -1,5 +1,10 @@ --- description: Data sources in Grafana Alerting +labels: + products: + - cloud + - enterprise + - oss title: Data sources weight: 100 --- diff --git a/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md b/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md index 4a9e40703b1..a577e10a6ef 100644 --- a/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md +++ b/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md @@ -3,6 +3,11 @@ aliases: - ../metrics/ - ../unified-alerting/fundamentals/evaluate-grafana-alerts/ description: How to alert on numeric data +labels: + products: + - cloud + - enterprise + - oss title: Alerting on numeric data weight: 116 --- diff --git a/docs/sources/alerting/fundamentals/high-availability/_index.md b/docs/sources/alerting/fundamentals/high-availability/_index.md index e830f54a9e7..faa1104a8b9 100644 --- a/docs/sources/alerting/fundamentals/high-availability/_index.md +++ b/docs/sources/alerting/fundamentals/high-availability/_index.md @@ -9,6 +9,11 @@ keywords: - tutorials - ha - high availability +labels: + products: + - cloud + - enterprise + - oss title: Alerting high availability weight: 430 --- diff --git a/docs/sources/alerting/fundamentals/notification-policies/_index.md b/docs/sources/alerting/fundamentals/notification-policies/_index.md index 432a03bcde6..214ecc23760 100644 --- a/docs/sources/alerting/fundamentals/notification-policies/_index.md +++ b/docs/sources/alerting/fundamentals/notification-policies/_index.md @@ -1,11 +1,16 @@ --- -title: Notifications description: Introduction to notifications Policies -weight: 107 keywords: - grafana - alerting - notification policies +labels: + products: + - cloud + - enterprise + - oss +title: Notifications +weight: 107 --- # Notifications diff --git a/docs/sources/alerting/fundamentals/notification-policies/notifications.md b/docs/sources/alerting/fundamentals/notification-policies/notifications.md index 0b81f03a422..7645242c061 100644 --- a/docs/sources/alerting/fundamentals/notification-policies/notifications.md +++ b/docs/sources/alerting/fundamentals/notification-policies/notifications.md @@ -10,6 +10,11 @@ keywords: - notification policies - contact points - silences +labels: + products: + - cloud + - enterprise + - oss title: Notification policies weight: 410 --- diff --git a/docs/sources/alerting/manage-notifications/_index.md b/docs/sources/alerting/manage-notifications/_index.md index af8bf1effc9..94edb652747 100644 --- a/docs/sources/alerting/manage-notifications/_index.md +++ b/docs/sources/alerting/manage-notifications/_index.md @@ -1,10 +1,15 @@ --- -menuTitle: Manage description: Manage alert notifications keywords: - grafana - alert - notifications +labels: + products: + - cloud + - enterprise + - oss +menuTitle: Manage title: Manage your alerts weight: 160 --- diff --git a/docs/sources/alerting/manage-notifications/create-silence.md b/docs/sources/alerting/manage-notifications/create-silence.md index 24ea560c377..f82fb9d2205 100644 --- a/docs/sources/alerting/manage-notifications/create-silence.md +++ b/docs/sources/alerting/manage-notifications/create-silence.md @@ -11,6 +11,11 @@ keywords: - alerting - silence - mute +labels: + products: + - cloud + - enterprise + - oss title: Manage silences weight: 410 --- diff --git a/docs/sources/alerting/manage-notifications/declare-incident-from-alert.md b/docs/sources/alerting/manage-notifications/declare-incident-from-alert.md index de4272ae75c..7e4ea7683b2 100644 --- a/docs/sources/alerting/manage-notifications/declare-incident-from-alert.md +++ b/docs/sources/alerting/manage-notifications/declare-incident-from-alert.md @@ -6,6 +6,11 @@ keywords: - grafana - alert rules - incident +labels: + products: + - cloud + - enterprise + - oss title: Declare incidents from firing alerts weight: 1010 --- diff --git a/docs/sources/alerting/manage-notifications/images-in-notifications.md b/docs/sources/alerting/manage-notifications/images-in-notifications.md index 3ebb0130d64..5f318724324 100644 --- a/docs/sources/alerting/manage-notifications/images-in-notifications.md +++ b/docs/sources/alerting/manage-notifications/images-in-notifications.md @@ -5,6 +5,11 @@ keywords: - alerting - images - notifications +labels: + products: + - cloud + - enterprise + - oss title: Use images in notifications weight: 405 --- diff --git a/docs/sources/alerting/manage-notifications/mute-timings.md b/docs/sources/alerting/manage-notifications/mute-timings.md index b2c116586d6..8947d7cff7e 100644 --- a/docs/sources/alerting/manage-notifications/mute-timings.md +++ b/docs/sources/alerting/manage-notifications/mute-timings.md @@ -10,6 +10,11 @@ keywords: - mute - mute timings - mute time interval +labels: + products: + - cloud + - enterprise + - oss title: Create mute timings weight: 420 --- diff --git a/docs/sources/alerting/manage-notifications/template-notifications/_index.md b/docs/sources/alerting/manage-notifications/template-notifications/_index.md index f6b6b040085..196dba90eec 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/_index.md +++ b/docs/sources/alerting/manage-notifications/template-notifications/_index.md @@ -1,10 +1,15 @@ --- +description: How to customize your notifications using templating keywords: - grafana - alerting - notifications - templates -description: How to customize your notifications using templating +labels: + products: + - cloud + - enterprise + - oss title: Customize notifications weight: 400 --- diff --git a/docs/sources/alerting/manage-notifications/template-notifications/create-notification-templates.md b/docs/sources/alerting/manage-notifications/template-notifications/create-notification-templates.md index 138e782c253..81ae97dc4e6 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/create-notification-templates.md +++ b/docs/sources/alerting/manage-notifications/template-notifications/create-notification-templates.md @@ -1,4 +1,5 @@ --- +description: How to create notification templates keywords: - grafana - alerting @@ -7,7 +8,11 @@ keywords: - create templates - edit templates - delete templates -description: How to create notification templates +labels: + products: + - cloud + - enterprise + - oss title: Create notification templates weight: 200 --- diff --git a/docs/sources/alerting/manage-notifications/template-notifications/reference.md b/docs/sources/alerting/manage-notifications/template-notifications/reference.md index a283bb37f02..82f9818f030 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/reference.md +++ b/docs/sources/alerting/manage-notifications/template-notifications/reference.md @@ -1,10 +1,15 @@ --- +description: Reference for templating notifications keywords: - grafana - alerting - notifications - templates -description: Reference for templating notifications +labels: + products: + - cloud + - enterprise + - oss title: Reference weight: 400 --- diff --git a/docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md b/docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md index 79b06f2be9d..337054b52c6 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md +++ b/docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md @@ -1,11 +1,16 @@ --- +description: Use notification templates in contact points keywords: - grafana - alerting - notifications - templates - use templates -description: Use notification templates in contact points +labels: + products: + - cloud + - enterprise + - oss title: Use notification templates weight: 300 --- diff --git a/docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md b/docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md index a42db973c65..1f07993fe64 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md +++ b/docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md @@ -1,11 +1,16 @@ --- +description: Use Go's templating language in notifications keywords: - grafana - alerting - notifications - templates - write templates -description: Use Go's templating language in notifications +labels: + products: + - cloud + - enterprise + - oss title: Using Go's templating language weight: 100 --- diff --git a/docs/sources/alerting/manage-notifications/view-alert-groups.md b/docs/sources/alerting/manage-notifications/view-alert-groups.md index b8f60d10121..863728ac03c 100644 --- a/docs/sources/alerting/manage-notifications/view-alert-groups.md +++ b/docs/sources/alerting/manage-notifications/view-alert-groups.md @@ -11,6 +11,11 @@ keywords: - alerting - alerts - groups +labels: + products: + - cloud + - enterprise + - oss title: View and filter by alert groups weight: 800 --- diff --git a/docs/sources/alerting/manage-notifications/view-alert-rules.md b/docs/sources/alerting/manage-notifications/view-alert-rules.md index e67a1ae32b8..7ebac1a1e6c 100644 --- a/docs/sources/alerting/manage-notifications/view-alert-rules.md +++ b/docs/sources/alerting/manage-notifications/view-alert-rules.md @@ -10,6 +10,11 @@ keywords: - guide - rules - view +labels: + products: + - cloud + - enterprise + - oss title: View and filter alert rules weight: 410 --- diff --git a/docs/sources/alerting/manage-notifications/view-notification-errors.md b/docs/sources/alerting/manage-notifications/view-notification-errors.md index 409f9b52c01..1fdaad7e5c6 100644 --- a/docs/sources/alerting/manage-notifications/view-notification-errors.md +++ b/docs/sources/alerting/manage-notifications/view-notification-errors.md @@ -1,11 +1,16 @@ --- +description: View notification errors to find out why they weren't sent or received keywords: - grafana - alerting - notification - errors - contact points -description: View notification errors to find out why they weren't sent or received +labels: + products: + - cloud + - enterprise + - oss title: View notification errors weight: 900 --- diff --git a/docs/sources/alerting/manage-notifications/view-state-health.md b/docs/sources/alerting/manage-notifications/view-state-health.md index 2c1f0ab28d7..c7d9ed2ad61 100644 --- a/docs/sources/alerting/manage-notifications/view-state-health.md +++ b/docs/sources/alerting/manage-notifications/view-state-health.md @@ -10,6 +10,11 @@ keywords: - guide - state - health +labels: + products: + - cloud + - enterprise + - oss title: View the state and health of alert rules weight: 420 --- diff --git a/docs/sources/alerting/set-up/_index.md b/docs/sources/alerting/set-up/_index.md index 0fd9811374d..963c1d58b23 100644 --- a/docs/sources/alerting/set-up/_index.md +++ b/docs/sources/alerting/set-up/_index.md @@ -1,11 +1,11 @@ --- -menuTitle: Set up aliases: - unified-alerting/set-up/ +description: How to configure alerting features and integrations labels: products: - oss -description: How to configure alerting features and integrations +menuTitle: Set up title: Set up Alerting weight: 107 --- diff --git a/docs/sources/alerting/set-up/configure-alert-state-history/index.md b/docs/sources/alerting/set-up/configure-alert-state-history/index.md index 4ca581275c6..ab1414fd929 100644 --- a/docs/sources/alerting/set-up/configure-alert-state-history/index.md +++ b/docs/sources/alerting/set-up/configure-alert-state-history/index.md @@ -1,19 +1,15 @@ --- -title: Configure Alert State History description: Configure Alert State History - keywords: - grafana - alerting - set up - configure - alert state history - labels: products: - - enterprise - - oss - + - cloud +title: Configure Alert State History weight: 600 --- diff --git a/docs/sources/alerting/set-up/configure-alertmanager/index.md b/docs/sources/alerting/set-up/configure-alertmanager/index.md index 63be679445f..7766c91dc7b 100644 --- a/docs/sources/alerting/set-up/configure-alertmanager/index.md +++ b/docs/sources/alerting/set-up/configure-alertmanager/index.md @@ -8,6 +8,10 @@ keywords: - set up - configure - external Alertmanager +labels: + products: + - enterprise + - oss title: Add an external Alertmanager weight: 200 --- diff --git a/docs/sources/alerting/set-up/configure-high-availability/_index.md b/docs/sources/alerting/set-up/configure-high-availability/_index.md index fb2709a1cc0..f05fcee7495 100644 --- a/docs/sources/alerting/set-up/configure-high-availability/_index.md +++ b/docs/sources/alerting/set-up/configure-high-availability/_index.md @@ -9,6 +9,10 @@ keywords: - tutorials - ha - high availability +labels: + products: + - enterprise + - oss title: Enable alerting high availability weight: 400 --- diff --git a/docs/sources/alerting/set-up/meta-monitoring/_index.md b/docs/sources/alerting/set-up/meta-monitoring/_index.md index b20eeac1d77..d1d5b106617 100644 --- a/docs/sources/alerting/set-up/meta-monitoring/_index.md +++ b/docs/sources/alerting/set-up/meta-monitoring/_index.md @@ -7,6 +7,10 @@ keywords: - grafana - alerting - meta-monitoring +labels: + products: + - enterprise + - oss title: Meta monitoring weight: 500 --- diff --git a/docs/sources/alerting/set-up/migrating-alerts/_index.md b/docs/sources/alerting/set-up/migrating-alerts/_index.md index a5cad59920f..97a0b7b441a 100644 --- a/docs/sources/alerting/set-up/migrating-alerts/_index.md +++ b/docs/sources/alerting/set-up/migrating-alerts/_index.md @@ -5,6 +5,10 @@ aliases: - unified-alerting/difference-old-new/ - alerting/migrating-alerts/ description: Upgrade Grafana alerts +labels: + products: + - enterprise + - oss title: Upgrade Alerting weight: 150 --- diff --git a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md index d49cedb9088..fa3972412b9 100644 --- a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md +++ b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md @@ -1,12 +1,16 @@ --- -title: Legacy alerting deprecation aliases: - alerting/legacy-alerting-deprecation/ description: Legacy alerting deprecation notice -weight: 109 keywords: - grafana - alerting +labels: + products: + - enterprise + - oss +title: Legacy alerting deprecation +weight: 109 --- # Legacy alerting deprecation diff --git a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/_index.md b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/_index.md index 6a47699d0b1..942e3338fa0 100644 --- a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/_index.md +++ b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/_index.md @@ -5,6 +5,10 @@ aliases: - /docs/grafana-cloud/legacy-alerting/ - alerting/migrating-alerts/legacy-alerting/ description: Legacy alerting +labels: + products: + - enterprise + - oss title: Legacy alerting weight: 110 --- diff --git a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/_index.md b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/_index.md index ae7e44c5013..53f2f6093c2 100644 --- a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/_index.md +++ b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/_index.md @@ -4,6 +4,9 @@ aliases: - /docs/grafana-cloud/how-do-i/grafana-cloud-alerting/ - /docs/grafana-cloud/legacy-alerting/grafana-cloud-alerting/ description: Grafana Cloud Alerting +labels: + products: + - cloud title: Grafana Cloud Alerting weight: 100 --- diff --git a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/alertmanager.md b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/alertmanager.md index 4c9622932fb..9815ddad594 100644 --- a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/alertmanager.md +++ b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/alertmanager.md @@ -4,6 +4,11 @@ aliases: - /docs/grafana-cloud/how-do-i/grafana-cloud-alerting/alertmanager/ - /docs/grafana-cloud/legacy-alerting/grafana-cloud-alerting/alertmanager/ description: Alertmanager +labels: + products: + - cloud + - enterprise + - oss title: Alertmanager weight: 500 --- diff --git a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/create-edit-rules.md b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/create-edit-rules.md index 14fcbd8486c..64efd195fa5 100644 --- a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/create-edit-rules.md +++ b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/create-edit-rules.md @@ -4,6 +4,11 @@ aliases: - /docs/grafana-cloud/how-do-i/grafana-cloud-alerting/create-edit-rules/ - /docs/grafana-cloud/legacy-alerting/grafana-cloud-alerting/create-edit-rules/ description: Create and edit alert rules +labels: + products: + - cloud + - enterprise + - oss title: Create and edit alert rules weight: 200 --- diff --git a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/namespaces-and-groups.md b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/namespaces-and-groups.md index b592fda7cdf..21d702a43d2 100644 --- a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/namespaces-and-groups.md +++ b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/namespaces-and-groups.md @@ -4,6 +4,11 @@ aliases: - /docs/grafana-cloud/how-do-i/grafana-cloud-alerting/namespaces-and-groups/ - /docs/grafana-cloud/legacy-alerting/grafana-cloud-alerting/namespaces-and-groups/ description: Namespaces and rule groups +labels: + products: + - cloud + - enterprise + - oss title: Namespaces and rule groups weight: 400 --- diff --git a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/silences.md b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/silences.md index 2104e7e3d1f..48f6b776d6f 100644 --- a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/silences.md +++ b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/silences.md @@ -4,6 +4,11 @@ aliases: - /docs/grafana-cloud/how-do-i/grafana-cloud-alerting/silences/ - /docs/grafana-cloud/legacy-alerting/grafana-cloud-alerting/silences/ description: Silences +labels: + products: + - cloud + - enterprise + - oss title: Silences weight: 600 --- diff --git a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/view-filter-rules.md b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/view-filter-rules.md index a8de64796fd..8a21a525678 100644 --- a/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/view-filter-rules.md +++ b/docs/sources/alerting/set-up/migrating-alerts/legacy-alerting/grafana-cloud-alerting/view-filter-rules.md @@ -4,6 +4,11 @@ aliases: - /docs/grafana-cloud/how-do-i/grafana-cloud-alerting/view-filter-alerts/ - /docs/grafana-cloud/legacy-alerting/grafana-cloud-alerting/view-filter-rules/ description: View and filter alert rules +labels: + products: + - cloud + - enterprise + - oss title: View and filter alert rules weight: 300 --- diff --git a/docs/sources/alerting/set-up/performance-limitations/index.md b/docs/sources/alerting/set-up/performance-limitations/index.md index 2675380e3f6..84d69d51eb4 100644 --- a/docs/sources/alerting/set-up/performance-limitations/index.md +++ b/docs/sources/alerting/set-up/performance-limitations/index.md @@ -8,6 +8,11 @@ keywords: - alerting - performance - limitations +labels: + products: + - cloud + - enterprise + - oss title: Performance considerations and limitations weight: 600 --- diff --git a/docs/sources/alerting/set-up/provision-alerting-resources/_index.md b/docs/sources/alerting/set-up/provision-alerting-resources/_index.md index 2f071dbcebe..289932d51e8 100644 --- a/docs/sources/alerting/set-up/provision-alerting-resources/_index.md +++ b/docs/sources/alerting/set-up/provision-alerting-resources/_index.md @@ -8,6 +8,11 @@ keywords: - set up - configure - provisioning +labels: + products: + - cloud + - enterprise + - oss title: Provision Grafana Alerting resources weight: 300 --- diff --git a/docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md b/docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md index 8efb3eb16a2..d4f9189d3ea 100644 --- a/docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md +++ b/docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md @@ -8,6 +8,11 @@ keywords: - alerting resources - file provisioning - provisioning +labels: + products: + - cloud + - enterprise + - oss title: Create and manage alerting resources using file provisioning weight: 100 --- diff --git a/docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md b/docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md index cbb765006bb..01054b9acb3 100644 --- a/docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md +++ b/docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md @@ -8,6 +8,10 @@ keywords: - alerting resources - provisioning - Terraform +labels: + products: + - enterprise + - oss title: Create and manage alerting resources using Terraform weight: 200 --- diff --git a/docs/sources/alerting/set-up/provision-alerting-resources/view-provisioned-resources/index.md b/docs/sources/alerting/set-up/provision-alerting-resources/view-provisioned-resources/index.md index d3fc61abe7a..7189cd24c1d 100644 --- a/docs/sources/alerting/set-up/provision-alerting-resources/view-provisioned-resources/index.md +++ b/docs/sources/alerting/set-up/provision-alerting-resources/view-provisioned-resources/index.md @@ -7,8 +7,13 @@ keywords: - alerting - alerting resources - provisioning -title: View provisioned alerting resources in Grafana +labels: + products: + - cloud + - enterprise + - oss menuTitle: View provisioned resources in Grafana +title: View provisioned alerting resources in Grafana weight: 300 --- diff --git a/docs/sources/alerting/set-up/set-up-cloud/_index.md b/docs/sources/alerting/set-up/set-up-cloud/_index.md index 5f3017473b3..336f209cd61 100644 --- a/docs/sources/alerting/set-up/set-up-cloud/_index.md +++ b/docs/sources/alerting/set-up/set-up-cloud/_index.md @@ -8,10 +8,10 @@ aliases: - /docs/grafana-cloud/alerts/grafana-cloud-alerting/ - /docs/grafana-cloud/how-do-i/grafana-cloud-alerting/ - /docs/grafana-cloud/legacy-alerting/grafana-cloud-alerting/ +description: How to configure Alerting for Cloud labels: products: - cloud -description: How to configure Alerting for Cloud title: Set up Alerting for Cloud weight: 100 --- diff --git a/docs/sources/breaking-changes/_index.md b/docs/sources/breaking-changes/_index.md index 02b36c1a031..6eb62be4d38 100644 --- a/docs/sources/breaking-changes/_index.md +++ b/docs/sources/breaking-changes/_index.md @@ -1,6 +1,11 @@ --- aliases: - guides/ +labels: + products: + - cloud + - enterprise + - oss title: Breaking changes weight: 2 --- diff --git a/docs/sources/breaking-changes/breaking-changes-v10-0.md b/docs/sources/breaking-changes/breaking-changes-v10-0.md index f26af90bc70..0c961c74e65 100644 --- a/docs/sources/breaking-changes/breaking-changes-v10-0.md +++ b/docs/sources/breaking-changes/breaking-changes-v10-0.md @@ -6,6 +6,11 @@ keywords: - documentation - '10.0' - release notes +labels: + products: + - cloud + - enterprise + - oss title: Breaking changes in Grafana v10.0 weight: -1 --- diff --git a/docs/sources/cli.md b/docs/sources/cli.md index 18861fa43bb..4dd670751c5 100644 --- a/docs/sources/cli.md +++ b/docs/sources/cli.md @@ -7,6 +7,10 @@ keywords: - cli - grafana cli - command line interface +labels: + products: + - enterprise + - oss title: Grafana CLI weight: 400 --- diff --git a/docs/sources/dashboards/_index.md b/docs/sources/dashboards/_index.md index c548e42e61c..91b6e0ff92d 100644 --- a/docs/sources/dashboards/_index.md +++ b/docs/sources/dashboards/_index.md @@ -1,6 +1,11 @@ --- aliases: - features/dashboard/dashboards/ +labels: + products: + - cloud + - enterprise + - oss title: Dashboards weight: 70 --- diff --git a/docs/sources/dashboards/assess-dashboard-usage/index.md b/docs/sources/dashboards/assess-dashboard-usage/index.md index 5d5c8b204ac..bb8b7098657 100644 --- a/docs/sources/dashboards/assess-dashboard-usage/index.md +++ b/docs/sources/dashboards/assess-dashboard-usage/index.md @@ -12,6 +12,10 @@ keywords: - presence-indicator - search - sort +labels: + products: + - cloud + - enterprise title: Assess dashboard usage weight: 200 --- diff --git a/docs/sources/dashboards/build-dashboards/_index.md b/docs/sources/dashboards/build-dashboards/_index.md index 94e24b393eb..6eff2f5279b 100644 --- a/docs/sources/dashboards/build-dashboards/_index.md +++ b/docs/sources/dashboards/build-dashboards/_index.md @@ -1,7 +1,4 @@ --- -title: Build dashboards -menuTitle: Build dashboards -weight: 2 keywords: - grafana - dashboard @@ -9,6 +6,14 @@ keywords: - create - build - design +labels: + products: + - cloud + - enterprise + - oss +menuTitle: Build dashboards +title: Build dashboards +weight: 2 --- # Build dashboards diff --git a/docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md b/docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md index 143fc95593b..c898646adc9 100644 --- a/docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md +++ b/docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md @@ -7,6 +7,11 @@ keywords: - annotations - documentation - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: Annotate visualizations title: Annotate visualizations weight: 600 diff --git a/docs/sources/dashboards/build-dashboards/best-practices/index.md b/docs/sources/dashboards/build-dashboards/best-practices/index.md index 4440ff8bd0d..a22ef3c44b5 100644 --- a/docs/sources/dashboards/build-dashboards/best-practices/index.md +++ b/docs/sources/dashboards/build-dashboards/best-practices/index.md @@ -7,6 +7,11 @@ aliases: - ../../best-practices/dashboard-management-maturity-levels/ - ../../getting-started/strategies/ description: Best practices for working with Grafana +labels: + products: + - cloud + - enterprise + - oss menuTitle: Best practices title: Grafana dashboard best practices weight: 100 diff --git a/docs/sources/dashboards/build-dashboards/create-dashboard-url-variables/index.md b/docs/sources/dashboards/build-dashboards/create-dashboard-url-variables/index.md index fd9d2ab5079..5e9652bdcd9 100644 --- a/docs/sources/dashboards/build-dashboards/create-dashboard-url-variables/index.md +++ b/docs/sources/dashboards/build-dashboards/create-dashboard-url-variables/index.md @@ -8,6 +8,11 @@ keywords: - documentation - variables - dashboards +labels: + products: + - cloud + - enterprise + - oss title: Dashboard URL variables weight: 250 --- diff --git a/docs/sources/dashboards/build-dashboards/create-dashboard/index.md b/docs/sources/dashboards/build-dashboards/create-dashboard/index.md index 316b3953291..971b057d971 100644 --- a/docs/sources/dashboards/build-dashboards/create-dashboard/index.md +++ b/docs/sources/dashboards/build-dashboards/create-dashboard/index.md @@ -5,6 +5,11 @@ keywords: - panel - dashboard - create +labels: + products: + - cloud + - enterprise + - oss menuTitle: Create a dashboard title: Create a dashboard weight: 1 diff --git a/docs/sources/dashboards/build-dashboards/manage-dashboard-links/index.md b/docs/sources/dashboards/build-dashboards/manage-dashboard-links/index.md index fc0a31427d2..f802db5bd8d 100644 --- a/docs/sources/dashboards/build-dashboards/manage-dashboard-links/index.md +++ b/docs/sources/dashboards/build-dashboards/manage-dashboard-links/index.md @@ -15,6 +15,11 @@ keywords: - create links - link dashboards - navigate +labels: + products: + - cloud + - enterprise + - oss menuTitle: Manage dashboard links title: Manage dashboard links weight: 500 diff --git a/docs/sources/dashboards/build-dashboards/manage-library-panels/index.md b/docs/sources/dashboards/build-dashboards/manage-library-panels/index.md index 56d67efafca..c713f27dba9 100644 --- a/docs/sources/dashboards/build-dashboards/manage-library-panels/index.md +++ b/docs/sources/dashboards/build-dashboards/manage-library-panels/index.md @@ -8,6 +8,11 @@ aliases: - ../../panels/library-panels/unlink-library-panel/ - ../../panels/panel-library/ - ../manage-library-panels/ +labels: + products: + - cloud + - enterprise + - oss menuTitle: Manage library panels title: Manage library panels weight: 300 diff --git a/docs/sources/dashboards/build-dashboards/manage-version-history/index.md b/docs/sources/dashboards/build-dashboards/manage-version-history/index.md index c2b8e3fa286..b261e2a63bc 100644 --- a/docs/sources/dashboards/build-dashboards/manage-version-history/index.md +++ b/docs/sources/dashboards/build-dashboards/manage-version-history/index.md @@ -8,6 +8,11 @@ keywords: - documentation - version - history +labels: + products: + - cloud + - enterprise + - oss menutitle: Manage version history title: Manage dashboard version history weight: 400 diff --git a/docs/sources/dashboards/build-dashboards/modify-dashboard-settings/index.md b/docs/sources/dashboards/build-dashboards/modify-dashboard-settings/index.md index 6532b102e68..1683e278aa8 100644 --- a/docs/sources/dashboards/build-dashboards/modify-dashboard-settings/index.md +++ b/docs/sources/dashboards/build-dashboards/modify-dashboard-settings/index.md @@ -1,13 +1,18 @@ --- -title: Modify dashboard settings -menuTitle: Modify dashboard settings -weight: 8 keywords: - time settings - variables - links - dashboard - settings +labels: + products: + - cloud + - enterprise + - oss +menuTitle: Modify dashboard settings +title: Modify dashboard settings +weight: 8 --- # Modify dashboard settings diff --git a/docs/sources/dashboards/build-dashboards/view-dashboard-json-model/index.md b/docs/sources/dashboards/build-dashboards/view-dashboard-json-model/index.md index 3c98b3dac1e..7f0cb45675d 100644 --- a/docs/sources/dashboards/build-dashboards/view-dashboard-json-model/index.md +++ b/docs/sources/dashboards/build-dashboards/view-dashboard-json-model/index.md @@ -8,6 +8,11 @@ keywords: - documentation - json - model +labels: + products: + - cloud + - enterprise + - oss title: JSON model weight: 700 --- diff --git a/docs/sources/dashboards/create-manage-playlists/index.md b/docs/sources/dashboards/create-manage-playlists/index.md index 9be403a304d..b218dcd0e50 100644 --- a/docs/sources/dashboards/create-manage-playlists/index.md +++ b/docs/sources/dashboards/create-manage-playlists/index.md @@ -7,6 +7,11 @@ keywords: - dashboard - documentation - playlist +labels: + products: + - cloud + - enterprise + - oss menuTitle: Manage playlists title: Manage playlists weight: 9 diff --git a/docs/sources/dashboards/dashboard-public/index.md b/docs/sources/dashboards/dashboard-public/index.md index c4a4b0b2c33..aad1efceaa3 100644 --- a/docs/sources/dashboards/dashboard-public/index.md +++ b/docs/sources/dashboards/dashboard-public/index.md @@ -2,6 +2,11 @@ aliases: - ../features/dashboard/dashboards/ - dashboard-manage/ +labels: + products: + - cloud + - enterprise + - oss title: Public dashboards weight: 8 --- diff --git a/docs/sources/dashboards/manage-dashboards/index.md b/docs/sources/dashboards/manage-dashboards/index.md index fb16052b0ef..93c0b22d43c 100644 --- a/docs/sources/dashboards/manage-dashboards/index.md +++ b/docs/sources/dashboards/manage-dashboards/index.md @@ -20,6 +20,11 @@ keywords: - troubleshoot - time range - scripting +labels: + products: + - cloud + - enterprise + - oss menuTitle: Manage dashboards title: Manage dashboards weight: 8 diff --git a/docs/sources/dashboards/share-dashboards-panels/index.md b/docs/sources/dashboards/share-dashboards-panels/index.md index aa1754cde2f..420f6c631dc 100644 --- a/docs/sources/dashboards/share-dashboards-panels/index.md +++ b/docs/sources/dashboards/share-dashboards-panels/index.md @@ -24,6 +24,11 @@ keywords: - reporting - export - pdf +labels: + products: + - cloud + - enterprise + - oss menuTitle: Sharing title: Share dashboards and panels weight: 85 diff --git a/docs/sources/dashboards/use-dashboards/index.md b/docs/sources/dashboards/use-dashboards/index.md index ae3c460ae2b..b8022abaae3 100644 --- a/docs/sources/dashboards/use-dashboards/index.md +++ b/docs/sources/dashboards/use-dashboards/index.md @@ -12,6 +12,11 @@ keywords: - dashboard - search - shortcuts +labels: + products: + - cloud + - enterprise + - oss menuTitle: Use dashboards title: Use dashboards weight: 1 diff --git a/docs/sources/dashboards/variables/_index.md b/docs/sources/dashboards/variables/_index.md index 37171558ea3..b42cd2a7848 100644 --- a/docs/sources/dashboards/variables/_index.md +++ b/docs/sources/dashboards/variables/_index.md @@ -3,6 +3,11 @@ aliases: - ../variables/ - ../variables/variable-examples/ - ./ +labels: + products: + - cloud + - enterprise + - oss title: Variables weight: 130 --- diff --git a/docs/sources/dashboards/variables/add-template-variables/index.md b/docs/sources/dashboards/variables/add-template-variables/index.md index bd1dd81bf68..c0a9939b99a 100644 --- a/docs/sources/dashboards/variables/add-template-variables/index.md +++ b/docs/sources/dashboards/variables/add-template-variables/index.md @@ -35,6 +35,11 @@ keywords: - nested - chained - linked +labels: + products: + - cloud + - enterprise + - oss menuTitle: Manage variables title: Add and manage variables weight: 100 diff --git a/docs/sources/dashboards/variables/inspect-variable/index.md b/docs/sources/dashboards/variables/inspect-variable/index.md index 78ceeb9f131..f6af6425b2a 100644 --- a/docs/sources/dashboards/variables/inspect-variable/index.md +++ b/docs/sources/dashboards/variables/inspect-variable/index.md @@ -9,6 +9,11 @@ keywords: - guide - template - variable +labels: + products: + - cloud + - enterprise + - oss title: Inspect variables weight: 200 --- diff --git a/docs/sources/dashboards/variables/variable-syntax/index.md b/docs/sources/dashboards/variables/variable-syntax/index.md index fdfb8e84d32..146a333983b 100644 --- a/docs/sources/dashboards/variables/variable-syntax/index.md +++ b/docs/sources/dashboards/variables/variable-syntax/index.md @@ -10,6 +10,11 @@ keywords: - guide - template - variable +labels: + products: + - cloud + - enterprise + - oss title: Variable syntax weight: 300 --- diff --git a/docs/sources/datasources/_index.md b/docs/sources/datasources/_index.md index 42a064765ae..244fad1fec8 100644 --- a/docs/sources/datasources/_index.md +++ b/docs/sources/datasources/_index.md @@ -2,6 +2,11 @@ aliases: - data-sources/ - overview/ +labels: + products: + - cloud + - enterprise + - oss title: Data sources weight: 60 --- diff --git a/docs/sources/datasources/alertmanager/_index.md b/docs/sources/datasources/alertmanager/_index.md index 3c4ac6b793d..cfd332744b9 100644 --- a/docs/sources/datasources/alertmanager/_index.md +++ b/docs/sources/datasources/alertmanager/_index.md @@ -9,6 +9,11 @@ keywords: - alertmanager - guide - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Alertmanager title: Alertmanager data source weight: 150 diff --git a/docs/sources/datasources/aws-cloudwatch/_index.md b/docs/sources/datasources/aws-cloudwatch/_index.md index 57840fbd6ae..c78cb6a50ba 100644 --- a/docs/sources/datasources/aws-cloudwatch/_index.md +++ b/docs/sources/datasources/aws-cloudwatch/_index.md @@ -11,6 +11,11 @@ keywords: - grafana - cloudwatch - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: Amazon CloudWatch title: Amazon CloudWatch data source weight: 200 diff --git a/docs/sources/datasources/aws-cloudwatch/aws-authentication/index.md b/docs/sources/datasources/aws-cloudwatch/aws-authentication/index.md index 385e493d274..d983307d9e3 100644 --- a/docs/sources/datasources/aws-cloudwatch/aws-authentication/index.md +++ b/docs/sources/datasources/aws-cloudwatch/aws-authentication/index.md @@ -8,6 +8,11 @@ keywords: - grafana - aws - authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: AWS authentication title: Configure AWS authentication weight: 200 diff --git a/docs/sources/datasources/aws-cloudwatch/query-editor/index.md b/docs/sources/datasources/aws-cloudwatch/query-editor/index.md index e6b6e40d6a6..72cb53013d6 100644 --- a/docs/sources/datasources/aws-cloudwatch/query-editor/index.md +++ b/docs/sources/datasources/aws-cloudwatch/query-editor/index.md @@ -10,6 +10,11 @@ keywords: - cloudwatch - guide - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Query editor title: Amazon CloudWatch query editor weight: 300 diff --git a/docs/sources/datasources/aws-cloudwatch/template-variables/index.md b/docs/sources/datasources/aws-cloudwatch/template-variables/index.md index 752fa2b6109..a81b83f3a05 100644 --- a/docs/sources/datasources/aws-cloudwatch/template-variables/index.md +++ b/docs/sources/datasources/aws-cloudwatch/template-variables/index.md @@ -9,6 +9,11 @@ keywords: - cloudwatch - templates - variables +labels: + products: + - cloud + - enterprise + - oss menuTitle: Template variables title: CloudWatch template variables weight: 400 diff --git a/docs/sources/datasources/azure-monitor/_index.md b/docs/sources/datasources/azure-monitor/_index.md index 743f8d323c0..bceee3fa1d2 100644 --- a/docs/sources/datasources/azure-monitor/_index.md +++ b/docs/sources/datasources/azure-monitor/_index.md @@ -15,6 +15,11 @@ keywords: - log - analytics - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: Azure Monitor title: Azure Monitor data source weight: 300 diff --git a/docs/sources/datasources/azure-monitor/query-editor/index.md b/docs/sources/datasources/azure-monitor/query-editor/index.md index 4c0b1d0e3ee..6cef682ace8 100644 --- a/docs/sources/datasources/azure-monitor/query-editor/index.md +++ b/docs/sources/datasources/azure-monitor/query-editor/index.md @@ -13,6 +13,11 @@ keywords: - queries - traces - application insights +labels: + products: + - cloud + - enterprise + - oss menuTitle: Query editor title: Azure Monitor query editor weight: 300 diff --git a/docs/sources/datasources/azure-monitor/template-variables/index.md b/docs/sources/datasources/azure-monitor/template-variables/index.md index f31c7ca0c28..813211675a0 100644 --- a/docs/sources/datasources/azure-monitor/template-variables/index.md +++ b/docs/sources/datasources/azure-monitor/template-variables/index.md @@ -15,6 +15,11 @@ keywords: - templates - variables - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Template variables title: Azure Monitor template variables weight: 400 diff --git a/docs/sources/datasources/elasticsearch/_index.md b/docs/sources/datasources/elasticsearch/_index.md index fde947071cd..2dd3aab22c8 100644 --- a/docs/sources/datasources/elasticsearch/_index.md +++ b/docs/sources/datasources/elasticsearch/_index.md @@ -7,6 +7,11 @@ keywords: - grafana - elasticsearch - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: Elasticsearch title: Elasticsearch data source weight: 325 diff --git a/docs/sources/datasources/elasticsearch/query-editor/index.md b/docs/sources/datasources/elasticsearch/query-editor/index.md index e0d4b0cbd44..9ac7a1e2951 100644 --- a/docs/sources/datasources/elasticsearch/query-editor/index.md +++ b/docs/sources/datasources/elasticsearch/query-editor/index.md @@ -10,6 +10,11 @@ keywords: - metrics - logs - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Query editor title: Elasticsearch query editor weight: 300 diff --git a/docs/sources/datasources/elasticsearch/template-variables/index.md b/docs/sources/datasources/elasticsearch/template-variables/index.md index 2652022fa4f..6a903b9328f 100644 --- a/docs/sources/datasources/elasticsearch/template-variables/index.md +++ b/docs/sources/datasources/elasticsearch/template-variables/index.md @@ -8,6 +8,11 @@ keywords: - templates - variables - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Template variables title: Elasticsearch template variables weight: 400 diff --git a/docs/sources/datasources/google-cloud-monitoring/_index.md b/docs/sources/datasources/google-cloud-monitoring/_index.md index 927a5a6ae98..4179c84d635 100644 --- a/docs/sources/datasources/google-cloud-monitoring/_index.md +++ b/docs/sources/datasources/google-cloud-monitoring/_index.md @@ -14,6 +14,11 @@ keywords: - guide - cloud - monitoring +labels: + products: + - cloud + - enterprise + - oss menuTitle: Google Cloud Monitoring title: Google Cloud Monitoring data source weight: 350 diff --git a/docs/sources/datasources/google-cloud-monitoring/google-authentication/index.md b/docs/sources/datasources/google-cloud-monitoring/google-authentication/index.md index 841fc9f5ce0..92f7b017a17 100644 --- a/docs/sources/datasources/google-cloud-monitoring/google-authentication/index.md +++ b/docs/sources/datasources/google-cloud-monitoring/google-authentication/index.md @@ -6,6 +6,11 @@ keywords: - grafana - google - authentication +labels: + products: + - cloud + - enterprise + - oss title: Authentication weight: 5 --- diff --git a/docs/sources/datasources/google-cloud-monitoring/query-editor/index.md b/docs/sources/datasources/google-cloud-monitoring/query-editor/index.md index 64580dc5ce0..b4fa5c2caa5 100644 --- a/docs/sources/datasources/google-cloud-monitoring/query-editor/index.md +++ b/docs/sources/datasources/google-cloud-monitoring/query-editor/index.md @@ -8,6 +8,11 @@ keywords: - cloud - monitoring - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Query editor title: Google Cloud Monitoring query editor weight: 300 diff --git a/docs/sources/datasources/google-cloud-monitoring/template-variables/index.md b/docs/sources/datasources/google-cloud-monitoring/template-variables/index.md index 28651454c0a..404a37f935d 100644 --- a/docs/sources/datasources/google-cloud-monitoring/template-variables/index.md +++ b/docs/sources/datasources/google-cloud-monitoring/template-variables/index.md @@ -11,6 +11,11 @@ keywords: - queries - template - variable +labels: + products: + - cloud + - enterprise + - oss menuTitle: Template variables title: Google Cloud Monitoring template variables weight: 300 diff --git a/docs/sources/datasources/grafana-pyroscope.md b/docs/sources/datasources/grafana-pyroscope.md index 596ff2d66d8..0d548c3a908 100644 --- a/docs/sources/datasources/grafana-pyroscope.md +++ b/docs/sources/datasources/grafana-pyroscope.md @@ -10,6 +10,11 @@ keywords: - guide - profiling - pyroscope +labels: + products: + - cloud + - enterprise + - oss title: Grafana Pyroscope weight: 1150 --- diff --git a/docs/sources/datasources/graphite/_index.md b/docs/sources/datasources/graphite/_index.md index 231d614714e..962ceb4b07e 100644 --- a/docs/sources/datasources/graphite/_index.md +++ b/docs/sources/datasources/graphite/_index.md @@ -7,6 +7,11 @@ keywords: - grafana - graphite - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: Graphite title: Graphite data source weight: 600 diff --git a/docs/sources/datasources/graphite/query-editor/index.md b/docs/sources/datasources/graphite/query-editor/index.md index ff11067aba0..40a38c4fc4d 100644 --- a/docs/sources/datasources/graphite/query-editor/index.md +++ b/docs/sources/datasources/graphite/query-editor/index.md @@ -11,6 +11,11 @@ keywords: - logs - resources - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Query editor title: Graphite query editor weight: 300 diff --git a/docs/sources/datasources/graphite/template-variables/index.md b/docs/sources/datasources/graphite/template-variables/index.md index e8973ff7887..e68d2a47df1 100644 --- a/docs/sources/datasources/graphite/template-variables/index.md +++ b/docs/sources/datasources/graphite/template-variables/index.md @@ -8,6 +8,11 @@ keywords: - queries - template - variable +labels: + products: + - cloud + - enterprise + - oss menuTitle: Template variables title: Graphite template variables weight: 300 diff --git a/docs/sources/datasources/influxdb/_index.md b/docs/sources/datasources/influxdb/_index.md index 26dab17854c..1328ebcd81c 100644 --- a/docs/sources/datasources/influxdb/_index.md +++ b/docs/sources/datasources/influxdb/_index.md @@ -10,6 +10,11 @@ keywords: - influxdb - guide - flux +labels: + products: + - cloud + - enterprise + - oss menuTitle: InfluxDB title: InfluxDB data source weight: 700 diff --git a/docs/sources/datasources/influxdb/query-editor/index.md b/docs/sources/datasources/influxdb/query-editor/index.md index 5829cf8b57e..3c276d61d72 100644 --- a/docs/sources/datasources/influxdb/query-editor/index.md +++ b/docs/sources/datasources/influxdb/query-editor/index.md @@ -3,6 +3,11 @@ aliases: - ../../data-sources/influxdb/query-editor/ - influxdb-flux/ description: Guide for Flux in Grafana +labels: + products: + - cloud + - enterprise + - oss title: Flux support in Grafana weight: 200 --- diff --git a/docs/sources/datasources/influxdb/template-variables/index.md b/docs/sources/datasources/influxdb/template-variables/index.md index fede1000831..bb58b2684b0 100644 --- a/docs/sources/datasources/influxdb/template-variables/index.md +++ b/docs/sources/datasources/influxdb/template-variables/index.md @@ -10,6 +10,11 @@ keywords: - queries - template - variable +labels: + products: + - cloud + - enterprise + - oss menuTitle: Template variables title: InfluxDB template variables weight: 300 diff --git a/docs/sources/datasources/jaeger/_index.md b/docs/sources/datasources/jaeger/_index.md index 6dac40618d9..a1d6c8737be 100644 --- a/docs/sources/datasources/jaeger/_index.md +++ b/docs/sources/datasources/jaeger/_index.md @@ -8,6 +8,11 @@ keywords: - jaeger - guide - tracing +labels: + products: + - cloud + - enterprise + - oss menuTitle: Jaeger title: Jaeger data source weight: 800 diff --git a/docs/sources/datasources/loki/_index.md b/docs/sources/datasources/loki/_index.md index db5fdcb6fdd..6571dd1ecb3 100644 --- a/docs/sources/datasources/loki/_index.md +++ b/docs/sources/datasources/loki/_index.md @@ -8,6 +8,11 @@ keywords: - loki - logging - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: Loki title: Loki data source weight: 800 diff --git a/docs/sources/datasources/loki/query-editor/index.md b/docs/sources/datasources/loki/query-editor/index.md index ada4c17930a..00143f41102 100644 --- a/docs/sources/datasources/loki/query-editor/index.md +++ b/docs/sources/datasources/loki/query-editor/index.md @@ -7,6 +7,11 @@ keywords: - loki - logs - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Query editor title: Loki query editor weight: 300 diff --git a/docs/sources/datasources/loki/template-variables/index.md b/docs/sources/datasources/loki/template-variables/index.md index 1dee7645b8f..33f5de5702a 100644 --- a/docs/sources/datasources/loki/template-variables/index.md +++ b/docs/sources/datasources/loki/template-variables/index.md @@ -9,6 +9,11 @@ keywords: - queries - template - variable +labels: + products: + - cloud + - enterprise + - oss menuTitle: Template variables title: Loki template variables weight: 300 diff --git a/docs/sources/datasources/mssql/_index.md b/docs/sources/datasources/mssql/_index.md index 60a7006145a..85cad22746a 100644 --- a/docs/sources/datasources/mssql/_index.md +++ b/docs/sources/datasources/mssql/_index.md @@ -10,6 +10,11 @@ keywords: - SQL - guide - Azure SQL Database +labels: + products: + - cloud + - enterprise + - oss menuTitle: Microsoft SQL Server title: Microsoft SQL Server data source weight: 900 diff --git a/docs/sources/datasources/mssql/query-editor/index.md b/docs/sources/datasources/mssql/query-editor/index.md index 3aaf0cb6fb5..6ac2713ec9f 100644 --- a/docs/sources/datasources/mssql/query-editor/index.md +++ b/docs/sources/datasources/mssql/query-editor/index.md @@ -10,6 +10,11 @@ keywords: - guide - Azure SQL Database - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Query editor title: Microsoft SQL Server query editor weight: 300 diff --git a/docs/sources/datasources/mssql/template-variables/index.md b/docs/sources/datasources/mssql/template-variables/index.md index 6ec7fe9fc5f..ee5df58dbb8 100644 --- a/docs/sources/datasources/mssql/template-variables/index.md +++ b/docs/sources/datasources/mssql/template-variables/index.md @@ -11,6 +11,11 @@ keywords: - templates - variables - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Template variables title: Microsoft SQL Server template variables weight: 400 diff --git a/docs/sources/datasources/mysql/_index.md b/docs/sources/datasources/mysql/_index.md index 56d701ab758..0e93cea6c5a 100644 --- a/docs/sources/datasources/mysql/_index.md +++ b/docs/sources/datasources/mysql/_index.md @@ -7,6 +7,11 @@ keywords: - grafana - mysql - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: MySQL title: MySQL data source weight: 1000 diff --git a/docs/sources/datasources/opentsdb/_index.md b/docs/sources/datasources/opentsdb/_index.md index be736dc2c49..865a8373ebe 100644 --- a/docs/sources/datasources/opentsdb/_index.md +++ b/docs/sources/datasources/opentsdb/_index.md @@ -8,6 +8,11 @@ keywords: - grafana - opentsdb - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: OpenTSDB title: OpenTSDB data source weight: 1100 diff --git a/docs/sources/datasources/parca.md b/docs/sources/datasources/parca.md index 8ef350f6bbd..0e6e38917f4 100644 --- a/docs/sources/datasources/parca.md +++ b/docs/sources/datasources/parca.md @@ -8,6 +8,11 @@ keywords: - parca - guide - profiling +labels: + products: + - cloud + - enterprise + - oss title: Parca weight: 1110 --- diff --git a/docs/sources/datasources/postgres/_index.md b/docs/sources/datasources/postgres/_index.md index 8d6de86f050..aa3d7812f8d 100644 --- a/docs/sources/datasources/postgres/_index.md +++ b/docs/sources/datasources/postgres/_index.md @@ -7,6 +7,11 @@ keywords: - grafana - postgresql - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: PostgreSQL title: PostgreSQL data source weight: 1200 diff --git a/docs/sources/datasources/prometheus/_index.md b/docs/sources/datasources/prometheus/_index.md index e3d7a63059e..3274519de12 100644 --- a/docs/sources/datasources/prometheus/_index.md +++ b/docs/sources/datasources/prometheus/_index.md @@ -7,6 +7,11 @@ keywords: - grafana - prometheus - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: Prometheus title: Prometheus data source weight: 1300 diff --git a/docs/sources/datasources/prometheus/configure-prometheus-data-source.md b/docs/sources/datasources/prometheus/configure-prometheus-data-source.md index a8558179d5c..c0f79434499 100644 --- a/docs/sources/datasources/prometheus/configure-prometheus-data-source.md +++ b/docs/sources/datasources/prometheus/configure-prometheus-data-source.md @@ -7,6 +7,11 @@ keywords: - grafana - prometheus - guide +labels: + products: + - cloud + - enterprise + - oss menuTitle: Configure Prometheus title: Configure the Prometheus data source weight: 200 diff --git a/docs/sources/datasources/prometheus/query-editor/index.md b/docs/sources/datasources/prometheus/query-editor/index.md index 3661393273d..afbc78d9173 100644 --- a/docs/sources/datasources/prometheus/query-editor/index.md +++ b/docs/sources/datasources/prometheus/query-editor/index.md @@ -7,6 +7,11 @@ keywords: - prometheus - logs - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Query editor title: Prometheus query editor weight: 300 diff --git a/docs/sources/datasources/prometheus/template-variables/index.md b/docs/sources/datasources/prometheus/template-variables/index.md index c2ee82823ee..9fb123a7929 100644 --- a/docs/sources/datasources/prometheus/template-variables/index.md +++ b/docs/sources/datasources/prometheus/template-variables/index.md @@ -8,6 +8,11 @@ keywords: - templates - variables - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Template variables title: Prometheus template variables weight: 400 diff --git a/docs/sources/datasources/tempo/_index.md b/docs/sources/datasources/tempo/_index.md index d220b1e9e73..858b6f3d44f 100644 --- a/docs/sources/datasources/tempo/_index.md +++ b/docs/sources/datasources/tempo/_index.md @@ -8,6 +8,11 @@ keywords: - tempo - guide - tracing +labels: + products: + - cloud + - enterprise + - oss menuTitle: Tempo title: Tempo data source weight: 1400 diff --git a/docs/sources/datasources/tempo/query-editor/index.md b/docs/sources/datasources/tempo/query-editor/index.md index 640e85ad630..33683b4e17c 100644 --- a/docs/sources/datasources/tempo/query-editor/index.md +++ b/docs/sources/datasources/tempo/query-editor/index.md @@ -7,6 +7,11 @@ keywords: - tempo - traces - queries +labels: + products: + - cloud + - enterprise + - oss menuTitle: Query editor title: Tempo query editor weight: 300 diff --git a/docs/sources/datasources/testdata/_index.md b/docs/sources/datasources/testdata/_index.md index 21ad45f8095..833797641f9 100644 --- a/docs/sources/datasources/testdata/_index.md +++ b/docs/sources/datasources/testdata/_index.md @@ -9,6 +9,11 @@ keywords: - troubleshooting - panels - testdata +labels: + products: + - cloud + - enterprise + - oss menuTitle: TestData title: TestData data source weight: 1500 diff --git a/docs/sources/datasources/zipkin/_index.md b/docs/sources/datasources/zipkin/_index.md index 00d17b03cca..120ddbee22e 100644 --- a/docs/sources/datasources/zipkin/_index.md +++ b/docs/sources/datasources/zipkin/_index.md @@ -8,6 +8,11 @@ keywords: - zipkin - tracing - querying +labels: + products: + - cloud + - enterprise + - oss menuTitle: Zipkin title: Zipkin data source weight: 1600 diff --git a/docs/sources/developers/_index.md b/docs/sources/developers/_index.md index 30e0b30844c..780afdfcd54 100644 --- a/docs/sources/developers/_index.md +++ b/docs/sources/developers/_index.md @@ -1,6 +1,10 @@ --- aliases: - plugins/developing/ +labels: + products: + - enterprise + - oss title: Developers weight: 190 --- diff --git a/docs/sources/developers/angular_deprecation/_index.md b/docs/sources/developers/angular_deprecation/_index.md index ea1d2f07f90..cf7fd5235fe 100644 --- a/docs/sources/developers/angular_deprecation/_index.md +++ b/docs/sources/developers/angular_deprecation/_index.md @@ -4,6 +4,10 @@ keywords: - documentation - developers - resources +labels: + products: + - enterprise + - oss title: Angular support deprecation weight: 500 --- diff --git a/docs/sources/developers/angular_deprecation/angular-plugins.md b/docs/sources/developers/angular_deprecation/angular-plugins.md index 43d8227ee3d..c8a5058fb70 100644 --- a/docs/sources/developers/angular_deprecation/angular-plugins.md +++ b/docs/sources/developers/angular_deprecation/angular-plugins.md @@ -6,6 +6,10 @@ keywords: - angular - deprecation - migration +labels: + products: + - enterprise + - oss title: Plugins using AngularJS --- diff --git a/docs/sources/developers/cla.md b/docs/sources/developers/cla.md index 784ba0be3ea..741a958f1ba 100644 --- a/docs/sources/developers/cla.md +++ b/docs/sources/developers/cla.md @@ -3,6 +3,10 @@ aliases: - ../project/cla/ - /docs/contributing/cla.html/ description: Contributor License Agreement (CLA) +labels: + products: + - enterprise + - oss title: Contributor License Agreement (CLA) weight: 400 --- diff --git a/docs/sources/developers/contribute.md b/docs/sources/developers/contribute.md index ec5e4ccbc60..cb0d0516b96 100644 --- a/docs/sources/developers/contribute.md +++ b/docs/sources/developers/contribute.md @@ -4,6 +4,10 @@ keywords: - documentation - developers - resources +labels: + products: + - enterprise + - oss title: Contribute to Grafana weight: 300 --- diff --git a/docs/sources/developers/http_api/_index.md b/docs/sources/developers/http_api/_index.md index 8f9e30f31fc..81d8b851f43 100644 --- a/docs/sources/developers/http_api/_index.md +++ b/docs/sources/developers/http_api/_index.md @@ -10,6 +10,10 @@ keywords: - documentation - api - overview +labels: + products: + - enterprise + - oss title: HTTP API weight: 100 --- diff --git a/docs/sources/developers/http_api/access_control.md b/docs/sources/developers/http_api/access_control.md index 23115da777d..c0c59357637 100644 --- a/docs/sources/developers/http_api/access_control.md +++ b/docs/sources/developers/http_api/access_control.md @@ -12,6 +12,10 @@ keywords: - role-based-access-control - acl - enterprise +labels: + products: + - enterprise + - oss title: RBAC HTTP API --- diff --git a/docs/sources/developers/http_api/admin.md b/docs/sources/developers/http_api/admin.md index 02c6bab04c3..b7a40e1d741 100644 --- a/docs/sources/developers/http_api/admin.md +++ b/docs/sources/developers/http_api/admin.md @@ -9,6 +9,10 @@ keywords: - documentation - api - admin +labels: + products: + - enterprise + - oss title: 'Admin HTTP API ' --- diff --git a/docs/sources/developers/http_api/alerting.md b/docs/sources/developers/http_api/alerting.md index dec680309a3..f05d79a5ba2 100644 --- a/docs/sources/developers/http_api/alerting.md +++ b/docs/sources/developers/http_api/alerting.md @@ -10,6 +10,10 @@ keywords: - api - alerting - alerts +labels: + products: + - enterprise + - oss title: Legacy Alerting API --- diff --git a/docs/sources/developers/http_api/alerting_notification_channels.md b/docs/sources/developers/http_api/alerting_notification_channels.md index f12e71d7bf3..440237b3287 100644 --- a/docs/sources/developers/http_api/alerting_notification_channels.md +++ b/docs/sources/developers/http_api/alerting_notification_channels.md @@ -11,6 +11,10 @@ keywords: - alerting - alerts - notifications +labels: + products: + - enterprise + - oss title: Legacy Alerting Notification Channels API --- diff --git a/docs/sources/developers/http_api/alerting_provisioning.md b/docs/sources/developers/http_api/alerting_provisioning.md index 4dcf37b076f..fa5f96bf4d3 100644 --- a/docs/sources/developers/http_api/alerting_provisioning.md +++ b/docs/sources/developers/http_api/alerting_provisioning.md @@ -10,6 +10,10 @@ keywords: - api - alerting - alerts +labels: + products: + - enterprise + - oss title: 'Alerting Provisioning HTTP API ' --- diff --git a/docs/sources/developers/http_api/annotations.md b/docs/sources/developers/http_api/annotations.md index be1c3f9d5a1..337bb230886 100644 --- a/docs/sources/developers/http_api/annotations.md +++ b/docs/sources/developers/http_api/annotations.md @@ -11,6 +11,10 @@ keywords: - annotation - annotations - comment +labels: + products: + - enterprise + - oss title: Annotations HTTP API --- diff --git a/docs/sources/developers/http_api/auth.md b/docs/sources/developers/http_api/auth.md index 2b7d7abb7ac..e5db624f239 100644 --- a/docs/sources/developers/http_api/auth.md +++ b/docs/sources/developers/http_api/auth.md @@ -10,6 +10,10 @@ keywords: - documentation - api - authentication +labels: + products: + - enterprise + - oss title: 'Authentication HTTP API ' --- diff --git a/docs/sources/developers/http_api/correlations.md b/docs/sources/developers/http_api/correlations.md index d000105e530..fd6f712fa70 100644 --- a/docs/sources/developers/http_api/correlations.md +++ b/docs/sources/developers/http_api/correlations.md @@ -10,6 +10,10 @@ keywords: - api - correlations - Glue +labels: + products: + - enterprise + - oss title: 'Correlations HTTP API ' --- diff --git a/docs/sources/developers/http_api/create-api-tokens-for-org.md b/docs/sources/developers/http_api/create-api-tokens-for-org.md index 47833597593..1e3a1ebeb18 100644 --- a/docs/sources/developers/http_api/create-api-tokens-for-org.md +++ b/docs/sources/developers/http_api/create-api-tokens-for-org.md @@ -10,6 +10,10 @@ keywords: - Token - Org - Organization +labels: + products: + - enterprise + - oss title: 'API Tutorial: Create API tokens and dashboards for an organization' weight: 150 --- diff --git a/docs/sources/developers/http_api/curl-examples.md b/docs/sources/developers/http_api/curl-examples.md index b733e4ca28d..bea3d4e702d 100644 --- a/docs/sources/developers/http_api/curl-examples.md +++ b/docs/sources/developers/http_api/curl-examples.md @@ -9,6 +9,10 @@ keywords: - documentation - api - curl +labels: + products: + - enterprise + - oss title: cURL examples --- diff --git a/docs/sources/developers/http_api/dashboard.md b/docs/sources/developers/http_api/dashboard.md index 7ecbf17cf45..180a0d6a394 100644 --- a/docs/sources/developers/http_api/dashboard.md +++ b/docs/sources/developers/http_api/dashboard.md @@ -9,6 +9,10 @@ keywords: - documentation - api - dashboard +labels: + products: + - enterprise + - oss title: Dashboard HTTP API --- diff --git a/docs/sources/developers/http_api/dashboard_permissions.md b/docs/sources/developers/http_api/dashboard_permissions.md index c4ba5a349a9..d9544943e1c 100644 --- a/docs/sources/developers/http_api/dashboard_permissions.md +++ b/docs/sources/developers/http_api/dashboard_permissions.md @@ -13,6 +13,10 @@ keywords: - permission - permissions - acl +labels: + products: + - enterprise + - oss title: Dashboard Permissions HTTP API --- diff --git a/docs/sources/developers/http_api/dashboard_versions.md b/docs/sources/developers/http_api/dashboard_versions.md index fce9f264731..28cb554044c 100644 --- a/docs/sources/developers/http_api/dashboard_versions.md +++ b/docs/sources/developers/http_api/dashboard_versions.md @@ -11,6 +11,10 @@ keywords: - api - dashboard - versions +labels: + products: + - enterprise + - oss title: 'Dashboard Versions HTTP API ' --- diff --git a/docs/sources/developers/http_api/data_source.md b/docs/sources/developers/http_api/data_source.md index 15005609f88..d2afd8587c0 100644 --- a/docs/sources/developers/http_api/data_source.md +++ b/docs/sources/developers/http_api/data_source.md @@ -10,6 +10,10 @@ keywords: - documentation - api - data source +labels: + products: + - enterprise + - oss title: Data source HTTP API --- diff --git a/docs/sources/developers/http_api/datasource_permissions.md b/docs/sources/developers/http_api/datasource_permissions.md index db755a6ba20..16780c52fc9 100644 --- a/docs/sources/developers/http_api/datasource_permissions.md +++ b/docs/sources/developers/http_api/datasource_permissions.md @@ -14,6 +14,10 @@ keywords: - permissions - acl - enterprise +labels: + products: + - enterprise + - oss title: Datasource Permissions HTTP API --- diff --git a/docs/sources/developers/http_api/folder.md b/docs/sources/developers/http_api/folder.md index 402829eb7ac..58e284cc6a9 100644 --- a/docs/sources/developers/http_api/folder.md +++ b/docs/sources/developers/http_api/folder.md @@ -9,6 +9,10 @@ keywords: - documentation - api - folder +labels: + products: + - enterprise + - oss title: Folder HTTP API --- diff --git a/docs/sources/developers/http_api/folder_dashboard_search.md b/docs/sources/developers/http_api/folder_dashboard_search.md index 330c5f4a5ae..68c2a6bfa5f 100644 --- a/docs/sources/developers/http_api/folder_dashboard_search.md +++ b/docs/sources/developers/http_api/folder_dashboard_search.md @@ -11,6 +11,10 @@ keywords: - search - folder - dashboard +labels: + products: + - enterprise + - oss title: Folder/Dashboard Search HTTP API --- diff --git a/docs/sources/developers/http_api/folder_permissions.md b/docs/sources/developers/http_api/folder_permissions.md index 456c085d578..4e7b3ed31ff 100644 --- a/docs/sources/developers/http_api/folder_permissions.md +++ b/docs/sources/developers/http_api/folder_permissions.md @@ -13,6 +13,10 @@ keywords: - permission - permissions - acl +labels: + products: + - enterprise + - oss title: Folder Permissions HTTP API --- diff --git a/docs/sources/developers/http_api/library_element.md b/docs/sources/developers/http_api/library_element.md index ba2a865b285..72321b341c3 100644 --- a/docs/sources/developers/http_api/library_element.md +++ b/docs/sources/developers/http_api/library_element.md @@ -9,6 +9,10 @@ keywords: - documentation - api - library-element +labels: + products: + - enterprise + - oss title: 'Library Element HTTP API ' --- diff --git a/docs/sources/developers/http_api/licensing.md b/docs/sources/developers/http_api/licensing.md index 3e44b193da2..a248fddc8cc 100644 --- a/docs/sources/developers/http_api/licensing.md +++ b/docs/sources/developers/http_api/licensing.md @@ -10,6 +10,10 @@ keywords: - api - licensing - enterprise +labels: + products: + - enterprise + - oss title: Licensing HTTP API --- diff --git a/docs/sources/developers/http_api/org.md b/docs/sources/developers/http_api/org.md index 48ed44cf6bc..c83f5a84c4b 100644 --- a/docs/sources/developers/http_api/org.md +++ b/docs/sources/developers/http_api/org.md @@ -10,6 +10,10 @@ keywords: - documentation - api - organization +labels: + products: + - enterprise + - oss title: Organization HTTP API --- diff --git a/docs/sources/developers/http_api/other.md b/docs/sources/developers/http_api/other.md index bb15ed643fa..2cb0e3b342e 100644 --- a/docs/sources/developers/http_api/other.md +++ b/docs/sources/developers/http_api/other.md @@ -9,6 +9,10 @@ keywords: - documentation - api - other +labels: + products: + - enterprise + - oss title: 'Other HTTP API ' --- diff --git a/docs/sources/developers/http_api/playlist.md b/docs/sources/developers/http_api/playlist.md index 46a41d5b690..f25c1ba301f 100644 --- a/docs/sources/developers/http_api/playlist.md +++ b/docs/sources/developers/http_api/playlist.md @@ -9,6 +9,10 @@ keywords: - documentation - api - playlist +labels: + products: + - enterprise + - oss title: 'Playlist HTTP API ' --- diff --git a/docs/sources/developers/http_api/preferences.md b/docs/sources/developers/http_api/preferences.md index 46863fa8358..a3f5b6b1afd 100644 --- a/docs/sources/developers/http_api/preferences.md +++ b/docs/sources/developers/http_api/preferences.md @@ -9,6 +9,10 @@ keywords: - documentation - api - preferences +labels: + products: + - enterprise + - oss title: 'HTTP Preferences API ' --- diff --git a/docs/sources/developers/http_api/query_and_resource_caching.md b/docs/sources/developers/http_api/query_and_resource_caching.md index ad33eec425f..826292decb6 100644 --- a/docs/sources/developers/http_api/query_and_resource_caching.md +++ b/docs/sources/developers/http_api/query_and_resource_caching.md @@ -14,6 +14,10 @@ keywords: - query caching - resource caching - data source +labels: + products: + - enterprise + - oss title: Query and Resource Caching HTTP API --- diff --git a/docs/sources/developers/http_api/query_history.md b/docs/sources/developers/http_api/query_history.md index b6d1d01877a..d380ed1f722 100644 --- a/docs/sources/developers/http_api/query_history.md +++ b/docs/sources/developers/http_api/query_history.md @@ -9,6 +9,10 @@ keywords: - documentation - api - queryHistory +labels: + products: + - enterprise + - oss title: 'Query History HTTP API ' --- diff --git a/docs/sources/developers/http_api/reporting.md b/docs/sources/developers/http_api/reporting.md index 989be605c90..d1f1d794716 100644 --- a/docs/sources/developers/http_api/reporting.md +++ b/docs/sources/developers/http_api/reporting.md @@ -8,6 +8,10 @@ keywords: - enterprise - api - reporting +labels: + products: + - enterprise + - oss title: Reporting API --- diff --git a/docs/sources/developers/http_api/serviceaccount.md b/docs/sources/developers/http_api/serviceaccount.md index c97a73ef23b..8dff8a38d90 100644 --- a/docs/sources/developers/http_api/serviceaccount.md +++ b/docs/sources/developers/http_api/serviceaccount.md @@ -9,6 +9,10 @@ keywords: - documentation - api - serviceaccount +labels: + products: + - enterprise + - oss title: Service account HTTP API --- diff --git a/docs/sources/developers/http_api/short_url.md b/docs/sources/developers/http_api/short_url.md index 1694b5d95c8..03390a5f655 100644 --- a/docs/sources/developers/http_api/short_url.md +++ b/docs/sources/developers/http_api/short_url.md @@ -9,6 +9,10 @@ keywords: - documentation - api - shortUrl +labels: + products: + - enterprise + - oss title: 'Short URL HTTP API ' --- diff --git a/docs/sources/developers/http_api/snapshot.md b/docs/sources/developers/http_api/snapshot.md index 44eb3735a7c..54360b768dd 100644 --- a/docs/sources/developers/http_api/snapshot.md +++ b/docs/sources/developers/http_api/snapshot.md @@ -9,6 +9,10 @@ keywords: - documentation - api - snapshot +labels: + products: + - enterprise + - oss title: 'HTTP Snapshot API ' --- diff --git a/docs/sources/developers/http_api/team.md b/docs/sources/developers/http_api/team.md index 6ec7a54875b..2a5b3ac5744 100644 --- a/docs/sources/developers/http_api/team.md +++ b/docs/sources/developers/http_api/team.md @@ -11,6 +11,10 @@ keywords: - team - teams - group +labels: + products: + - enterprise + - oss title: Team HTTP API --- diff --git a/docs/sources/developers/http_api/team_sync.md b/docs/sources/developers/http_api/team_sync.md index 1831803d61c..7db5d9f79eb 100644 --- a/docs/sources/developers/http_api/team_sync.md +++ b/docs/sources/developers/http_api/team_sync.md @@ -14,6 +14,10 @@ keywords: - group - member - enterprise +labels: + products: + - enterprise + - oss title: Team Sync HTTP API --- diff --git a/docs/sources/developers/http_api/user.md b/docs/sources/developers/http_api/user.md index d278d14a306..986f57de26d 100644 --- a/docs/sources/developers/http_api/user.md +++ b/docs/sources/developers/http_api/user.md @@ -9,6 +9,10 @@ keywords: - documentation - api - user +labels: + products: + - enterprise + - oss title: User HTTP API --- diff --git a/docs/sources/developers/kinds/_index.md b/docs/sources/developers/kinds/_index.md index 248812e7db6..de9fa0e3fb1 100644 --- a/docs/sources/developers/kinds/_index.md +++ b/docs/sources/developers/kinds/_index.md @@ -1,8 +1,12 @@ --- -title: Grafana schema -weight: 200 _build: list: false +labels: + products: + - enterprise + - oss +title: Grafana schema +weight: 200 --- # Grafana schema @@ -22,10 +26,11 @@ parts. Additionally, we must account for having Grafana continue to work as we m for every large-scale refactoring. In the Grafana ecosystem, there are three basic Kind categories and associated schema categories: + - [Core Kinds]({{< relref "core/" >}}) - Custom Kinds - [Composable Kinds]({{< relref "composable/" >}}) -The schema authoring workflow for each varies, as does the path to maturity. -[Grafana Kinds - From Zero to Maturity]({{< relref "maturity/" >}}) contains general reference material applicable to -all Kind-writing, and links to the guides for each category of Kind. +The schema authoring workflow for each varies, as does the path to maturity. +[Grafana Kinds - From Zero to Maturity]({{< relref "maturity/" >}}) contains general reference material applicable to +all Kind-writing, and links to the guides for each category of Kind. diff --git a/docs/sources/developers/kinds/composable/_index.md b/docs/sources/developers/kinds/composable/_index.md index 76069914a96..14e40cd6a3f 100644 --- a/docs/sources/developers/kinds/composable/_index.md +++ b/docs/sources/developers/kinds/composable/_index.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Composable kinds weight: 200 --- diff --git a/docs/sources/developers/kinds/composable/alertgroups/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/alertgroups/panelcfg/schema-reference.md index 8c5a5f91dad..6c58417cf04 100644 --- a/docs/sources/developers/kinds/composable/alertgroups/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/alertgroups/panelcfg/schema-reference.md @@ -1,28 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: AlertGroupsPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## AlertGroupsPanelCfg #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|----------------|---------|----------|---------|-------------------------------------------------------------| +| -------------- | ------- | -------- | ------- | ----------------------------------------------------------- | | `alertmanager` | string | **Yes** | | Name of the alertmanager used as a source for alerts | | `expandAll` | boolean | **Yes** | | Expand all alert groups by default | | `labels` | string | **Yes** | | Comma-separated list of values used to filter alert results | - - diff --git a/docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md index 8c5a5f91dad..6c58417cf04 100644 --- a/docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md @@ -1,28 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: AlertGroupsPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## AlertGroupsPanelCfg #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|----------------|---------|----------|---------|-------------------------------------------------------------| +| -------------- | ------- | -------- | ------- | ----------------------------------------------------------- | | `alertmanager` | string | **Yes** | | Name of the alertmanager used as a source for alerts | | `expandAll` | boolean | **Yes** | | Expand all alert groups by default | | `labels` | string | **Yes** | | Comma-separated list of values used to filter alert results | - - diff --git a/docs/sources/developers/kinds/composable/annotationslist/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/annotationslist/panelcfg/schema-reference.md index 10bf7734054..55478b78853 100644 --- a/docs/sources/developers/kinds/composable/annotationslist/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/annotationslist/panelcfg/schema-reference.md @@ -1,26 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: AnnotationsListPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## AnnotationsListPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|-------------------------|----------|----------|---------|-------------| +| ----------------------- | -------- | -------- | ------- | ----------- | | `limit` | uint32 | **Yes** | `10` | | | `navigateAfter` | string | **Yes** | `10m` | | | `navigateBefore` | string | **Yes** | `10m` | | @@ -31,5 +35,3 @@ title: AnnotationsListPanelCfg kind | `showTime` | boolean | **Yes** | `true` | | | `showUser` | boolean | **Yes** | `true` | | | `tags` | string[] | **Yes** | | | - - diff --git a/docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md index 10bf7734054..55478b78853 100644 --- a/docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md @@ -1,26 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: AnnotationsListPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## AnnotationsListPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|-------------------------|----------|----------|---------|-------------| +| ----------------------- | -------- | -------- | ------- | ----------- | | `limit` | uint32 | **Yes** | `10` | | | `navigateAfter` | string | **Yes** | `10m` | | | `navigateBefore` | string | **Yes** | `10m` | | @@ -31,5 +35,3 @@ title: AnnotationsListPanelCfg kind | `showTime` | boolean | **Yes** | `true` | | | `showUser` | boolean | **Yes** | `true` | | | `tags` | string[] | **Yes** | | | - - diff --git a/docs/sources/developers/kinds/composable/azuremonitor/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/azuremonitor/dataquery/schema-reference.md index 5b73ca87685..2d5cec0219c 100644 --- a/docs/sources/developers/kinds/composable/azuremonitor/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/azuremonitor/dataquery/schema-reference.md @@ -1,19 +1,21 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: AzureMonitorDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## AzureMonitorDataQuery #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md b/docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md index 5b73ca87685..2d5cec0219c 100644 --- a/docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md @@ -1,19 +1,21 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: AzureMonitorDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## AzureMonitorDataQuery #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/composable/barchart/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/barchart/panelcfg/schema-reference.md index a9cb3deda85..55357323bbb 100644 --- a/docs/sources/developers/kinds/composable/barchart/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/barchart/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: BarChartPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## BarChartPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,20 +27,20 @@ title: BarChartPanelCfg kind It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | +| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | | `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.
Constraint: `>=0 & <=100`. | | `gradientMode` | string | No | | Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.
Gradient appearance is influenced by the Fill opacity setting. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `lineWidth` | integer | No | `1` | Controls line width of the bars.
Constraint: `>=0 & <=10`. | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | | `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | ### AxisConfig @@ -44,7 +48,7 @@ It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldcon TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -60,7 +64,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -70,7 +74,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. | ### HideSeriesConfig @@ -78,7 +82,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -88,7 +92,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### Options @@ -96,20 +100,20 @@ TODO docs It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------| +| --------------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `barWidth` | number | **Yes** | `0.97` | Controls the width of bars. 1 = Max width, 0 = Min width.
Constraint: `>=0 & <=1`. | | `fullHighlight` | boolean | **Yes** | `false` | Enables mode which highlights the entire bar area and shows tooltip when cursor
hovers over highlighted area | | `groupWidth` | number | **Yes** | `0.7` | Controls the width of groups. 1 = max with, 0 = min width.
Constraint: `>=0 & <=1`. | -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | | `orientation` | string | **Yes** | | Controls the orientation of the bar chart, either vertical or horizontal. | | `showValue` | string | **Yes** | | This controls whether values are shown on top or to the left of bars. | | `stacking` | string | **Yes** | | Controls whether bars are stacked or not, either normally or in percent mode. | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `xTickLabelMaxLength` | integer | **Yes** | | Sets the max length that a label can have before it is truncated.
Constraint: `>=0 & <=2147483647`. | | `xTickLabelRotation` | integer | **Yes** | `0` | Controls the rotation of the x axis labels.
Constraint: `>=-90 & <=90`. | | `barRadius` | number | No | `0` | Controls the radius of each bar.
Constraint: `>=0 & <=0.5`. | | `colorByField` | string | No | | Use the color value for a sibling field to color each bar value. | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | | `xField` | string | No | | Manually select which field from the dataset to represent the x field. | | `xTickLabelSpacing` | int32 | No | `0` | Controls the spacing between x axis labels.
negative values indicate backwards skipping behavior | @@ -118,7 +122,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -126,7 +130,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -142,7 +146,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -150,7 +154,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | @@ -159,7 +163,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -167,8 +171,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md index a9cb3deda85..55357323bbb 100644 --- a/docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: BarChartPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## BarChartPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,20 +27,20 @@ title: BarChartPanelCfg kind It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | +| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | | `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.
Constraint: `>=0 & <=100`. | | `gradientMode` | string | No | | Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.
Gradient appearance is influenced by the Fill opacity setting. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `lineWidth` | integer | No | `1` | Controls line width of the bars.
Constraint: `>=0 & <=10`. | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | | `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | ### AxisConfig @@ -44,7 +48,7 @@ It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldcon TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -60,7 +64,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -70,7 +74,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. | ### HideSeriesConfig @@ -78,7 +82,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -88,7 +92,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### Options @@ -96,20 +100,20 @@ TODO docs It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------| +| --------------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `barWidth` | number | **Yes** | `0.97` | Controls the width of bars. 1 = Max width, 0 = Min width.
Constraint: `>=0 & <=1`. | | `fullHighlight` | boolean | **Yes** | `false` | Enables mode which highlights the entire bar area and shows tooltip when cursor
hovers over highlighted area | | `groupWidth` | number | **Yes** | `0.7` | Controls the width of groups. 1 = max with, 0 = min width.
Constraint: `>=0 & <=1`. | -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | | `orientation` | string | **Yes** | | Controls the orientation of the bar chart, either vertical or horizontal. | | `showValue` | string | **Yes** | | This controls whether values are shown on top or to the left of bars. | | `stacking` | string | **Yes** | | Controls whether bars are stacked or not, either normally or in percent mode. | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `xTickLabelMaxLength` | integer | **Yes** | | Sets the max length that a label can have before it is truncated.
Constraint: `>=0 & <=2147483647`. | | `xTickLabelRotation` | integer | **Yes** | `0` | Controls the rotation of the x axis labels.
Constraint: `>=-90 & <=90`. | | `barRadius` | number | No | `0` | Controls the radius of each bar.
Constraint: `>=0 & <=0.5`. | | `colorByField` | string | No | | Use the color value for a sibling field to color each bar value. | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | | `xField` | string | No | | Manually select which field from the dataset to represent the x field. | | `xTickLabelSpacing` | int32 | No | `0` | Controls the spacing between x axis labels.
negative values indicate backwards skipping behavior | @@ -118,7 +122,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -126,7 +130,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -142,7 +146,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -150,7 +154,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | @@ -159,7 +163,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -167,8 +171,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/bargauge/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/bargauge/panelcfg/schema-reference.md index d9d93d2485d..5e887fd17df 100644 --- a/docs/sources/developers/kinds/composable/bargauge/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/bargauge/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: BarGaugePanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## BarGaugePanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options @@ -22,26 +26,26 @@ title: BarGaugePanelCfg kind It extends [SingleStatBaseOptions](#singlestatbaseoptions). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `displayMode` | string | **Yes** | | Enum expressing the possible display modes
for the bar gauge component of Grafana UI
Possible values are: `basic`, `lcd`, `gradient`. | | `minVizHeight` | uint32 | **Yes** | `10` | | | `minVizWidth` | uint32 | **Yes** | `0` | | | `showUnfilled` | boolean | **Yes** | `true` | | | `valueMode` | string | **Yes** | | Allows for the table cell gauge display type to set the gauge mode.
Possible values are: `color`, `text`, `hidden`. | -| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | -| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | +| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | +| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | ### ReduceDataOptions TODO docs -| Property | Type | Required | Default | Description | -|----------|----------|----------|---------|---------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | -| `fields` | string | No | | Which fields to show. By default this is only numeric fields | -| `limit` | number | No | | if showing all values limit | -| `values` | boolean | No | | If true show each row value | +| Property | Type | Required | Default | Description | +| -------- | -------- | -------- | ------- | ------------------------------------------------------------ | +| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | +| `fields` | string | No | | Which fields to show. By default this is only numeric fields | +| `limit` | number | No | | if showing all values limit | +| `values` | boolean | No | | If true show each row value | ### SingleStatBaseOptions @@ -50,17 +54,17 @@ TODO docs It extends [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | ### OptionsWithTextFormatting TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -68,8 +72,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | - - diff --git a/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md index d9d93d2485d..5e887fd17df 100644 --- a/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: BarGaugePanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## BarGaugePanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options @@ -22,26 +26,26 @@ title: BarGaugePanelCfg kind It extends [SingleStatBaseOptions](#singlestatbaseoptions). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `displayMode` | string | **Yes** | | Enum expressing the possible display modes
for the bar gauge component of Grafana UI
Possible values are: `basic`, `lcd`, `gradient`. | | `minVizHeight` | uint32 | **Yes** | `10` | | | `minVizWidth` | uint32 | **Yes** | `0` | | | `showUnfilled` | boolean | **Yes** | `true` | | | `valueMode` | string | **Yes** | | Allows for the table cell gauge display type to set the gauge mode.
Possible values are: `color`, `text`, `hidden`. | -| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | -| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | +| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | +| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | ### ReduceDataOptions TODO docs -| Property | Type | Required | Default | Description | -|----------|----------|----------|---------|---------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | -| `fields` | string | No | | Which fields to show. By default this is only numeric fields | -| `limit` | number | No | | if showing all values limit | -| `values` | boolean | No | | If true show each row value | +| Property | Type | Required | Default | Description | +| -------- | -------- | -------- | ------- | ------------------------------------------------------------ | +| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | +| `fields` | string | No | | Which fields to show. By default this is only numeric fields | +| `limit` | number | No | | if showing all values limit | +| `values` | boolean | No | | If true show each row value | ### SingleStatBaseOptions @@ -50,17 +54,17 @@ TODO docs It extends [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | ### OptionsWithTextFormatting TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -68,8 +72,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | - - diff --git a/docs/sources/developers/kinds/composable/candlestick/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/candlestick/panelcfg/schema-reference.md index 069acb2533d..c48afb54d87 100644 --- a/docs/sources/developers/kinds/composable/candlestick/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/candlestick/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: CandlestickPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## CandlestickPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------------------|---------------------------------------|----------|---------|-------------------------------------------------------------| +| --------------------- | ------------------------------------- | -------- | ------- | ----------------------------------------------------------- | | `CandleStyle` | string | **Yes** | | Possible values are: `candles`, `ohlcbars`. | | `CandlestickColors` | [object](#candlestickcolors) | **Yes** | | | | `CandlestickFieldMap` | [object](#candlestickfieldmap) | **Yes** | | | @@ -26,7 +30,7 @@ title: CandlestickPanelCfg kind ### CandlestickColors | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `down` | string | **Yes** | `red` | | | `flat` | string | **Yes** | `gray` | | | `up` | string | **Yes** | `green` | | @@ -34,7 +38,7 @@ title: CandlestickPanelCfg kind ### CandlestickFieldMap | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ---------------------------------------------------------------------------- | | `close` | string | No | | Corresponds to the final (end) value of the given period | | `high` | string | No | | Corresponds to the highest value of the given period | | `low` | string | No | | Corresponds to the lowest value of the given period | @@ -47,45 +51,45 @@ TODO docs It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig). -| Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*
TODO docs
Possible values are: `-1`, `0`, `1`. | -| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | -| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | -| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs | -| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | -| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*
TODO docs
Possible values are: `auto`, `never`, `always`. | -| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | -| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*
TODO docs | -| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | -| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | +| Property | Type | Required | Default | Description | +| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_
TODO docs
Possible values are: `-1`, `0`, `1`. | +| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | +| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | +| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs | +| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | +| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_
TODO docs
Possible values are: `auto`, `never`, `always`. | +| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_
TODO docs | +| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | +| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | ### AxisConfig TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -101,7 +105,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -111,7 +115,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------------|---------|----------|---------|----------------------------------------------------| +| ---------------- | ------- | -------- | ------- | -------------------------------------------------- | | `barAlignment` | integer | No | | TODO docs
Possible values are: `-1`, `0`, `1`. | | `barMaxWidth` | number | No | | | | `barWidthFactor` | number | No | | | @@ -121,7 +125,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|-------------| +| ------------- | ------ | -------- | ------- | ----------- | | `fillBelowTo` | string | No | | | | `fillColor` | string | No | | | | `fillOpacity` | number | No | | | @@ -131,7 +135,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. | ### HideSeriesConfig @@ -139,7 +143,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -149,27 +153,27 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### LineConfig TODO docs -| Property | Type | Required | Default | Description | -|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `lineColor` | string | No | | | -| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | -| `lineWidth` | number | No | | | -| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| Property | Type | Required | Default | Description | +| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `lineColor` | string | No | | | +| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | +| `lineWidth` | number | No | | | +| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | ### LineStyle TODO docs | Property | Type | Required | Default | Description | -|----------|----------|----------|---------|--------------------------------------------------------| +| -------- | -------- | -------- | ------- | ------------------------------------------------------ | | `dash` | number[] | No | | | | `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. | @@ -178,7 +182,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|---------------------------------------------------------------| +| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `pointColor` | string | No | | | | `pointSize` | number | No | | | | `pointSymbol` | string | No | | | @@ -189,7 +193,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|-----------------------------------|----------|---------|-------------| +| ---------- | --------------------------------- | -------- | ------- | ----------- | | `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs | ### StackingConfig @@ -197,7 +201,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------- | | `group` | string | No | | | | `mode` | string | No | | TODO docs
Possible values are: `none`, `normal`, `percent`. | @@ -206,12 +210,12 @@ TODO docs It extends [OptionsWithLegend](#optionswithlegend). | Property | Type | Required | Default | Description | -|--------------------|-----------------------------------------|----------|---------|--------------------------------------------------------------------------| +| ------------------ | --------------------------------------- | -------- | ------- | ------------------------------------------------------------------------ | | `candleStyle` | string | **Yes** | | Sets the style of the candlesticks | | `colorStrategy` | string | **Yes** | | Sets the color strategy for the candlesticks | | `colors` | [CandlestickColors](#candlestickcolors) | **Yes** | | | | `fields` | [object](#fields) | **Yes** | `map[]` | Map fields to appropriate dimension | -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | | `mode` | string | **Yes** | | Sets which dimensions are used for the visualization | | `includeAllFields` | boolean | No | `false` | When enabled, all fields will be sent to the graph | @@ -220,7 +224,7 @@ It extends [OptionsWithLegend](#optionswithlegend). TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -228,7 +232,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -244,7 +248,5 @@ TODO docs Map fields to appropriate dimension | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|-------------| +| -------- | --------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [](#), [](#). | | | - - diff --git a/docs/sources/developers/kinds/composable/candlestickpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/candlestickpanelcfg/schema-reference.md index 89ef8318712..f53b248b532 100644 --- a/docs/sources/developers/kinds/composable/candlestickpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/candlestickpanelcfg/schema-reference.md @@ -1,27 +1,33 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: CandlestickPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. # CandlestickPanelCfg kind ## Maturity: experimental + ## Version: 0.0 ## Properties -| Property | Type | Required | Description | -|-----------------------|--------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `CandleStyle` | string | **Yes** | TODO docs Possible values are: `candles`, `ohlcbars`. | -| `CandlestickColors` | [object](#candlestickcolors) | **Yes** | TODO docs | -| `CandlestickFieldMap` | [object](#candlestickfieldmap) | **Yes** | TODO docs | -| `ColorStrategy` | string | **Yes** | TODO docs
"open-close": up/down color depends on current close vs current open
filled always
"close-close": up/down color depends on current close vs prior close
filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. | -| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | -| `PanelOptions` | [object](#paneloptions) | **Yes** | | -| `VizDisplayMode` | string | **Yes** | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. | +| Property | Type | Required | Description | +| --------------------- | ------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `CandleStyle` | string | **Yes** | TODO docs Possible values are: `candles`, `ohlcbars`. | +| `CandlestickColors` | [object](#candlestickcolors) | **Yes** | TODO docs | +| `CandlestickFieldMap` | [object](#candlestickfieldmap) | **Yes** | TODO docs | +| `ColorStrategy` | string | **Yes** | TODO docs
"open-close": up/down color depends on current close vs current open
filled always
"close-close": up/down color depends on current close vs prior close
filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. | +| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | +| `PanelOptions` | [object](#paneloptions) | **Yes** | | +| `VizDisplayMode` | string | **Yes** | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. | ## CandlestickColors @@ -30,7 +36,7 @@ TODO docs ### Properties | Property | Type | Required | Description | -|----------|--------|----------|-------------------| +| -------- | ------ | -------- | ----------------- | | `down` | string | **Yes** | Default: `red`. | | `flat` | string | **Yes** | Default: `gray`. | | `up` | string | **Yes** | Default: `green`. | @@ -42,7 +48,7 @@ TODO docs ### Properties | Property | Type | Required | Description | -|----------|--------|----------|-------------| +| -------- | ------ | -------- | ----------- | | `close` | string | No | | | `high` | string | No | | | `low` | string | No | | @@ -52,20 +58,20 @@ TODO docs ## PanelFieldConfig | Property | Type | Required | Description | -|----------|------|----------|-------------| +| -------- | ---- | -------- | ----------- | ## PanelOptions ### Properties -| Property | Type | Required | Description | -|--------------------|-----------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `candleStyle` | string | No | TODO docs Possible values are: `candles`, `ohlcbars`. | -| `colorStrategy` | string | No | TODO docs
"open-close": up/down color depends on current close vs current open
filled always
"close-close": up/down color depends on current close vs prior close
filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. | -| `colors` | [CandlestickColors](#candlestickcolors) | No | TODO docs | -| `fields` | [object](#fields) | No | TODO docs Default: `map[]`. | -| `includeAllFields` | boolean | No | When enabled, all fields will be sent to the graph Default: `false`. | -| `mode` | string | No | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. | +| Property | Type | Required | Description | +| ------------------ | --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `candleStyle` | string | No | TODO docs Possible values are: `candles`, `ohlcbars`. | +| `colorStrategy` | string | No | TODO docs
"open-close": up/down color depends on current close vs current open
filled always
"close-close": up/down color depends on current close vs prior close
filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. | +| `colors` | [CandlestickColors](#candlestickcolors) | No | TODO docs | +| `fields` | [object](#fields) | No | TODO docs Default: `map[]`. | +| `includeAllFields` | boolean | No | When enabled, all fields will be sent to the graph Default: `false`. | +| `mode` | string | No | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. | ### CandlestickColors @@ -74,7 +80,7 @@ TODO docs #### Properties | Property | Type | Required | Description | -|----------|--------|----------|-------------------| +| -------- | ------ | -------- | ----------------- | | `down` | string | **Yes** | Default: `red`. | | `flat` | string | **Yes** | Default: `gray`. | | `up` | string | **Yes** | Default: `green`. | @@ -85,5 +91,3 @@ TODO docs The default value is: `map[]`. | Property | Type | Required | Description | |----------|------|----------|-------------| - - diff --git a/docs/sources/developers/kinds/composable/canvas/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/canvas/panelcfg/schema-reference.md index b1892046d6e..6760479d4c3 100644 --- a/docs/sources/developers/kinds/composable/canvas/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/canvas/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: CanvasPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## CanvasPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-------------------------|----------------------------------|----------|---------|-----------------------------------------------------------------------| +| ----------------------- | -------------------------------- | -------- | ------- | --------------------------------------------------------------------- | | `BackgroundConfig` | [object](#backgroundconfig) | **Yes** | | | | `BackgroundImageSize` | string | **Yes** | | Possible values are: `original`, `contain`, `cover`, `fill`, `tile`. | | `CanvasConnection` | [object](#canvasconnection) | **Yes** | | | @@ -31,7 +35,7 @@ title: CanvasPanelCfg kind ### BackgroundConfig | Property | Type | Required | Default | Description | -|----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------| +| -------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------- | | `color` | [ColorDimensionConfig](#colordimensionconfig) | No | | | | `image` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | Links to a resource (image/svg path) | | `size` | string | No | | Possible values are: `original`, `contain`, `cover`, `fill`, `tile`. | @@ -41,14 +45,14 @@ title: CanvasPanelCfg kind It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | string | No | | | ### BaseDimensionConfig | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------------------------------------| +| -------- | ------ | -------- | ------- | ----------------------------------------- | | `field` | string | No | | fixed: T -- will be added by each element | ### ResourceDimensionConfig @@ -58,15 +62,15 @@ Links to a resource (image/svg path) It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `mapping`. | -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | string | No | | | ### CanvasConnection | Property | Type | Required | Default | Description | -|--------------|-------------------------------------------------|----------|---------|----------------------------------| +| ------------ | ----------------------------------------------- | -------- | ------- | -------------------------------- | | `path` | string | **Yes** | | Possible values are: `straight`. | | `source` | [ConnectionCoordinates](#connectioncoordinates) | **Yes** | | | | `target` | [ConnectionCoordinates](#connectioncoordinates) | **Yes** | | | @@ -77,7 +81,7 @@ It extends [BaseDimensionConfig](#basedimensionconfig). ### ConnectionCoordinates | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `x` | number | **Yes** | | | | `y` | number | **Yes** | | | @@ -86,17 +90,17 @@ It extends [BaseDimensionConfig](#basedimensionconfig). It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `max` | number | **Yes** | | | | `min` | number | **Yes** | | | -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | number | No | | | | `mode` | string | No | | Possible values are: `linear`, `quad`. | ### CanvasElementOptions | Property | Type | Required | Default | Description | -|---------------|-----------------------------------------|----------|---------|---------------------------------------------------------| +| ------------- | --------------------------------------- | -------- | ------- | ------------------------------------------------------- | | `name` | string | **Yes** | | | | `type` | string | **Yes** | | | | `background` | [BackgroundConfig](#backgroundconfig) | No | | | @@ -109,21 +113,21 @@ It extends [BaseDimensionConfig](#basedimensionconfig). ### Constraint | Property | Type | Required | Default | Description | -|--------------|--------|----------|---------|-----------------------------------------------------------------------| +| ------------ | ------ | -------- | ------- | --------------------------------------------------------------------- | | `horizontal` | string | No | | Possible values are: `left`, `right`, `leftright`, `center`, `scale`. | | `vertical` | string | No | | Possible values are: `top`, `bottom`, `topbottom`, `center`, `scale`. | ### LineConfig | Property | Type | Required | Default | Description | -|----------|-----------------------------------------------|----------|---------|-------------| +| -------- | --------------------------------------------- | -------- | ------- | ----------- | | `color` | [ColorDimensionConfig](#colordimensionconfig) | No | | | | `width` | number | No | | | ### Placement | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `bottom` | number | No | | | | `height` | number | No | | | | `left` | number | No | | | @@ -134,7 +138,7 @@ It extends [BaseDimensionConfig](#basedimensionconfig). ### Options | Property | Type | Required | Default | Description | -|---------------------|-----------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | --------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `inlineEditing` | boolean | **Yes** | `true` | Enable inline editing | | `root` | [object](#root) | **Yes** | | The root element of canvas (frame), where all canvas elements are nested
TODO: Figure out how to define a default value for this | | `showAdvancedTypes` | boolean | **Yes** | `true` | Show all available element types | @@ -145,9 +149,7 @@ The root element of canvas (frame), where all canvas elements are nested TODO: Figure out how to define a default value for this | Property | Type | Required | Default | Description | -|------------|-------------------------------------------------|----------|---------|----------------------------------------------------------------| +| ---------- | ----------------------------------------------- | -------- | ------- | -------------------------------------------------------------- | | `elements` | [CanvasElementOptions](#canvaselementoptions)[] | **Yes** | | The list of canvas elements attached to the root element | | `name` | string | **Yes** | | Name of the root element | | `type` | string | **Yes** | | Type of root element (frame)
Possible values are: `frame`. | - - diff --git a/docs/sources/developers/kinds/composable/cloudwatch/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/cloudwatch/dataquery/schema-reference.md index 44926975453..5eb67103a15 100644 --- a/docs/sources/developers/kinds/composable/cloudwatch/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/cloudwatch/dataquery/schema-reference.md @@ -1,19 +1,21 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: CloudWatchDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## CloudWatchDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md b/docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md index 44926975453..5eb67103a15 100644 --- a/docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md @@ -1,19 +1,21 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: CloudWatchDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## CloudWatchDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/composable/dashboardlist/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/dashboardlist/panelcfg/schema-reference.md index 3155ad87d21..907ae829ea9 100644 --- a/docs/sources/developers/kinds/composable/dashboardlist/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/dashboardlist/panelcfg/schema-reference.md @@ -1,26 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: DashboardListPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## DashboardListPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|----------------------|----------|----------|---------|-------------| +| -------------------- | -------- | -------- | ------- | ----------- | | `includeVars` | boolean | **Yes** | `false` | | | `keepTime` | boolean | **Yes** | `false` | | | `maxItems` | integer | **Yes** | `10` | | @@ -31,5 +35,3 @@ title: DashboardListPanelCfg kind | `showStarred` | boolean | **Yes** | `true` | | | `tags` | string[] | **Yes** | | | | `folderId` | integer | No | | | - - diff --git a/docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md index 3155ad87d21..907ae829ea9 100644 --- a/docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md @@ -1,26 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: DashboardListPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## DashboardListPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|----------------------|----------|----------|---------|-------------| +| -------------------- | -------- | -------- | ------- | ----------- | | `includeVars` | boolean | **Yes** | `false` | | | `keepTime` | boolean | **Yes** | `false` | | | `maxItems` | integer | **Yes** | `10` | | @@ -31,5 +35,3 @@ title: DashboardListPanelCfg kind | `showStarred` | boolean | **Yes** | `true` | | | `tags` | string[] | **Yes** | | | | `folderId` | integer | No | | | - - diff --git a/docs/sources/developers/kinds/composable/datagrid/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/datagrid/panelcfg/schema-reference.md index 48da483509e..ccb9d3bea60 100644 --- a/docs/sources/developers/kinds/composable/datagrid/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/datagrid/panelcfg/schema-reference.md @@ -1,26 +1,28 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: DatagridPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## DatagridPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|------------------|---------|----------|---------|-----------------------------------| +| ---------------- | ------- | -------- | ------- | --------------------------------- | | `selectedSeries` | integer | **Yes** | `0` | Constraint: `>=0 & <=2147483647`. | - - diff --git a/docs/sources/developers/kinds/composable/datagridpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/datagridpanelcfg/schema-reference.md index 48da483509e..ccb9d3bea60 100644 --- a/docs/sources/developers/kinds/composable/datagridpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/datagridpanelcfg/schema-reference.md @@ -1,26 +1,28 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: DatagridPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## DatagridPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|------------------|---------|----------|---------|-----------------------------------| +| ---------------- | ------- | -------- | ------- | --------------------------------- | | `selectedSeries` | integer | **Yes** | `0` | Constraint: `>=0 & <=2147483647`. | - - diff --git a/docs/sources/developers/kinds/composable/debug/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/debug/panelcfg/schema-reference.md index 1603e4812e9..7ac6021a6a0 100644 --- a/docs/sources/developers/kinds/composable/debug/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/debug/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: DebugPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## DebugPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------------|-------------------------|----------|---------|---------------------------------------------------------------------------| +| -------------- | ----------------------- | -------- | ------- | ------------------------------------------------------------------------- | | `DebugMode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. | | `Options` | [object](#options) | **Yes** | | | | `UpdateConfig` | [object](#updateconfig) | **Yes** | | | @@ -22,16 +26,14 @@ title: DebugPanelCfg kind ### Options | Property | Type | Required | Default | Description | -|------------|-------------------------------|----------|---------|---------------------------------------------------------------------------| +| ---------- | ----------------------------- | -------- | ------- | ------------------------------------------------------------------------- | | `mode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. | | `counters` | [UpdateConfig](#updateconfig) | No | | | ### UpdateConfig | Property | Type | Required | Default | Description | -|-----------------|---------|----------|---------|-------------| +| --------------- | ------- | -------- | ------- | ----------- | | `dataChanged` | boolean | **Yes** | | | | `render` | boolean | **Yes** | | | | `schemaChanged` | boolean | **Yes** | | | - - diff --git a/docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md index 1603e4812e9..7ac6021a6a0 100644 --- a/docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: DebugPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## DebugPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------------|-------------------------|----------|---------|---------------------------------------------------------------------------| +| -------------- | ----------------------- | -------- | ------- | ------------------------------------------------------------------------- | | `DebugMode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. | | `Options` | [object](#options) | **Yes** | | | | `UpdateConfig` | [object](#updateconfig) | **Yes** | | | @@ -22,16 +26,14 @@ title: DebugPanelCfg kind ### Options | Property | Type | Required | Default | Description | -|------------|-------------------------------|----------|---------|---------------------------------------------------------------------------| +| ---------- | ----------------------------- | -------- | ------- | ------------------------------------------------------------------------- | | `mode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. | | `counters` | [UpdateConfig](#updateconfig) | No | | | ### UpdateConfig | Property | Type | Required | Default | Description | -|-----------------|---------|----------|---------|-------------| +| --------------- | ------- | -------- | ------- | ----------- | | `dataChanged` | boolean | **Yes** | | | | `render` | boolean | **Yes** | | | | `schemaChanged` | boolean | **Yes** | | | - - diff --git a/docs/sources/developers/kinds/composable/elasticsearch/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/elasticsearch/dataquery/schema-reference.md index f5d8981ec9e..c3a2afcae1e 100644 --- a/docs/sources/developers/kinds/composable/elasticsearch/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/elasticsearch/dataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: ElasticsearchDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## ElasticsearchDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|--------------|-------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------ | ----------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `alias` | string | No | | Alias pattern | | `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | | List of bucket aggregations | @@ -28,7 +32,7 @@ title: ElasticsearchDataQuery kind ### BucketAggregation | Property | Type | Required | Default | Description | -|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | | ### DateHistogram @@ -36,27 +40,27 @@ title: ElasticsearchDataQuery kind It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### BucketAggregationWithField It extends [BaseBucketAggregation](#basebucketaggregation). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `field` | string | No | | | -| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | +| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ | ### BaseBucketAggregation | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|---------------------------------------------------------------------------------------------------| +| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- | | `id` | string | **Yes** | | | | `type` | string | **Yes** | | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `settings` | | No | | | @@ -66,59 +70,59 @@ It extends [BaseBucketAggregation](#basebucketaggregation). It extends [BaseBucketAggregation](#basebucketaggregation). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | +| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ | ### GeoHashGrid It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### Histogram It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### Nested It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### Terms It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### MetricAggregation | Property | Type | Required | Default | Description | -|----------|------------------------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | ---------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | | ### Count @@ -126,15 +130,15 @@ It extends [BucketAggregationWithField](#bucketaggregationwithfield). It extends [BaseMetricAggregation](#basemetricaggregation). | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | +| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | ### BaseMetricAggregation | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| -------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | **Yes** | | | | `type` | string | **Yes** | | Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | | `hide` | boolean | No | | | @@ -142,7 +146,7 @@ It extends [BaseMetricAggregation](#basemetricaggregation). ### PipelineMetricAggregation | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | | ### BucketScript @@ -150,11 +154,11 @@ It extends [BaseMetricAggregation](#basemetricaggregation). It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `hide` | boolean | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* | -| `id` | string | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* | -| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* | +| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `hide` | boolean | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ | +| `id` | string | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ | +| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ | | `settings` | [object](#settings) | No | | | ### PipelineMetricAggregationWithMultipleBucketPaths @@ -162,23 +166,23 @@ It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricagg It extends [BaseMetricAggregation](#basemetricaggregation). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | +| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | | `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | | ### PipelineVariable | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|-------------| +| ------------- | ------ | -------- | ------- | ----------- | | `name` | string | **Yes** | | | | `pipelineAgg` | string | **Yes** | | | ### Settings | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | | `script` | | No | | | ### CumulativeSum @@ -186,12 +190,12 @@ It extends [BaseMetricAggregation](#basemetricaggregation). It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). | Property | Type | Required | Default | Description | -|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | +| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | | `settings` | [object](#settings) | No | | | ### BasePipelineMetricAggregation @@ -199,11 +203,11 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). It extends [MetricAggregationWithField](#metricaggregationwithfield). | Property | Type | Required | Default | Description | -|---------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `field` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* | -| `hide` | boolean | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* | +| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | string | **Yes** | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `field` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ | +| `hide` | boolean | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ | | `pipelineAgg` | string | No | | | ### MetricAggregationWithField @@ -211,16 +215,16 @@ It extends [MetricAggregationWithField](#metricaggregationwithfield). It extends [BaseMetricAggregation](#basemetricaggregation). | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | | `field` | string | No | | | -| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | +| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | ### Settings | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `format` | string | No | | | ### Derivative @@ -228,18 +232,18 @@ It extends [BaseMetricAggregation](#basemetricaggregation). It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). | Property | Type | Required | Default | Description | -|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | +| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | | `settings` | [object](#settings) | No | | | ### Settings | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `unit` | string | No | | | ### MovingAverage @@ -249,30 +253,28 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). | Property | Type | Required | Default | Description | -|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | +| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | | `settings` | [object](#settings) | No | | | ### Settings | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Meta | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Settings | Property | Type | Required | Default | Description | -|-----------|----------|----------|---------|-------------| +| --------- | -------- | -------- | ------- | ----------- | | `metrics` | string[] | No | | | | `orderBy` | string | No | | | | `order` | string | No | | | - - diff --git a/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md b/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md index f5d8981ec9e..c3a2afcae1e 100644 --- a/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: ElasticsearchDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## ElasticsearchDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|--------------|-------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------ | ----------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `alias` | string | No | | Alias pattern | | `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | | List of bucket aggregations | @@ -28,7 +32,7 @@ title: ElasticsearchDataQuery kind ### BucketAggregation | Property | Type | Required | Default | Description | -|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | | ### DateHistogram @@ -36,27 +40,27 @@ title: ElasticsearchDataQuery kind It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### BucketAggregationWithField It extends [BaseBucketAggregation](#basebucketaggregation). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `field` | string | No | | | -| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | +| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ | ### BaseBucketAggregation | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|---------------------------------------------------------------------------------------------------| +| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- | | `id` | string | **Yes** | | | | `type` | string | **Yes** | | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `settings` | | No | | | @@ -66,59 +70,59 @@ It extends [BaseBucketAggregation](#basebucketaggregation). It extends [BaseBucketAggregation](#basebucketaggregation). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | +| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ | ### GeoHashGrid It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### Histogram It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### Nested It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### Terms It extends [BucketAggregationWithField](#bucketaggregationwithfield). | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | -| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | -| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | +| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | +| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | +| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ | ### MetricAggregation | Property | Type | Required | Default | Description | -|----------|------------------------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | ---------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | | ### Count @@ -126,15 +130,15 @@ It extends [BucketAggregationWithField](#bucketaggregationwithfield). It extends [BaseMetricAggregation](#basemetricaggregation). | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | +| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | ### BaseMetricAggregation | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| -------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | **Yes** | | | | `type` | string | **Yes** | | Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | | `hide` | boolean | No | | | @@ -142,7 +146,7 @@ It extends [BaseMetricAggregation](#basemetricaggregation). ### PipelineMetricAggregation | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | | ### BucketScript @@ -150,11 +154,11 @@ It extends [BaseMetricAggregation](#basemetricaggregation). It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `hide` | boolean | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* | -| `id` | string | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* | -| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* | +| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | string | **Yes** | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `hide` | boolean | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ | +| `id` | string | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ | +| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ | | `settings` | [object](#settings) | No | | | ### PipelineMetricAggregationWithMultipleBucketPaths @@ -162,23 +166,23 @@ It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricagg It extends [BaseMetricAggregation](#basemetricaggregation). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | +| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | | `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | | ### PipelineVariable | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|-------------| +| ------------- | ------ | -------- | ------- | ----------- | | `name` | string | **Yes** | | | | `pipelineAgg` | string | **Yes** | | | ### Settings | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | | `script` | | No | | | ### CumulativeSum @@ -186,12 +190,12 @@ It extends [BaseMetricAggregation](#basemetricaggregation). It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). | Property | Type | Required | Default | Description | -|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | +| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | | `settings` | [object](#settings) | No | | | ### BasePipelineMetricAggregation @@ -199,11 +203,11 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). It extends [MetricAggregationWithField](#metricaggregationwithfield). | Property | Type | Required | Default | Description | -|---------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `field` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* | -| `hide` | boolean | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* | -| `id` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* | +| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | string | **Yes** | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `field` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ | +| `hide` | boolean | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ | +| `id` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ | | `pipelineAgg` | string | No | | | ### MetricAggregationWithField @@ -211,16 +215,16 @@ It extends [MetricAggregationWithField](#metricaggregationwithfield). It extends [BaseMetricAggregation](#basemetricaggregation). | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | -| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | +| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | | `field` | string | No | | | -| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | +| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ | ### Settings | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `format` | string | No | | | ### Derivative @@ -228,18 +232,18 @@ It extends [BaseMetricAggregation](#basemetricaggregation). It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). | Property | Type | Required | Default | Description | -|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | +| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | | `settings` | [object](#settings) | No | | | ### Settings | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `unit` | string | No | | | ### MovingAverage @@ -249,30 +253,28 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). | Property | Type | Required | Default | Description | -|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | -| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | -| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | +| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. | +| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | +| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ | | `settings` | [object](#settings) | No | | | ### Settings | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Meta | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Settings | Property | Type | Required | Default | Description | -|-----------|----------|----------|---------|-------------| +| --------- | -------- | -------- | ------- | ----------- | | `metrics` | string[] | No | | | | `orderBy` | string | No | | | | `order` | string | No | | | - - diff --git a/docs/sources/developers/kinds/composable/gauge/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/gauge/panelcfg/schema-reference.md index ceb32f80f72..2dfaf78cc4d 100644 --- a/docs/sources/developers/kinds/composable/gauge/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/gauge/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: GaugePanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## GaugePanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options @@ -22,23 +26,23 @@ title: GaugePanelCfg kind It extends [SingleStatBaseOptions](#singlestatbaseoptions). | Property | Type | Required | Default | Description | -|------------------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `showThresholdLabels` | boolean | **Yes** | `false` | | | `showThresholdMarkers` | boolean | **Yes** | `true` | | -| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | -| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | +| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | +| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | ### ReduceDataOptions TODO docs -| Property | Type | Required | Default | Description | -|----------|----------|----------|---------|---------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | -| `fields` | string | No | | Which fields to show. By default this is only numeric fields | -| `limit` | number | No | | if showing all values limit | -| `values` | boolean | No | | If true show each row value | +| Property | Type | Required | Default | Description | +| -------- | -------- | -------- | ------- | ------------------------------------------------------------ | +| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | +| `fields` | string | No | | Which fields to show. By default this is only numeric fields | +| `limit` | number | No | | if showing all values limit | +| `values` | boolean | No | | If true show each row value | ### SingleStatBaseOptions @@ -47,17 +51,17 @@ TODO docs It extends [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | ### OptionsWithTextFormatting TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -65,8 +69,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | - - diff --git a/docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md index ceb32f80f72..2dfaf78cc4d 100644 --- a/docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: GaugePanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## GaugePanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options @@ -22,23 +26,23 @@ title: GaugePanelCfg kind It extends [SingleStatBaseOptions](#singlestatbaseoptions). | Property | Type | Required | Default | Description | -|------------------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `showThresholdLabels` | boolean | **Yes** | `false` | | | `showThresholdMarkers` | boolean | **Yes** | `true` | | -| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | -| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | +| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | +| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | ### ReduceDataOptions TODO docs -| Property | Type | Required | Default | Description | -|----------|----------|----------|---------|---------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | -| `fields` | string | No | | Which fields to show. By default this is only numeric fields | -| `limit` | number | No | | if showing all values limit | -| `values` | boolean | No | | If true show each row value | +| Property | Type | Required | Default | Description | +| -------- | -------- | -------- | ------- | ------------------------------------------------------------ | +| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | +| `fields` | string | No | | Which fields to show. By default this is only numeric fields | +| `limit` | number | No | | if showing all values limit | +| `values` | boolean | No | | If true show each row value | ### SingleStatBaseOptions @@ -47,17 +51,17 @@ TODO docs It extends [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | ### OptionsWithTextFormatting TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -65,8 +69,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | - - diff --git a/docs/sources/developers/kinds/composable/geomap/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/geomap/panelcfg/schema-reference.md index 55b57ec9a4e..65a20064543 100644 --- a/docs/sources/developers/kinds/composable/geomap/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/geomap/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: GeomapPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## GeomapPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-------------------|----------------------------|----------|---------|-----------------------------------------------| +| ----------------- | -------------------------- | -------- | ------- | --------------------------------------------- | | `ControlsOptions` | [object](#controlsoptions) | **Yes** | | | | `MapCenterID` | string | **Yes** | | Possible values are: `zero`, `coords`, `fit`. | | `MapViewConfig` | [object](#mapviewconfig) | **Yes** | | | @@ -25,7 +29,7 @@ title: GeomapPanelCfg kind ### ControlsOptions | Property | Type | Required | Default | Description | -|-------------------|---------|----------|---------|--------------------------| +| ----------------- | ------- | -------- | ------- | ------------------------ | | `mouseWheelZoom` | boolean | No | | let the mouse wheel zoom | | `showAttribution` | boolean | No | | Lower right | | `showDebug` | boolean | No | | Show debug | @@ -36,7 +40,7 @@ title: GeomapPanelCfg kind ### MapViewConfig | Property | Type | Required | Default | Description | -|-------------|---------|----------|---------|-------------| +| ----------- | ------- | -------- | ------- | ----------- | | `id` | string | **Yes** | `zero` | | | `allLayers` | boolean | No | `true` | | | `lastOnly` | boolean | No | | | @@ -52,7 +56,7 @@ title: GeomapPanelCfg kind ### Options | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `basemap` | [MapLayerOptions](#maplayeroptions) | **Yes** | | | | `controls` | [ControlsOptions](#controlsoptions) | **Yes** | | | | `layers` | [MapLayerOptions](#maplayeroptions)[] | **Yes** | | | @@ -62,7 +66,7 @@ title: GeomapPanelCfg kind ### MapLayerOptions | Property | Type | Required | Default | Description | -|--------------|---------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------| +| ------------ | ------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | | `name` | string | **Yes** | | configured unique display name | | `type` | string | **Yes** | | | | `config` | | No | | Custom options depending on the type | @@ -74,7 +78,7 @@ title: GeomapPanelCfg kind ### FrameGeometrySource | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|-------------------------------------------------------------| +| ----------- | ------ | -------- | ------- | ----------------------------------------------------------- | | `mode` | string | **Yes** | | Possible values are: `auto`, `geohash`, `coords`, `lookup`. | | `gazetteer` | string | No | | Path to Gazetteer | | `geohash` | string | No | | Field mappings | @@ -86,7 +90,5 @@ title: GeomapPanelCfg kind ### TooltipOptions | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------- | | `mode` | string | **Yes** | | Possible values are: `none`, `details`. | - - diff --git a/docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md index 55b57ec9a4e..65a20064543 100644 --- a/docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: GeomapPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## GeomapPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-------------------|----------------------------|----------|---------|-----------------------------------------------| +| ----------------- | -------------------------- | -------- | ------- | --------------------------------------------- | | `ControlsOptions` | [object](#controlsoptions) | **Yes** | | | | `MapCenterID` | string | **Yes** | | Possible values are: `zero`, `coords`, `fit`. | | `MapViewConfig` | [object](#mapviewconfig) | **Yes** | | | @@ -25,7 +29,7 @@ title: GeomapPanelCfg kind ### ControlsOptions | Property | Type | Required | Default | Description | -|-------------------|---------|----------|---------|--------------------------| +| ----------------- | ------- | -------- | ------- | ------------------------ | | `mouseWheelZoom` | boolean | No | | let the mouse wheel zoom | | `showAttribution` | boolean | No | | Lower right | | `showDebug` | boolean | No | | Show debug | @@ -36,7 +40,7 @@ title: GeomapPanelCfg kind ### MapViewConfig | Property | Type | Required | Default | Description | -|-------------|---------|----------|---------|-------------| +| ----------- | ------- | -------- | ------- | ----------- | | `id` | string | **Yes** | `zero` | | | `allLayers` | boolean | No | `true` | | | `lastOnly` | boolean | No | | | @@ -52,7 +56,7 @@ title: GeomapPanelCfg kind ### Options | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `basemap` | [MapLayerOptions](#maplayeroptions) | **Yes** | | | | `controls` | [ControlsOptions](#controlsoptions) | **Yes** | | | | `layers` | [MapLayerOptions](#maplayeroptions)[] | **Yes** | | | @@ -62,7 +66,7 @@ title: GeomapPanelCfg kind ### MapLayerOptions | Property | Type | Required | Default | Description | -|--------------|---------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------| +| ------------ | ------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | | `name` | string | **Yes** | | configured unique display name | | `type` | string | **Yes** | | | | `config` | | No | | Custom options depending on the type | @@ -74,7 +78,7 @@ title: GeomapPanelCfg kind ### FrameGeometrySource | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|-------------------------------------------------------------| +| ----------- | ------ | -------- | ------- | ----------------------------------------------------------- | | `mode` | string | **Yes** | | Possible values are: `auto`, `geohash`, `coords`, `lookup`. | | `gazetteer` | string | No | | Path to Gazetteer | | `geohash` | string | No | | Field mappings | @@ -86,7 +90,5 @@ title: GeomapPanelCfg kind ### TooltipOptions | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------- | | `mode` | string | **Yes** | | Possible values are: `none`, `details`. | - - diff --git a/docs/sources/developers/kinds/composable/googlecloudmonitoring/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/googlecloudmonitoring/dataquery/schema-reference.md index 9d5679e942c..1091925f80f 100644 --- a/docs/sources/developers/kinds/composable/googlecloudmonitoring/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/googlecloudmonitoring/dataquery/schema-reference.md @@ -1,19 +1,21 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: GoogleCloudMonitoringDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## GoogleCloudMonitoringDataQuery #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/composable/googlecloudmonitoringdataquery/schema-reference.md b/docs/sources/developers/kinds/composable/googlecloudmonitoringdataquery/schema-reference.md index 9d5679e942c..1091925f80f 100644 --- a/docs/sources/developers/kinds/composable/googlecloudmonitoringdataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/googlecloudmonitoringdataquery/schema-reference.md @@ -1,19 +1,21 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: GoogleCloudMonitoringDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## GoogleCloudMonitoringDataQuery #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/composable/grafanapyroscope/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/grafanapyroscope/dataquery/schema-reference.md index 2bf55fcfb8b..0a6adde805e 100644 --- a/docs/sources/developers/kinds/composable/grafanapyroscope/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/grafanapyroscope/dataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: GrafanaPyroscopeDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## GrafanaPyroscopeDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------------|----------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `groupBy` | string[] | **Yes** | | Allows to group the results. | | `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. | | `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. | @@ -23,5 +27,3 @@ title: GrafanaPyroscopeDataQuery kind | `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) | | `maxNodes` | integer | No | | Sets the maximum number of nodes in the flamegraph. | | `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default | - - diff --git a/docs/sources/developers/kinds/composable/grafanapyroscopedataquery/schema-reference.md b/docs/sources/developers/kinds/composable/grafanapyroscopedataquery/schema-reference.md index 2bf55fcfb8b..0a6adde805e 100644 --- a/docs/sources/developers/kinds/composable/grafanapyroscopedataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/grafanapyroscopedataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: GrafanaPyroscopeDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## GrafanaPyroscopeDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------------|----------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `groupBy` | string[] | **Yes** | | Allows to group the results. | | `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. | | `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. | @@ -23,5 +27,3 @@ title: GrafanaPyroscopeDataQuery kind | `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) | | `maxNodes` | integer | No | | Sets the maximum number of nodes in the flamegraph. | | `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default | - - diff --git a/docs/sources/developers/kinds/composable/heatmap/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/heatmap/panelcfg/schema-reference.md index 7d4efc3081f..488809dc20b 100644 --- a/docs/sources/developers/kinds/composable/heatmap/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/heatmap/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: HeatmapPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## HeatmapPanelCfg #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------------------|--------------------------------|----------|---------|-------------------------------------------------------------------------------------------| +| --------------------- | ------------------------------ | -------- | ------- | ----------------------------------------------------------------------------------------- | | `CellValues` | [object](#cellvalues) | **Yes** | | Controls cell value options | | `ExemplarConfig` | [object](#exemplarconfig) | **Yes** | | Controls exemplar options | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | @@ -33,7 +37,7 @@ title: HeatmapPanelCfg kind Controls cell value options | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|-------------------------------------------------| +| ---------- | ------ | -------- | ------- | ----------------------------------------------- | | `decimals` | number | No | | Controls the number of decimals for cell values | | `unit` | string | No | | Controls the cell value unit | @@ -42,7 +46,7 @@ Controls cell value options Controls exemplar options | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|----------------------------------------| +| -------- | ------ | -------- | ------- | -------------------------------------- | | `color` | string | **Yes** | | Sets the color of the exemplar markers | ### FieldConfig @@ -50,8 +54,8 @@ Controls exemplar options It extends [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------| -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| ------------------- | --------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs | ### HideSeriesConfig @@ -59,7 +63,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig). TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -69,7 +73,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### ScaleDistributionConfig @@ -77,7 +81,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -87,7 +91,7 @@ TODO docs Controls the value filter range | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `ge` | number | No | | Sets the filter range to values greater than or equal to the given value | | `le` | number | No | | Sets the filter range to values less than or equal to the given value | @@ -96,7 +100,7 @@ Controls the value filter range Controls various color options | Property | Type | Required | Default | Description | -|------------|---------|----------|---------|-------------------------------------------------------------------------------------------| +| ---------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------- | | `exponent` | number | **Yes** | | Controls the exponent when scale is set to exponential | | `fill` | string | **Yes** | | Controls the color fill when in opacity mode | | `reverse` | boolean | **Yes** | | Reverses the color scheme | @@ -112,7 +116,7 @@ Controls various color options Controls legend options | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|---------------------------------| +| -------- | ------- | -------- | ------- | ------------------------------- | | `show` | boolean | **Yes** | | Controls if the legend is shown | ### HeatmapTooltip @@ -120,39 +124,39 @@ Controls legend options Controls tooltip options | Property | Type | Required | Default | Description | -|--------------|---------|----------|---------|----------------------------------------------------------------| +| ------------ | ------- | -------- | ------- | -------------------------------------------------------------- | | `show` | boolean | **Yes** | | Controls if the tooltip is shown | | `yHistogram` | boolean | No | | Controls if the tooltip shows a histogram of the y-axis values | ### Options -| Property | Type | Required | Default | Description | -|----------------|---------------------------------------------------------|----------|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options | -| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options | -| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options | -| `showValue` | string | **Yes** | | | *{
layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed
}
Controls the display of the value in the cell | -| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options | -| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis | -| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data | -| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | | -| `cellGap` | integer | No | `1` | Controls gap between cells
Constraint: `>=0 & <=25`. | -| `cellRadius` | number | No | | Controls cell radius | -| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit | -| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range | -| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options | +| Property | Type | Required | Default | Description | +| -------------- | ------------------------------------------------------- | -------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options | +| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options | +| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options | +| `showValue` | string | **Yes** | | | \*{
layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed
}
Controls the display of the value in the cell | +| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options | +| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis | +| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data | +| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | | +| `cellGap` | integer | No | `1` | Controls gap between cells
Constraint: `>=0 & <=25`. | +| `cellRadius` | number | No | | Controls cell radius | +| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit | +| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range | +| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options | ### HeatmapCalculationOptions | Property | Type | Required | Default | Description | -|------------|-------------------------------------------------------------------|----------|---------|-------------| +| ---------- | ----------------------------------------------------------------- | -------- | ------- | ----------- | | `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | | | `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | | ### HeatmapCalculationBucketConfig | Property | Type | Required | Default | Description | -|----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------| +| -------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------- | | `mode` | string | No | | Possible values are: `size`, `count`. | | `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs | | `value` | string | No | | The number of buckets to use for the axis in the heatmap | @@ -162,7 +166,7 @@ Controls tooltip options Controls frame rows options | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|----------------------------------------------------------| +| -------- | ------ | -------- | ------- | -------------------------------------------------------- | | `layout` | string | No | | Possible values are: `le`, `ge`, `unknown`, `auto`. | | `value` | string | No | | Sets the name of the cell when not calculating from data | @@ -173,20 +177,20 @@ Configuration options for the yAxis It extends [AxisConfig](#axisconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | +| ------------------- | --------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | | `decimals` | number | No | | Controls the number of decimals for yAxis values | | `max` | number | No | | Sets the maximum value for the yAxis | | `min` | number | No | | Sets the minimum value for the yAxis | | `reverse` | boolean | No | | Reverses the yAxis | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | | `unit` | string | No | | Sets the yAxis unit | ### AxisConfig @@ -194,7 +198,7 @@ It extends [AxisConfig](#axisconfig). TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -210,7 +214,7 @@ TODO docs Controls cell value unit | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|-------------| +| -------- | --------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [](#), [](#). | | | ### Color @@ -218,7 +222,7 @@ Controls cell value unit Controls the color options | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|-------------| +| -------- | --------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [](#), [](#). | | | ### FilterValues @@ -226,7 +230,5 @@ Controls the color options Filters values between a given range | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|-------------| +| -------- | --------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [](#), [](#). | | | - - diff --git a/docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md index 7d4efc3081f..488809dc20b 100644 --- a/docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: HeatmapPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## HeatmapPanelCfg #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------------------|--------------------------------|----------|---------|-------------------------------------------------------------------------------------------| +| --------------------- | ------------------------------ | -------- | ------- | ----------------------------------------------------------------------------------------- | | `CellValues` | [object](#cellvalues) | **Yes** | | Controls cell value options | | `ExemplarConfig` | [object](#exemplarconfig) | **Yes** | | Controls exemplar options | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | @@ -33,7 +37,7 @@ title: HeatmapPanelCfg kind Controls cell value options | Property | Type | Required | Default | Description | -|------------|--------|----------|---------|-------------------------------------------------| +| ---------- | ------ | -------- | ------- | ----------------------------------------------- | | `decimals` | number | No | | Controls the number of decimals for cell values | | `unit` | string | No | | Controls the cell value unit | @@ -42,7 +46,7 @@ Controls cell value options Controls exemplar options | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|----------------------------------------| +| -------- | ------ | -------- | ------- | -------------------------------------- | | `color` | string | **Yes** | | Sets the color of the exemplar markers | ### FieldConfig @@ -50,8 +54,8 @@ Controls exemplar options It extends [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------| -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| ------------------- | --------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs | ### HideSeriesConfig @@ -59,7 +63,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig). TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -69,7 +73,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### ScaleDistributionConfig @@ -77,7 +81,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -87,7 +91,7 @@ TODO docs Controls the value filter range | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `ge` | number | No | | Sets the filter range to values greater than or equal to the given value | | `le` | number | No | | Sets the filter range to values less than or equal to the given value | @@ -96,7 +100,7 @@ Controls the value filter range Controls various color options | Property | Type | Required | Default | Description | -|------------|---------|----------|---------|-------------------------------------------------------------------------------------------| +| ---------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------- | | `exponent` | number | **Yes** | | Controls the exponent when scale is set to exponential | | `fill` | string | **Yes** | | Controls the color fill when in opacity mode | | `reverse` | boolean | **Yes** | | Reverses the color scheme | @@ -112,7 +116,7 @@ Controls various color options Controls legend options | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|---------------------------------| +| -------- | ------- | -------- | ------- | ------------------------------- | | `show` | boolean | **Yes** | | Controls if the legend is shown | ### HeatmapTooltip @@ -120,39 +124,39 @@ Controls legend options Controls tooltip options | Property | Type | Required | Default | Description | -|--------------|---------|----------|---------|----------------------------------------------------------------| +| ------------ | ------- | -------- | ------- | -------------------------------------------------------------- | | `show` | boolean | **Yes** | | Controls if the tooltip is shown | | `yHistogram` | boolean | No | | Controls if the tooltip shows a histogram of the y-axis values | ### Options -| Property | Type | Required | Default | Description | -|----------------|---------------------------------------------------------|----------|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options | -| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options | -| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options | -| `showValue` | string | **Yes** | | | *{
layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed
}
Controls the display of the value in the cell | -| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options | -| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis | -| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data | -| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | | -| `cellGap` | integer | No | `1` | Controls gap between cells
Constraint: `>=0 & <=25`. | -| `cellRadius` | number | No | | Controls cell radius | -| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit | -| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range | -| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options | +| Property | Type | Required | Default | Description | +| -------------- | ------------------------------------------------------- | -------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options | +| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options | +| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options | +| `showValue` | string | **Yes** | | | \*{
layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed
}
Controls the display of the value in the cell | +| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options | +| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis | +| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data | +| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | | +| `cellGap` | integer | No | `1` | Controls gap between cells
Constraint: `>=0 & <=25`. | +| `cellRadius` | number | No | | Controls cell radius | +| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit | +| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range | +| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options | ### HeatmapCalculationOptions | Property | Type | Required | Default | Description | -|------------|-------------------------------------------------------------------|----------|---------|-------------| +| ---------- | ----------------------------------------------------------------- | -------- | ------- | ----------- | | `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | | | `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | | ### HeatmapCalculationBucketConfig | Property | Type | Required | Default | Description | -|----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------| +| -------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------- | | `mode` | string | No | | Possible values are: `size`, `count`. | | `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs | | `value` | string | No | | The number of buckets to use for the axis in the heatmap | @@ -162,7 +166,7 @@ Controls tooltip options Controls frame rows options | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|----------------------------------------------------------| +| -------- | ------ | -------- | ------- | -------------------------------------------------------- | | `layout` | string | No | | Possible values are: `le`, `ge`, `unknown`, `auto`. | | `value` | string | No | | Sets the name of the cell when not calculating from data | @@ -173,20 +177,20 @@ Configuration options for the yAxis It extends [AxisConfig](#axisconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | +| ------------------- | --------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | | `decimals` | number | No | | Controls the number of decimals for yAxis values | | `max` | number | No | | Sets the maximum value for the yAxis | | `min` | number | No | | Sets the minimum value for the yAxis | | `reverse` | boolean | No | | Reverses the yAxis | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | | `unit` | string | No | | Sets the yAxis unit | ### AxisConfig @@ -194,7 +198,7 @@ It extends [AxisConfig](#axisconfig). TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -210,7 +214,7 @@ TODO docs Controls cell value unit | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|-------------| +| -------- | --------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [](#), [](#). | | | ### Color @@ -218,7 +222,7 @@ Controls cell value unit Controls the color options | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|-------------| +| -------- | --------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [](#), [](#). | | | ### FilterValues @@ -226,7 +230,5 @@ Controls the color options Filters values between a given range | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|-------------| +| -------- | --------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [](#), [](#). | | | - - diff --git a/docs/sources/developers/kinds/composable/histogram/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/histogram/panelcfg/schema-reference.md index 8db7d68aeb4..09610a389ff 100644 --- a/docs/sources/developers/kinds/composable/histogram/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/histogram/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: HistogramPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## HistogramPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,27 +27,27 @@ title: HistogramPanelCfg kind It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | +| ------------------- | --------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | | `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.
Constraint: `>=0 & <=100`. | | `gradientMode` | string | No | | Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.
Gradient appearance is influenced by the Fill opacity setting. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `lineWidth` | integer | No | `1` | Controls line width of the bars.
Constraint: `>=0 & <=10`. | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | ### AxisConfig TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -59,7 +63,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -69,7 +73,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -79,7 +83,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### Options @@ -87,9 +91,9 @@ TODO docs It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip). | Property | Type | Required | Default | Description | -|----------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------| -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| -------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `bucketOffset` | int32 | No | `0` | Offset buckets by this amount | | `bucketSize` | integer | No | | Size of each bucket | | `combine` | boolean | No | | Combines multiple series into a single histogram | @@ -99,7 +103,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -107,7 +111,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -123,7 +127,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -131,8 +135,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md index 8db7d68aeb4..09610a389ff 100644 --- a/docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: HistogramPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## HistogramPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,27 +27,27 @@ title: HistogramPanelCfg kind It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | +| ------------------- | --------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | | `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.
Constraint: `>=0 & <=100`. | | `gradientMode` | string | No | | Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.
Gradient appearance is influenced by the Fill opacity setting. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `lineWidth` | integer | No | `1` | Controls line width of the bars.
Constraint: `>=0 & <=10`. | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | ### AxisConfig TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -59,7 +63,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -69,7 +73,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -79,7 +83,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### Options @@ -87,9 +91,9 @@ TODO docs It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip). | Property | Type | Required | Default | Description | -|----------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------| -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| -------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `bucketOffset` | int32 | No | `0` | Offset buckets by this amount | | `bucketSize` | integer | No | | Size of each bucket | | `combine` | boolean | No | | Combines multiple series into a single histogram | @@ -99,7 +103,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -107,7 +111,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -123,7 +127,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -131,8 +135,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/logs/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/logs/panelcfg/schema-reference.md index 898b37b6aaa..87599437dd5 100644 --- a/docs/sources/developers/kinds/composable/logs/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/logs/panelcfg/schema-reference.md @@ -1,26 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: LogsPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## LogsPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|----------------------|---------|----------|---------|---------------------------------------------------------------| +| -------------------- | ------- | -------- | ------- | ------------------------------------------------------------- | | `dedupStrategy` | string | **Yes** | | Possible values are: `none`, `exact`, `numbers`, `signature`. | | `enableLogDetails` | boolean | **Yes** | | | | `prettifyLogMessage` | boolean | **Yes** | | | @@ -29,5 +33,3 @@ title: LogsPanelCfg kind | `showTime` | boolean | **Yes** | | | | `sortOrder` | string | **Yes** | | Possible values are: `Descending`, `Ascending`. | | `wrapLogMessage` | boolean | **Yes** | | | - - diff --git a/docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md index 898b37b6aaa..87599437dd5 100644 --- a/docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md @@ -1,26 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: LogsPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## LogsPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|----------------------|---------|----------|---------|---------------------------------------------------------------| +| -------------------- | ------- | -------- | ------- | ------------------------------------------------------------- | | `dedupStrategy` | string | **Yes** | | Possible values are: `none`, `exact`, `numbers`, `signature`. | | `enableLogDetails` | boolean | **Yes** | | | | `prettifyLogMessage` | boolean | **Yes** | | | @@ -29,5 +33,3 @@ title: LogsPanelCfg kind | `showTime` | boolean | **Yes** | | | | `sortOrder` | string | **Yes** | | Possible values are: `Descending`, `Ascending`. | | `wrapLogMessage` | boolean | **Yes** | | | - - diff --git a/docs/sources/developers/kinds/composable/loki/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/loki/dataquery/schema-reference.md index df3e378cb30..71eca9bc6f1 100644 --- a/docs/sources/developers/kinds/composable/loki/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/loki/dataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: LokiDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## LokiDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `expr` | string | **Yes** | | The LogQL query. | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `datasource` | | No | | For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null | @@ -27,5 +31,3 @@ title: LokiDataQuery kind | `range` | boolean | No | | @deprecated, now use queryType. | | `resolution` | integer | No | | @deprecated, now use step. | | `step` | string | No | | Used to set step value for range queries. | - - diff --git a/docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md b/docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md index 7bc39d81bce..5c999a76e65 100644 --- a/docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: LokiDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## LokiDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `expr` | string | **Yes** | | The LogQL query. | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `datasource` | | No | | For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null | @@ -26,5 +30,3 @@ title: LokiDataQuery kind | `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default | | `range` | boolean | No | | @deprecated, now use queryType. | | `resolution` | integer | No | | Used to scale the interval value. | - - diff --git a/docs/sources/developers/kinds/composable/news/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/news/panelcfg/schema-reference.md index 0a30b2951f1..532f02f8d71 100644 --- a/docs/sources/developers/kinds/composable/news/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/news/panelcfg/schema-reference.md @@ -1,27 +1,29 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: NewsPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## NewsPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|-------------|---------|----------|---------|--------------------------------------------| +| ----------- | ------- | -------- | ------- | ------------------------------------------ | | `feedUrl` | string | No | | empty/missing will default to grafana blog | | `showImage` | boolean | No | `true` | | - - diff --git a/docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md index 0a30b2951f1..532f02f8d71 100644 --- a/docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md @@ -1,27 +1,29 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: NewsPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## NewsPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|-------------|---------|----------|---------|--------------------------------------------| +| ----------- | ------- | -------- | ------- | ------------------------------------------ | | `feedUrl` | string | No | | empty/missing will default to grafana blog | | `showImage` | boolean | No | `true` | | - - diff --git a/docs/sources/developers/kinds/composable/nodegraph/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/nodegraph/panelcfg/schema-reference.md index 62b010fb374..401c04a90e2 100644 --- a/docs/sources/developers/kinds/composable/nodegraph/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/nodegraph/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: NodeGraphPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## NodeGraphPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `ArcOption` | [object](#arcoption) | **Yes** | | | | `EdgeOptions` | [object](#edgeoptions) | **Yes** | | | | `NodeOptions` | [object](#nodeoptions) | **Yes** | | | @@ -23,21 +27,21 @@ title: NodeGraphPanelCfg kind ### ArcOption | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------- | | `color` | string | No | | The color of the arc. | | `field` | string | No | | Field from which to get the value. Values should be less than 1, representing fraction of a circle. | ### EdgeOptions | Property | Type | Required | Default | Description | -|---------------------|--------|----------|---------|-----------------------------------------------------------------------------| +| ------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. | | `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. | ### NodeOptions | Property | Type | Required | Default | Description | -|---------------------|---------------------------|----------|---------|-----------------------------------------------------------------------------------------| +| ------------------- | ------------------------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `arcs` | [ArcOption](#arcoption)[] | No | | Define which fields are shown as part of the node arc (colored circle around the node). | | `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. | | `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. | @@ -45,8 +49,6 @@ title: NodeGraphPanelCfg kind ### Options | Property | Type | Required | Default | Description | -|----------|-----------------------------|----------|---------|-------------| +| -------- | --------------------------- | -------- | ------- | ----------- | | `edges` | [EdgeOptions](#edgeoptions) | No | | | | `nodes` | [NodeOptions](#nodeoptions) | No | | | - - diff --git a/docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md index 62b010fb374..401c04a90e2 100644 --- a/docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: NodeGraphPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## NodeGraphPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `ArcOption` | [object](#arcoption) | **Yes** | | | | `EdgeOptions` | [object](#edgeoptions) | **Yes** | | | | `NodeOptions` | [object](#nodeoptions) | **Yes** | | | @@ -23,21 +27,21 @@ title: NodeGraphPanelCfg kind ### ArcOption | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------- | | `color` | string | No | | The color of the arc. | | `field` | string | No | | Field from which to get the value. Values should be less than 1, representing fraction of a circle. | ### EdgeOptions | Property | Type | Required | Default | Description | -|---------------------|--------|----------|---------|-----------------------------------------------------------------------------| +| ------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. | | `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. | ### NodeOptions | Property | Type | Required | Default | Description | -|---------------------|---------------------------|----------|---------|-----------------------------------------------------------------------------------------| +| ------------------- | ------------------------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `arcs` | [ArcOption](#arcoption)[] | No | | Define which fields are shown as part of the node arc (colored circle around the node). | | `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. | | `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. | @@ -45,8 +49,6 @@ title: NodeGraphPanelCfg kind ### Options | Property | Type | Required | Default | Description | -|----------|-----------------------------|----------|---------|-------------| +| -------- | --------------------------- | -------- | ------- | ----------- | | `edges` | [EdgeOptions](#edgeoptions) | No | | | | `nodes` | [NodeOptions](#nodeoptions) | No | | | - - diff --git a/docs/sources/developers/kinds/composable/parca/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/parca/dataquery/schema-reference.md index 21b1c727d2a..f701402b63e 100644 --- a/docs/sources/developers/kinds/composable/parca/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/parca/dataquery/schema-reference.md @@ -1,25 +1,27 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: ParcaDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## ParcaDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. | | `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `datasource` | | No | | For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null | | `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) | | `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default | - - diff --git a/docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md b/docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md index 21b1c727d2a..f701402b63e 100644 --- a/docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md @@ -1,25 +1,27 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: ParcaDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## ParcaDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. | | `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `datasource` | | No | | For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null | | `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) | | `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default | - - diff --git a/docs/sources/developers/kinds/composable/piechart/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/piechart/panelcfg/schema-reference.md index 0d032859041..6aaee1e65c5 100644 --- a/docs/sources/developers/kinds/composable/piechart/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/piechart/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: PieChartPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## PieChartPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-------------------------|---------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------------------- | ------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `FieldConfig` | [HideableFieldConfig](#hideablefieldconfig) | **Yes** | | TODO docs | | `Options` | [object](#options) | **Yes** | | | | `PieChartLabels` | string | **Yes** | | Select labels to display on the pie chart.
- Name - The series or field name.
- Percent - The percentage of the whole.
- Value - The raw numerical value.
Possible values are: `name`, `value`, `percent`. | @@ -27,7 +31,7 @@ title: PieChartPanelCfg kind TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### HideSeriesConfig @@ -35,7 +39,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -45,21 +49,21 @@ TODO docs It extends [OptionsWithTooltip](#optionswithtooltip) and [SingleStatBaseOptions](#singlestatbaseoptions). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `displayLabels` | string[] | **Yes** | | | | `legend` | [PieChartLegendOptions](#piechartlegendoptions) | **Yes** | | | | `pieType` | string | **Yes** | | Select the pie chart display style.
Possible values are: `pie`, `donut`. | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | -| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | -| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | +| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | +| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | ### OptionsWithTooltip TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -67,7 +71,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | @@ -76,24 +80,24 @@ TODO docs It extends [VizLegendOptions](#vizlegendoptions). | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `displayMode` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*
TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | -| `placement` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*
TODO docs
Possible values are: `bottom`, `right`. | -| `showLegend` | boolean | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | +| ------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `calcs` | string[] | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `displayMode` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_
TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | +| `placement` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_
TODO docs
Possible values are: `bottom`, `right`. | +| `showLegend` | boolean | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | | `values` | string[] | **Yes** | | | -| `asTable` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `isVisible` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `sortBy` | string | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `sortDesc` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `width` | number | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | +| `asTable` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `isVisible` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `sortBy` | string | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `sortDesc` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `width` | number | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | ### VizLegendOptions TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -108,12 +112,12 @@ TODO docs TODO docs -| Property | Type | Required | Default | Description | -|----------|----------|----------|---------|---------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | -| `fields` | string | No | | Which fields to show. By default this is only numeric fields | -| `limit` | number | No | | if showing all values limit | -| `values` | boolean | No | | If true show each row value | +| Property | Type | Required | Default | Description | +| -------- | -------- | -------- | ------- | ------------------------------------------------------------ | +| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | +| `fields` | string | No | | Which fields to show. By default this is only numeric fields | +| `limit` | number | No | | if showing all values limit | +| `values` | boolean | No | | If true show each row value | ### SingleStatBaseOptions @@ -122,17 +126,17 @@ TODO docs It extends [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | ### OptionsWithTextFormatting TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -140,8 +144,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | - - diff --git a/docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md index 0d032859041..6aaee1e65c5 100644 --- a/docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: PieChartPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## PieChartPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-------------------------|---------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------------------- | ------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `FieldConfig` | [HideableFieldConfig](#hideablefieldconfig) | **Yes** | | TODO docs | | `Options` | [object](#options) | **Yes** | | | | `PieChartLabels` | string | **Yes** | | Select labels to display on the pie chart.
- Name - The series or field name.
- Percent - The percentage of the whole.
- Value - The raw numerical value.
Possible values are: `name`, `value`, `percent`. | @@ -27,7 +31,7 @@ title: PieChartPanelCfg kind TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### HideSeriesConfig @@ -35,7 +39,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -45,21 +49,21 @@ TODO docs It extends [OptionsWithTooltip](#optionswithtooltip) and [SingleStatBaseOptions](#singlestatbaseoptions). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `displayLabels` | string[] | **Yes** | | | | `legend` | [PieChartLegendOptions](#piechartlegendoptions) | **Yes** | | | | `pieType` | string | **Yes** | | Select the pie chart display style.
Possible values are: `pie`, `donut`. | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | -| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | -| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | +| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | +| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | ### OptionsWithTooltip TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -67,7 +71,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | @@ -76,24 +80,24 @@ TODO docs It extends [VizLegendOptions](#vizlegendoptions). | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `displayMode` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*
TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | -| `placement` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*
TODO docs
Possible values are: `bottom`, `right`. | -| `showLegend` | boolean | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | +| ------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `calcs` | string[] | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `displayMode` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_
TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | +| `placement` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_
TODO docs
Possible values are: `bottom`, `right`. | +| `showLegend` | boolean | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | | `values` | string[] | **Yes** | | | -| `asTable` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `isVisible` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `sortBy` | string | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `sortDesc` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | -| `width` | number | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | +| `asTable` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `isVisible` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `sortBy` | string | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `sortDesc` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | +| `width` | number | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ | ### VizLegendOptions TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -108,12 +112,12 @@ TODO docs TODO docs -| Property | Type | Required | Default | Description | -|----------|----------|----------|---------|---------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | -| `fields` | string | No | | Which fields to show. By default this is only numeric fields | -| `limit` | number | No | | if showing all values limit | -| `values` | boolean | No | | If true show each row value | +| Property | Type | Required | Default | Description | +| -------- | -------- | -------- | ------- | ------------------------------------------------------------ | +| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | +| `fields` | string | No | | Which fields to show. By default this is only numeric fields | +| `limit` | number | No | | if showing all values limit | +| `values` | boolean | No | | If true show each row value | ### SingleStatBaseOptions @@ -122,17 +126,17 @@ TODO docs It extends [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | ### OptionsWithTextFormatting TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -140,8 +144,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | - - diff --git a/docs/sources/developers/kinds/composable/prometheus/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/prometheus/dataquery/schema-reference.md index 1fc97a0a527..42528b10fbd 100644 --- a/docs/sources/developers/kinds/composable/prometheus/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/prometheus/dataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: PrometheusDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## PrometheusDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|------------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `expr` | string | **Yes** | | The actual expression/query that will be evaluated by Prometheus | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `datasource` | | No | | For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null | @@ -27,5 +31,3 @@ title: PrometheusDataQuery kind | `legendFormat` | string | No | | Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname | | `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default | | `range` | boolean | No | | Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series | - - diff --git a/docs/sources/developers/kinds/composable/prometheusdataquery/schema-reference.md b/docs/sources/developers/kinds/composable/prometheusdataquery/schema-reference.md index 1fc97a0a527..42528b10fbd 100644 --- a/docs/sources/developers/kinds/composable/prometheusdataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/prometheusdataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: PrometheusDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## PrometheusDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|------------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `expr` | string | **Yes** | | The actual expression/query that will be evaluated by Prometheus | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `datasource` | | No | | For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null | @@ -27,5 +31,3 @@ title: PrometheusDataQuery kind | `legendFormat` | string | No | | Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname | | `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default | | `range` | boolean | No | | Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series | - - diff --git a/docs/sources/developers/kinds/composable/stat/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/stat/panelcfg/schema-reference.md index f4949566aa9..9a61581a6dd 100644 --- a/docs/sources/developers/kinds/composable/stat/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/stat/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: StatPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## StatPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options @@ -22,25 +26,25 @@ title: StatPanelCfg kind It extends [SingleStatBaseOptions](#singlestatbaseoptions). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `colorMode` | string | **Yes** | | TODO docs
Possible values are: `value`, `background`, `background_solid`, `none`. | | `graphMode` | string | **Yes** | | TODO docs
Possible values are: `none`, `line`, `area`. | | `justifyMode` | string | **Yes** | | TODO docs
Possible values are: `auto`, `center`. | | `textMode` | string | **Yes** | | TODO docs
Possible values are: `auto`, `value`, `value_and_name`, `name`, `none`. | -| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | -| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | +| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | +| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | ### ReduceDataOptions TODO docs -| Property | Type | Required | Default | Description | -|----------|----------|----------|---------|---------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | -| `fields` | string | No | | Which fields to show. By default this is only numeric fields | -| `limit` | number | No | | if showing all values limit | -| `values` | boolean | No | | If true show each row value | +| Property | Type | Required | Default | Description | +| -------- | -------- | -------- | ------- | ------------------------------------------------------------ | +| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | +| `fields` | string | No | | Which fields to show. By default this is only numeric fields | +| `limit` | number | No | | if showing all values limit | +| `values` | boolean | No | | If true show each row value | ### SingleStatBaseOptions @@ -49,17 +53,17 @@ TODO docs It extends [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | ### OptionsWithTextFormatting TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -67,8 +71,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | - - diff --git a/docs/sources/developers/kinds/composable/statetimeline/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/statetimeline/panelcfg/schema-reference.md index d383e8e68fd..f094d17a378 100644 --- a/docs/sources/developers/kinds/composable/statetimeline/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/statetimeline/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: StateTimelinePanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## StateTimelinePanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,9 +27,9 @@ title: StateTimelinePanelCfg kind It extends [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------| +| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- | | `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `lineWidth` | integer | No | `0` | Constraint: `>=0 & <=10`. | ### HideSeriesConfig @@ -33,7 +37,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig). TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -43,7 +47,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### Options @@ -51,21 +55,21 @@ TODO docs It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones). | Property | Type | Required | Default | Description | -|---------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------| -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | +| ------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | | `rowHeight` | number | **Yes** | `0.9` | Controls the row height | | `showValue` | string | **Yes** | | Show timeline values on chart | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `alignValue` | string | No | | Controls value alignment on the timelines | | `mergeValues` | boolean | No | `true` | Merge equal consecutive values | -| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* | +| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ | ### OptionsWithLegend TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -73,7 +77,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -89,7 +93,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|----------|----------|---------|-------------| +| ---------- | -------- | -------- | ------- | ----------- | | `timezone` | string[] | No | | | ### OptionsWithTooltip @@ -97,7 +101,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -105,8 +109,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md index d383e8e68fd..f094d17a378 100644 --- a/docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: StateTimelinePanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## StateTimelinePanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,9 +27,9 @@ title: StateTimelinePanelCfg kind It extends [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------| +| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- | | `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `lineWidth` | integer | No | `0` | Constraint: `>=0 & <=10`. | ### HideSeriesConfig @@ -33,7 +37,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig). TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -43,7 +47,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### Options @@ -51,21 +55,21 @@ TODO docs It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones). | Property | Type | Required | Default | Description | -|---------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------| -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | +| ------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | | `rowHeight` | number | **Yes** | `0.9` | Controls the row height | | `showValue` | string | **Yes** | | Show timeline values on chart | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `alignValue` | string | No | | Controls value alignment on the timelines | | `mergeValues` | boolean | No | `true` | Merge equal consecutive values | -| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* | +| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ | ### OptionsWithLegend TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -73,7 +77,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -89,7 +93,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|----------|----------|---------|-------------| +| ---------- | -------- | -------- | ------- | ----------- | | `timezone` | string[] | No | | | ### OptionsWithTooltip @@ -97,7 +101,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -105,8 +109,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md index f4949566aa9..9a61581a6dd 100644 --- a/docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: StatPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## StatPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options @@ -22,25 +26,25 @@ title: StatPanelCfg kind It extends [SingleStatBaseOptions](#singlestatbaseoptions). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `colorMode` | string | **Yes** | | TODO docs
Possible values are: `value`, `background`, `background_solid`, `none`. | | `graphMode` | string | **Yes** | | TODO docs
Possible values are: `none`, `line`, `area`. | | `justifyMode` | string | **Yes** | | TODO docs
Possible values are: `auto`, `center`. | | `textMode` | string | **Yes** | | TODO docs
Possible values are: `auto`, `value`, `value_and_name`, `name`, `none`. | -| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | -| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs | +| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | +| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_
TODO docs | ### ReduceDataOptions TODO docs -| Property | Type | Required | Default | Description | -|----------|----------|----------|---------|---------------------------------------------------------------| -| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | -| `fields` | string | No | | Which fields to show. By default this is only numeric fields | -| `limit` | number | No | | if showing all values limit | -| `values` | boolean | No | | If true show each row value | +| Property | Type | Required | Default | Description | +| -------- | -------- | -------- | ------- | ------------------------------------------------------------ | +| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field | +| `fields` | string | No | | Which fields to show. By default this is only numeric fields | +| `limit` | number | No | | if showing all values limit | +| `values` | boolean | No | | If true show each row value | ### SingleStatBaseOptions @@ -49,17 +53,17 @@ TODO docs It extends [OptionsWithTextFormatting](#optionswithtextformatting). | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs | -| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs | +| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_
TODO docs | ### OptionsWithTextFormatting TODO docs | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------- | -------- | ------- | ----------- | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs | ### VizTextDisplayOptions @@ -67,8 +71,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------|--------|----------|---------|--------------------------| +| ----------- | ------ | -------- | ------- | ------------------------ | | `titleSize` | number | No | | Explicit title text size | | `valueSize` | number | No | | Explicit value text size | - - diff --git a/docs/sources/developers/kinds/composable/statushistory/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/statushistory/panelcfg/schema-reference.md index 1113fbaa539..37043dd87a0 100644 --- a/docs/sources/developers/kinds/composable/statushistory/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/statushistory/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: StatusHistoryPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## StatusHistoryPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,9 +27,9 @@ title: StatusHistoryPanelCfg kind It extends [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------| +| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- | | `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `lineWidth` | integer | No | `1` | Constraint: `>=0 & <=10`. | ### HideSeriesConfig @@ -33,7 +37,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig). TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -43,7 +47,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### Options @@ -51,20 +55,20 @@ TODO docs It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones). | Property | Type | Required | Default | Description | -|-------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------| -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | +| ----------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | | `rowHeight` | number | **Yes** | `0.9` | Set the height of the rows
Constraint: `>=0 & <=1`. | | `showValue` | string | **Yes** | | Show values on the columns | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `colWidth` | number | No | `0.9` | Controls the column width | -| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* | +| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ | ### OptionsWithLegend TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -72,7 +76,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -88,7 +92,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|----------|----------|---------|-------------| +| ---------- | -------- | -------- | ------- | ----------- | | `timezone` | string[] | No | | | ### OptionsWithTooltip @@ -96,7 +100,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -104,8 +108,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md index 1113fbaa539..37043dd87a0 100644 --- a/docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: StatusHistoryPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## StatusHistoryPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|------------------------|----------|---------|-------------| +| ------------- | ---------------------- | -------- | ------- | ----------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,9 +27,9 @@ title: StatusHistoryPanelCfg kind It extends [HideableFieldConfig](#hideablefieldconfig). | Property | Type | Required | Default | Description | -|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------| +| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- | | `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `lineWidth` | integer | No | `1` | Constraint: `>=0 & <=10`. | ### HideSeriesConfig @@ -33,7 +37,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig). TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -43,7 +47,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### Options @@ -51,20 +55,20 @@ TODO docs It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones). | Property | Type | Required | Default | Description | -|-------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------| -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | +| ----------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | | `rowHeight` | number | **Yes** | `0.9` | Set the height of the rows
Constraint: `>=0 & <=1`. | | `showValue` | string | **Yes** | | Show values on the columns | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `colWidth` | number | No | `0.9` | Controls the column width | -| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* | +| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ | ### OptionsWithLegend TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -72,7 +76,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -88,7 +92,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|----------|----------|---------|-------------| +| ---------- | -------- | -------- | ------- | ----------- | | `timezone` | string[] | No | | | ### OptionsWithTooltip @@ -96,7 +100,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -104,8 +108,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/table/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/table/panelcfg/schema-reference.md index 6a054007d25..b837828f20b 100644 --- a/docs/sources/developers/kinds/composable/table/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/table/panelcfg/schema-reference.md @@ -1,26 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TablePanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TablePanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|-----------------|---------------------------------------------------|----------|----------------------------------------------|--------------------------------------------------------------------| +| --------------- | ------------------------------------------------- | -------- | -------------------------------------------- | ------------------------------------------------------------------ | | `frameIndex` | number | **Yes** | `0` | Represents the index of the selected frame | | `showHeader` | boolean | **Yes** | `true` | Controls whether the panel should show the header | | `cellHeight` | string | No | | Controls the height of the rows | @@ -33,7 +37,7 @@ title: TablePanelCfg kind Sort by field state | Property | Type | Required | Default | Description | -|---------------|---------|----------|---------|-----------------------------------------------| +| ------------- | ------- | -------- | ------- | --------------------------------------------- | | `displayName` | string | **Yes** | | Sets the display name of the field to sort by | | `desc` | boolean | No | | Flag used to indicate descending sort order | @@ -42,7 +46,5 @@ Sort by field state Controls footer options | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|-------------| +| -------- | --------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [](#), [](#). | | | - - diff --git a/docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md index 6a054007d25..b837828f20b 100644 --- a/docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md @@ -1,26 +1,30 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TablePanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TablePanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `Options` | [object](#options) | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|-----------------|---------------------------------------------------|----------|----------------------------------------------|--------------------------------------------------------------------| +| --------------- | ------------------------------------------------- | -------- | -------------------------------------------- | ------------------------------------------------------------------ | | `frameIndex` | number | **Yes** | `0` | Represents the index of the selected frame | | `showHeader` | boolean | **Yes** | `true` | Controls whether the panel should show the header | | `cellHeight` | string | No | | Controls the height of the rows | @@ -33,7 +37,7 @@ title: TablePanelCfg kind Sort by field state | Property | Type | Required | Default | Description | -|---------------|---------|----------|---------|-----------------------------------------------| +| ------------- | ------- | -------- | ------- | --------------------------------------------- | | `displayName` | string | **Yes** | | Sets the display name of the field to sort by | | `desc` | boolean | No | | Flag used to indicate descending sort order | @@ -42,7 +46,5 @@ Sort by field state Controls footer options | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|-------------| +| -------- | --------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [](#), [](#). | | | - - diff --git a/docs/sources/developers/kinds/composable/tempo/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/tempo/dataquery/schema-reference.md index 9886ce72c7a..bbd81bd05e1 100644 --- a/docs/sources/developers/kinds/composable/tempo/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/tempo/dataquery/schema-reference.md @@ -1,19 +1,21 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TempoDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TempoDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md b/docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md index 9886ce72c7a..bbd81bd05e1 100644 --- a/docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md @@ -1,19 +1,21 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TempoDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TempoDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/composable/testdata/dataquery/schema-reference.md b/docs/sources/developers/kinds/composable/testdata/dataquery/schema-reference.md index 128ba797386..a40d02275b4 100644 --- a/docs/sources/developers/kinds/composable/testdata/dataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/testdata/dataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TestDataDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TestDataDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-------------------|-------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------------- | ----------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `alias` | string | No | | | | `channel` | string | No | | | @@ -44,7 +48,7 @@ title: TestDataDataQuery kind ### CSVWave | Property | Type | Required | Default | Description | -|-------------|---------|----------|---------|-------------| +| ----------- | ------- | -------- | ------- | ----------- | | `labels` | string | No | | | | `name` | string | No | | | | `timeStep` | integer | No | | | @@ -53,14 +57,14 @@ title: TestDataDataQuery kind ### NodesQuery | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|------------------------------------------------------------| +| -------- | ------- | -------- | ------- | ---------------------------------------------------------- | | `count` | integer | No | | | | `type` | string | No | | Possible values are: `random`, `response`, `random edges`. | ### PulseWaveQuery | Property | Type | Required | Default | Description | -|------------|---------|----------|---------|-------------| +| ---------- | ------- | -------- | ------- | ----------- | | `offCount` | integer | No | | | | `offValue` | number | No | | | | `onCount` | integer | No | | | @@ -70,7 +74,7 @@ title: TestDataDataQuery kind ### SimulationQuery | Property | Type | Required | Default | Description | -|----------|-------------------|----------|---------|-------------| +| -------- | ----------------- | -------- | ------- | ----------- | | `key` | [object](#key) | **Yes** | | | | `config` | [object](#config) | No | | | | `last` | boolean | No | | | @@ -79,12 +83,12 @@ title: TestDataDataQuery kind ### Config | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Key | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `tick` | number | **Yes** | | | | `type` | string | **Yes** | | | | `uid` | string | No | | | @@ -92,7 +96,7 @@ title: TestDataDataQuery kind ### StreamingQuery | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|-------------------------------------------------| +| -------- | ------- | -------- | ------- | ----------------------------------------------- | | `noise` | integer | **Yes** | | | | `speed` | integer | **Yes** | | | | `spread` | integer | **Yes** | | | @@ -103,10 +107,8 @@ title: TestDataDataQuery kind ### USAQuery | Property | Type | Required | Default | Description | -|----------|----------|----------|---------|-------------| +| -------- | -------- | -------- | ------- | ----------- | | `fields` | string[] | No | | | | `mode` | string | No | | | | `period` | string | No | | | | `states` | string[] | No | | | - - diff --git a/docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md b/docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md index 1db393887a6..11475b3a1e9 100644 --- a/docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md +++ b/docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TestDataDataQuery kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TestDataDataQuery #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-------------------|-------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------------- | ----------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. | | `alias` | string | No | | | | `channel` | string | No | | | @@ -43,7 +47,7 @@ title: TestDataDataQuery kind ### CSVWave | Property | Type | Required | Default | Description | -|-------------|---------|----------|---------|-------------| +| ----------- | ------- | -------- | ------- | ----------- | | `labels` | string | No | | | | `name` | string | No | | | | `timeStep` | integer | No | | | @@ -52,14 +56,14 @@ title: TestDataDataQuery kind ### NodesQuery | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|------------------------------------------------------------| +| -------- | ------- | -------- | ------- | ---------------------------------------------------------- | | `count` | integer | No | | | | `type` | string | No | | Possible values are: `random`, `response`, `random edges`. | ### PulseWaveQuery | Property | Type | Required | Default | Description | -|------------|---------|----------|---------|-------------| +| ---------- | ------- | -------- | ------- | ----------- | | `offCount` | integer | No | | | | `offValue` | number | No | | | | `onCount` | integer | No | | | @@ -69,7 +73,7 @@ title: TestDataDataQuery kind ### SimulationQuery | Property | Type | Required | Default | Description | -|----------|-------------------|----------|---------|-------------| +| -------- | ----------------- | -------- | ------- | ----------- | | `key` | [object](#key) | **Yes** | | | | `config` | [object](#config) | No | | | | `last` | boolean | No | | | @@ -78,12 +82,12 @@ title: TestDataDataQuery kind ### Config | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Key | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `tick` | number | **Yes** | | | | `type` | string | **Yes** | | | | `uid` | string | No | | | @@ -91,7 +95,7 @@ title: TestDataDataQuery kind ### StreamingQuery | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|-------------------------------------------------| +| -------- | ------- | -------- | ------- | ----------------------------------------------- | | `noise` | integer | **Yes** | | | | `speed` | integer | **Yes** | | | | `spread` | integer | **Yes** | | | @@ -102,10 +106,8 @@ title: TestDataDataQuery kind ### USAQuery | Property | Type | Required | Default | Description | -|----------|----------|----------|---------|-------------| +| -------- | -------- | -------- | ------- | ----------- | | `fields` | string[] | No | | | | `mode` | string | No | | | | `period` | string | No | | | | `states` | string[] | No | | | - - diff --git a/docs/sources/developers/kinds/composable/text/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/text/panelcfg/schema-reference.md index 067c697f620..6f7550f5f93 100644 --- a/docs/sources/developers/kinds/composable/text/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/text/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TextPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TextPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------------|------------------------|----------|-------------|---------------------------------------------------------------------------------------------------------| +| -------------- | ---------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- | | `CodeLanguage` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. | | `CodeOptions` | [object](#codeoptions) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,7 +27,7 @@ title: TextPanelCfg kind ### CodeOptions | Property | Type | Required | Default | Description | -|-------------------|---------|----------|-------------|---------------------------------------------------------------------------------------------------------| +| ----------------- | ------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- | | `language` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. | | `showLineNumbers` | boolean | **Yes** | `false` | | | `showMiniMap` | boolean | **Yes** | `false` | | @@ -31,11 +35,9 @@ title: TextPanelCfg kind ### Options | Property | Type | Required | Default | Description | -|-----------|-----------------------------|----------|--------------------------------------------------------------------------------|--------------------------------------------------| +| --------- | --------------------------- | -------- | ------------------------------------------------------------------------------ | ------------------------------------------------ | | `content` | string | **Yes** | `# Title | | | | | | | | | | | | For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)` | | | `mode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. | | `code` | [CodeOptions](#codeoptions) | No | | | - - diff --git a/docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md index 067c697f620..6f7550f5f93 100644 --- a/docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TextPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TextPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|----------------|------------------------|----------|-------------|---------------------------------------------------------------------------------------------------------| +| -------------- | ---------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- | | `CodeLanguage` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. | | `CodeOptions` | [object](#codeoptions) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | @@ -23,7 +27,7 @@ title: TextPanelCfg kind ### CodeOptions | Property | Type | Required | Default | Description | -|-------------------|---------|----------|-------------|---------------------------------------------------------------------------------------------------------| +| ----------------- | ------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- | | `language` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. | | `showLineNumbers` | boolean | **Yes** | `false` | | | `showMiniMap` | boolean | **Yes** | `false` | | @@ -31,11 +35,9 @@ title: TextPanelCfg kind ### Options | Property | Type | Required | Default | Description | -|-----------|-----------------------------|----------|--------------------------------------------------------------------------------|--------------------------------------------------| +| --------- | --------------------------- | -------- | ------------------------------------------------------------------------------ | ------------------------------------------------ | | `content` | string | **Yes** | `# Title | | | | | | | | | | | | For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)` | | | `mode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. | | `code` | [CodeOptions](#codeoptions) | No | | | - - diff --git a/docs/sources/developers/kinds/composable/timeseries/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/timeseries/panelcfg/schema-reference.md index f5d2a9f8e2d..fe5ea105ade 100644 --- a/docs/sources/developers/kinds/composable/timeseries/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/timeseries/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TimeSeriesPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TimeSeriesPanelCfg #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|---------------------------------------|----------|---------|-------------| +| ------------- | ------------------------------------- | -------- | ------- | ----------- | | `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs | | `Options` | [object](#options) | **Yes** | | | @@ -24,45 +28,45 @@ TODO docs It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig). -| Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*
TODO docs
Possible values are: `-1`, `0`, `1`. | -| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | -| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | -| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs | -| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | -| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*
TODO docs
Possible values are: `auto`, `never`, `always`. | -| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | -| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*
TODO docs | -| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | -| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | +| Property | Type | Required | Default | Description | +| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_
TODO docs
Possible values are: `-1`, `0`, `1`. | +| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | +| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | +| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs | +| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | +| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_
TODO docs
Possible values are: `auto`, `never`, `always`. | +| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_
TODO docs | +| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | +| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | ### AxisConfig TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -78,7 +82,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -88,7 +92,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------------|---------|----------|---------|----------------------------------------------------| +| ---------------- | ------- | -------- | ------- | -------------------------------------------------- | | `barAlignment` | integer | No | | TODO docs
Possible values are: `-1`, `0`, `1`. | | `barMaxWidth` | number | No | | | | `barWidthFactor` | number | No | | | @@ -98,7 +102,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|-------------| +| ------------- | ------ | -------- | ------- | ----------- | | `fillBelowTo` | string | No | | | | `fillColor` | string | No | | | | `fillOpacity` | number | No | | | @@ -108,7 +112,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. | ### HideSeriesConfig @@ -116,7 +120,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -126,27 +130,27 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### LineConfig TODO docs -| Property | Type | Required | Default | Description | -|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `lineColor` | string | No | | | -| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | -| `lineWidth` | number | No | | | -| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| Property | Type | Required | Default | Description | +| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `lineColor` | string | No | | | +| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | +| `lineWidth` | number | No | | | +| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | ### LineStyle TODO docs | Property | Type | Required | Default | Description | -|----------|----------|----------|---------|--------------------------------------------------------| +| -------- | -------- | -------- | ------- | ------------------------------------------------------ | | `dash` | number[] | No | | | | `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. | @@ -155,7 +159,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|---------------------------------------------------------------| +| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `pointColor` | string | No | | | | `pointSize` | number | No | | | | `pointSymbol` | string | No | | | @@ -166,7 +170,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|-----------------------------------|----------|---------|-------------| +| ---------- | --------------------------------- | -------- | ------- | ----------- | | `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs | ### StackingConfig @@ -174,7 +178,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------- | | `group` | string | No | | | | `mode` | string | No | | TODO docs
Possible values are: `none`, `normal`, `percent`. | @@ -183,17 +187,17 @@ TODO docs It extends [OptionsWithTimezones](#optionswithtimezones). | Property | Type | Required | Default | Description | -|------------|-----------------------------------------|----------|---------|------------------------------------------------------------------| +| ---------- | --------------------------------------- | -------- | ------- | ---------------------------------------------------------------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | -| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* | +| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ | ### OptionsWithTimezones TODO docs | Property | Type | Required | Default | Description | -|------------|----------|----------|---------|-------------| +| ---------- | -------- | -------- | ------- | ----------- | | `timezone` | string[] | No | | | ### VizLegendOptions @@ -201,7 +205,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -217,8 +221,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/timeseriespanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/timeseriespanelcfg/schema-reference.md index f5d2a9f8e2d..fe5ea105ade 100644 --- a/docs/sources/developers/kinds/composable/timeseriespanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/timeseriespanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TimeSeriesPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TimeSeriesPanelCfg #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|---------------------------------------|----------|---------|-------------| +| ------------- | ------------------------------------- | -------- | ------- | ----------- | | `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs | | `Options` | [object](#options) | **Yes** | | | @@ -24,45 +28,45 @@ TODO docs It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig). -| Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*
TODO docs
Possible values are: `-1`, `0`, `1`. | -| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | -| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | -| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs | -| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | -| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*
TODO docs
Possible values are: `auto`, `never`, `always`. | -| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | -| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*
TODO docs | -| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | -| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | +| Property | Type | Required | Default | Description | +| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_
TODO docs
Possible values are: `-1`, `0`, `1`. | +| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | +| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | +| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs | +| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | +| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_
TODO docs
Possible values are: `auto`, `never`, `always`. | +| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_
TODO docs | +| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | +| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | ### AxisConfig TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -78,7 +82,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -88,7 +92,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------------|---------|----------|---------|----------------------------------------------------| +| ---------------- | ------- | -------- | ------- | -------------------------------------------------- | | `barAlignment` | integer | No | | TODO docs
Possible values are: `-1`, `0`, `1`. | | `barMaxWidth` | number | No | | | | `barWidthFactor` | number | No | | | @@ -98,7 +102,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|-------------| +| ------------- | ------ | -------- | ------- | ----------- | | `fillBelowTo` | string | No | | | | `fillColor` | string | No | | | | `fillOpacity` | number | No | | | @@ -108,7 +112,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. | ### HideSeriesConfig @@ -116,7 +120,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -126,27 +130,27 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### LineConfig TODO docs -| Property | Type | Required | Default | Description | -|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `lineColor` | string | No | | | -| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | -| `lineWidth` | number | No | | | -| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| Property | Type | Required | Default | Description | +| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `lineColor` | string | No | | | +| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | +| `lineWidth` | number | No | | | +| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | ### LineStyle TODO docs | Property | Type | Required | Default | Description | -|----------|----------|----------|---------|--------------------------------------------------------| +| -------- | -------- | -------- | ------- | ------------------------------------------------------ | | `dash` | number[] | No | | | | `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. | @@ -155,7 +159,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|---------------------------------------------------------------| +| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `pointColor` | string | No | | | | `pointSize` | number | No | | | | `pointSymbol` | string | No | | | @@ -166,7 +170,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|-----------------------------------|----------|---------|-------------| +| ---------- | --------------------------------- | -------- | ------- | ----------- | | `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs | ### StackingConfig @@ -174,7 +178,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------- | | `group` | string | No | | | | `mode` | string | No | | TODO docs
Possible values are: `none`, `normal`, `percent`. | @@ -183,17 +187,17 @@ TODO docs It extends [OptionsWithTimezones](#optionswithtimezones). | Property | Type | Required | Default | Description | -|------------|-----------------------------------------|----------|---------|------------------------------------------------------------------| +| ---------- | --------------------------------------- | -------- | ------- | ---------------------------------------------------------------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | -| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* | +| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ | ### OptionsWithTimezones TODO docs | Property | Type | Required | Default | Description | -|------------|----------|----------|---------|-------------| +| ---------- | -------- | -------- | ------- | ----------- | | `timezone` | string[] | No | | | ### VizLegendOptions @@ -201,7 +205,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -217,8 +221,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/trend/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/trend/panelcfg/schema-reference.md index 2908dc13bf8..a71fc035bbb 100644 --- a/docs/sources/developers/kinds/composable/trend/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/trend/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TrendPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TrendPanelCfg #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|---------------------------------------|----------|---------|----------------------------------------------------------------------| +| ------------- | ------------------------------------- | -------- | ------- | -------------------------------------------------------------------- | | `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs | | `Options` | [object](#options) | **Yes** | | Identical to timeseries... except it does not have timezone settings | @@ -24,45 +28,45 @@ TODO docs It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig). -| Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*
TODO docs
Possible values are: `-1`, `0`, `1`. | -| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | -| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | -| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs | -| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | -| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*
TODO docs
Possible values are: `auto`, `never`, `always`. | -| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | -| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*
TODO docs | -| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | -| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | +| Property | Type | Required | Default | Description | +| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_
TODO docs
Possible values are: `-1`, `0`, `1`. | +| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | +| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | +| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs | +| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | +| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_
TODO docs
Possible values are: `auto`, `never`, `always`. | +| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_
TODO docs | +| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | +| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | ### AxisConfig TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -78,7 +82,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -88,7 +92,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------------|---------|----------|---------|----------------------------------------------------| +| ---------------- | ------- | -------- | ------- | -------------------------------------------------- | | `barAlignment` | integer | No | | TODO docs
Possible values are: `-1`, `0`, `1`. | | `barMaxWidth` | number | No | | | | `barWidthFactor` | number | No | | | @@ -98,7 +102,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|-------------| +| ------------- | ------ | -------- | ------- | ----------- | | `fillBelowTo` | string | No | | | | `fillColor` | string | No | | | | `fillOpacity` | number | No | | | @@ -108,7 +112,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. | ### HideSeriesConfig @@ -116,7 +120,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -126,27 +130,27 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### LineConfig TODO docs -| Property | Type | Required | Default | Description | -|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `lineColor` | string | No | | | -| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | -| `lineWidth` | number | No | | | -| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| Property | Type | Required | Default | Description | +| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `lineColor` | string | No | | | +| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | +| `lineWidth` | number | No | | | +| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | ### LineStyle TODO docs | Property | Type | Required | Default | Description | -|----------|----------|----------|---------|--------------------------------------------------------| +| -------- | -------- | -------- | ------- | ------------------------------------------------------ | | `dash` | number[] | No | | | | `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. | @@ -155,7 +159,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|---------------------------------------------------------------| +| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `pointColor` | string | No | | | | `pointSize` | number | No | | | | `pointSymbol` | string | No | | | @@ -166,7 +170,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|-----------------------------------|----------|---------|-------------| +| ---------- | --------------------------------- | -------- | ------- | ----------- | | `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs | ### StackingConfig @@ -174,7 +178,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------- | | `group` | string | No | | | | `mode` | string | No | | TODO docs
Possible values are: `none`, `normal`, `percent`. | @@ -183,7 +187,7 @@ TODO docs Identical to timeseries... except it does not have timezone settings | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------------------------------------------------| +| --------- | --------------------------------------- | -------- | ------- | ----------------------------------------------------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | | `xField` | string | No | | Name of the x field to use (defaults to first number) | @@ -193,7 +197,7 @@ Identical to timeseries... except it does not have timezone settings TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -209,8 +213,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/trendpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/trendpanelcfg/schema-reference.md index 2908dc13bf8..a71fc035bbb 100644 --- a/docs/sources/developers/kinds/composable/trendpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/trendpanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: TrendPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## TrendPanelCfg #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|---------------|---------------------------------------|----------|---------|----------------------------------------------------------------------| +| ------------- | ------------------------------------- | -------- | ------- | -------------------------------------------------------------------- | | `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs | | `Options` | [object](#options) | **Yes** | | Identical to timeseries... except it does not have timezone settings | @@ -24,45 +28,45 @@ TODO docs It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig). -| Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*
TODO docs
Possible values are: `-1`, `0`, `1`. | -| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* | -| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | -| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* | -| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | -| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*
TODO docs | -| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* | -| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | -| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*
TODO docs
Possible values are: `auto`, `never`, `always`. | -| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | -| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*
TODO docs | -| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | -| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | +| Property | Type | Required | Default | Description | +| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_
TODO docs
Possible values are: `-1`, `0`, `1`. | +| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ | +| `drawStyle` | string | No | | TODO docs
Possible values are: `line`, `bars`, `points`. | +| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ | +| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | +| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_
TODO docs | +| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ | +| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | +| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_
TODO docs
Possible values are: `auto`, `never`, `always`. | +| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_
TODO docs | +| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs | +| `transform` | string | No | | TODO docs
Possible values are: `constant`, `negative-Y`. | ### AxisConfig TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -78,7 +82,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -88,7 +92,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------------|---------|----------|---------|----------------------------------------------------| +| ---------------- | ------- | -------- | ------- | -------------------------------------------------- | | `barAlignment` | integer | No | | TODO docs
Possible values are: `-1`, `0`, `1`. | | `barMaxWidth` | number | No | | | | `barWidthFactor` | number | No | | | @@ -98,7 +102,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|-------------| +| ------------- | ------ | -------- | ------- | ----------- | | `fillBelowTo` | string | No | | | | `fillColor` | string | No | | | | `fillOpacity` | number | No | | | @@ -108,7 +112,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. | ### HideSeriesConfig @@ -116,7 +120,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -126,27 +130,27 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### LineConfig TODO docs -| Property | Type | Required | Default | Description | -|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `lineColor` | string | No | | | -| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | -| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | -| `lineWidth` | number | No | | | -| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | +| Property | Type | Required | Default | Description | +| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `lineColor` | string | No | | | +| `lineInterpolation` | string | No | | TODO docs
Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. | +| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs | +| `lineWidth` | number | No | | | +| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds | ### LineStyle TODO docs | Property | Type | Required | Default | Description | -|----------|----------|----------|---------|--------------------------------------------------------| +| -------- | -------- | -------- | ------- | ------------------------------------------------------ | | `dash` | number[] | No | | | | `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. | @@ -155,7 +159,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|---------------------------------------------------------------| +| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `pointColor` | string | No | | | | `pointSize` | number | No | | | | `pointSymbol` | string | No | | | @@ -166,7 +170,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|-----------------------------------|----------|---------|-------------| +| ---------- | --------------------------------- | -------- | ------- | ----------- | | `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs | ### StackingConfig @@ -174,7 +178,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------- | | `group` | string | No | | | | `mode` | string | No | | TODO docs
Possible values are: `none`, `normal`, `percent`. | @@ -183,7 +187,7 @@ TODO docs Identical to timeseries... except it does not have timezone settings | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------------------------------------------------| +| --------- | --------------------------------------- | -------- | ------- | ----------------------------------------------------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | | `xField` | string | No | | Name of the x field to use (defaults to first number) | @@ -193,7 +197,7 @@ Identical to timeseries... except it does not have timezone settings TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -209,8 +213,6 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | - - diff --git a/docs/sources/developers/kinds/composable/xychart/panelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/xychart/panelcfg/schema-reference.md index d07e2fdce7e..bc5e95bb527 100644 --- a/docs/sources/developers/kinds/composable/xychart/panelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/xychart/panelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: XYChartPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## XYChartPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------------------|--------------------------------|----------|---------|---------------------------------------------------------| +| --------------------- | ------------------------------ | -------- | ------- | ------------------------------------------------------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | | `ScatterSeriesConfig` | [object](#scatterseriesconfig) | **Yes** | | | @@ -27,16 +31,16 @@ title: XYChartPanelCfg kind It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axisconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| ------------------- | --------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | | | `label` | string | No | | TODO docs
Possible values are: `auto`, `never`, `always`. | | `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | | @@ -44,7 +48,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axiscon | `lineWidth` | integer | No | | Constraint: `>=0 & <=2147483647`. | | `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | | | `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | | `show` | string | No | | Possible values are: `points`, `lines`, `points+lines`. | ### AxisConfig @@ -52,7 +56,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axiscon TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -68,7 +72,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -78,14 +82,14 @@ TODO docs It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | string | No | | | ### BaseDimensionConfig | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------------------------------------| +| -------- | ------ | -------- | ------- | ----------------------------------------- | | `field` | string | No | | fixed: T -- will be added by each element | ### HideSeriesConfig @@ -93,7 +97,7 @@ It extends [BaseDimensionConfig](#basedimensionconfig). TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -103,7 +107,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### LineStyle @@ -111,7 +115,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|----------|----------|---------|--------------------------------------------------------| +| -------- | -------- | -------- | ------- | ------------------------------------------------------ | | `dash` | number[] | No | | | | `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. | @@ -120,10 +124,10 @@ TODO docs It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `max` | number | **Yes** | | | | `min` | number | **Yes** | | | -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | number | No | | | | `mode` | string | No | | Possible values are: `linear`, `quad`. | @@ -132,9 +136,9 @@ It extends [BaseDimensionConfig](#basedimensionconfig). It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `template`. | -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | string | No | | | ### Options @@ -142,11 +146,11 @@ It extends [BaseDimensionConfig](#basedimensionconfig). It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip). | Property | Type | Required | Default | Description | -|-----------------|-----------------------------------------------|----------|---------|----------------------------------------------------------------------------| +| --------------- | --------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- | | `dims` | [XYDimensionConfig](#xydimensionconfig) | **Yes** | | | -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | | `series` | [ScatterSeriesConfig](#scatterseriesconfig)[] | **Yes** | | | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `seriesMapping` | string | No | | Possible values are: `auto`, `manual`. | ### OptionsWithLegend @@ -154,7 +158,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -162,7 +166,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -178,7 +182,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -186,7 +190,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | @@ -195,35 +199,33 @@ TODO docs It extends [FieldConfig](#fieldconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisLabel` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisWidth` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs | -| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `label` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs
Possible values are: `auto`, `never`, `always`. | -| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs | -| `lineWidth` | integer | No | | *(Inherited from [FieldConfig](#fieldconfig))*
Constraint: `>=0 & <=2147483647`. | +| ------------------- | --------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs | +| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `label` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs
Possible values are: `auto`, `never`, `always`. | +| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs | +| `lineWidth` | integer | No | | _(Inherited from [FieldConfig](#fieldconfig))_
Constraint: `>=0 & <=2147483647`. | | `name` | string | No | | | -| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs | -| `show` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*
Possible values are: `points`, `lines`, `points+lines`. | +| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs | +| `show` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_
Possible values are: `points`, `lines`, `points+lines`. | | `x` | string | No | | | | `y` | string | No | | | ### XYDimensionConfig | Property | Type | Required | Default | Description | -|-----------|----------|----------|---------|-----------------------------------| +| --------- | -------- | -------- | ------- | --------------------------------- | | `frame` | integer | **Yes** | | Constraint: `>=0 & <=2147483647`. | | `exclude` | string[] | No | | | | `x` | string | No | | | - - diff --git a/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md index 6d2f3d1c945..93966a18114 100644 --- a/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md +++ b/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md @@ -1,20 +1,24 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: XYChartPanelCfg kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## XYChartPanelCfg #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 - - | Property | Type | Required | Default | Description | -|-----------------------|--------------------------------|----------|---------|---------------------------------------------------------| +| --------------------- | ------------------------------ | -------- | ------- | ------------------------------------------------------- | | `FieldConfig` | [object](#fieldconfig) | **Yes** | | | | `Options` | [object](#options) | **Yes** | | | | `ScatterSeriesConfig` | [object](#scatterseriesconfig) | **Yes** | | | @@ -27,17 +31,17 @@ title: XYChartPanelCfg kind It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axisconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | -| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* | +| ------------------- | --------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ | | `fillOpacity` | number | No | `0.5` | Constraint: `>=0 & <=1`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_
TODO docs | | `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | | | `label` | string | No | | TODO docs
Possible values are: `auto`, `never`, `always`. | | `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | | @@ -46,7 +50,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axiscon | `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | | | `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | | | `pointSymbol` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | Links to a resource (image/svg path) | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_
TODO docs | | `show` | string | No | | Possible values are: `points`, `lines`, `points+lines`. | ### AxisConfig @@ -54,7 +58,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axiscon TODO docs | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| +| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `axisCenteredZero` | boolean | No | | | | `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. | | `axisGridShow` | boolean | No | | | @@ -70,7 +74,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-------------------|--------|----------|---------|--------------------------------------------------------------------------| +| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `linearThreshold` | number | No | | | | `log` | number | No | | | @@ -80,14 +84,14 @@ TODO docs It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | string | No | | | ### BaseDimensionConfig | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------------------------------------| +| -------- | ------ | -------- | ------- | ----------------------------------------- | | `field` | string | No | | fixed: T -- will be added by each element | ### HideSeriesConfig @@ -95,7 +99,7 @@ It extends [BaseDimensionConfig](#basedimensionconfig). TODO docs | Property | Type | Required | Default | Description | -|-----------|---------|----------|---------|-------------| +| --------- | ------- | -------- | ------- | ----------- | | `legend` | boolean | **Yes** | | | | `tooltip` | boolean | **Yes** | | | | `viz` | boolean | **Yes** | | | @@ -105,7 +109,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|------------|---------------------------------------|----------|---------|-------------| +| ---------- | ------------------------------------- | -------- | ------- | ----------- | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs | ### LineStyle @@ -113,7 +117,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|----------|----------|---------|--------------------------------------------------------| +| -------- | -------- | -------- | ------- | ------------------------------------------------------ | | `dash` | number[] | No | | | | `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. | @@ -124,9 +128,9 @@ Links to a resource (image/svg path) It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `mapping`. | -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | string | No | | | ### ScaleDimensionConfig @@ -134,10 +138,10 @@ It extends [BaseDimensionConfig](#basedimensionconfig). It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `max` | number | **Yes** | | | | `min` | number | **Yes** | | | -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | number | No | | | | `mode` | string | No | | Possible values are: `linear`, `quad`. | @@ -146,9 +150,9 @@ It extends [BaseDimensionConfig](#basedimensionconfig). It extends [BaseDimensionConfig](#basedimensionconfig). | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `template`. | -| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*
fixed: T -- will be added by each element | +| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_
fixed: T -- will be added by each element | | `fixed` | string | No | | | ### Options @@ -156,11 +160,11 @@ It extends [BaseDimensionConfig](#basedimensionconfig). It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip). | Property | Type | Required | Default | Description | -|-----------------|-----------------------------------------------|----------|---------|----------------------------------------------------------------------------| +| --------------- | --------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- | | `dims` | [XYDimensionConfig](#xydimensionconfig) | **Yes** | | | -| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs | +| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_
TODO docs | | `series` | [ScatterSeriesConfig](#scatterseriesconfig)[] | **Yes** | | | -| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs | +| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_
TODO docs | | `seriesMapping` | string | No | | Possible values are: `auto`, `manual`. | ### OptionsWithLegend @@ -168,7 +172,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt TODO docs | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|-------------| +| -------- | ------------------------------------- | -------- | ------- | ----------- | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs | ### VizLegendOptions @@ -176,7 +180,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `calcs` | string[] | **Yes** | | | | `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. | | `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. | @@ -192,7 +196,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|-----------|-----------------------------------------|----------|---------|-------------| +| --------- | --------------------------------------- | -------- | ------- | ----------- | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs | ### VizTooltipOptions @@ -200,7 +204,7 @@ TODO docs TODO docs | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. | | `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. | @@ -209,37 +213,35 @@ TODO docs It extends [FieldConfig](#fieldconfig). | Property | Type | Required | Default | Description | -|---------------------|-----------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------| -| `axisCenteredZero` | boolean | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisColorMode` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs
Possible values are: `text`, `series`. | -| `axisGridShow` | boolean | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisLabel` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisPlacement` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | -| `axisSoftMax` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisSoftMin` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `axisWidth` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `fillOpacity` | number | No | `0.5` | *(Inherited from [FieldConfig](#fieldconfig))*
Constraint: `>=0 & <=1`. | -| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs | -| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `label` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs
Possible values are: `auto`, `never`, `always`. | -| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs | -| `lineWidth` | integer | No | | *(Inherited from [FieldConfig](#fieldconfig))*
Constraint: `>=0 & <=2147483647`. | +| ------------------- | --------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `axisCenteredZero` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisColorMode` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs
Possible values are: `text`, `series`. | +| `axisGridShow` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisLabel` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisPlacement` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | +| `axisSoftMax` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisSoftMin` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `axisWidth` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `fillOpacity` | number | No | `0.5` | _(Inherited from [FieldConfig](#fieldconfig))_
Constraint: `>=0 & <=1`. | +| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs | +| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `label` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs
Possible values are: `auto`, `never`, `always`. | +| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs | +| `lineWidth` | integer | No | | _(Inherited from [FieldConfig](#fieldconfig))_
Constraint: `>=0 & <=2147483647`. | | `name` | string | No | | | -| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* | -| `pointSymbol` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*
Links to a resource (image/svg path) | -| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*
TODO docs | -| `show` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*
Possible values are: `points`, `lines`, `points+lines`. | +| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ | +| `pointSymbol` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_
Links to a resource (image/svg path) | +| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_
TODO docs | +| `show` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_
Possible values are: `points`, `lines`, `points+lines`. | | `x` | string | No | | | | `y` | string | No | | | ### XYDimensionConfig | Property | Type | Required | Default | Description | -|-----------|----------|----------|---------|-----------------------------------| +| --------- | -------- | -------- | ------- | --------------------------------- | | `frame` | integer | **Yes** | | Constraint: `>=0 & <=2147483647`. | | `exclude` | string[] | No | | | | `x` | string | No | | | - - diff --git a/docs/sources/developers/kinds/core/_index.md b/docs/sources/developers/kinds/core/_index.md index 9e1eedc72aa..f791015d5b4 100644 --- a/docs/sources/developers/kinds/core/_index.md +++ b/docs/sources/developers/kinds/core/_index.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Core kinds weight: 200 --- diff --git a/docs/sources/developers/kinds/core/accesspolicy/schema-reference.md b/docs/sources/developers/kinds/core/accesspolicy/schema-reference.md index 2382ac5361c..c8a3f592682 100644 --- a/docs/sources/developers/kinds/core/accesspolicy/schema-reference.md +++ b/docs/sources/developers/kinds/core/accesspolicy/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: AccessPolicy kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## AccessPolicy #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 -Access rules for a scope+role. NOTE there is a unique constraint on role+scope +Access rules for a scope+role. NOTE there is a unique constraint on role+scope | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,20 +66,20 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|----------|-----------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------| +| -------- | --------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `role` | [RoleRef](#roleref) | **Yes** | | | -| `rules` | [AccessRule](#accessrule)[] | **Yes** | | The set of rules to apply. Note that * is required to modify
access policy rules, and that "none" will reject all actions | +| `rules` | [AccessRule](#accessrule)[] | **Yes** | | The set of rules to apply. Note that \* is required to modify
access policy rules, and that "none" will reject all actions | | `scope` | [ResourceRef](#resourceref) | **Yes** | | | ### AccessRule | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `kind` | string | **Yes** | | The kind this rule applies to (dashboars, alert, etc) | | `verb` | string | **Yes** | | READ, WRITE, CREATE, DELETE, ...
should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" | | `target` | string | No | | Specific sub-elements like "alert.rules" or "dashboard.permissions"???? | @@ -81,14 +87,14 @@ extraFields is reserved for any fields that are pulled from the API server metad ### ResourceRef | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `kind` | string | **Yes** | | | | `name` | string | **Yes** | | | ### RoleRef | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `kind` | string | **Yes** | | Policies can apply to roles, teams, or users
Applying policies to individual users is supported, but discouraged
Possible values are: `Role`, `BuiltinRole`, `Team`, `User`. | | `name` | string | **Yes** | | | | `xname` | string | **Yes** | | | @@ -96,7 +102,7 @@ extraFields is reserved for any fields that are pulled from the API server metad ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -105,12 +111,12 @@ extraFields is reserved for any fields that are pulled from the API server metad additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -121,6 +127,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/dashboard/schema-reference.md b/docs/sources/developers/kinds/core/dashboard/schema-reference.md index 8b3206a752e..48c110a40a3 100644 --- a/docs/sources/developers/kinds/core/dashboard/schema-reference.md +++ b/docs/sources/developers/kinds/core/dashboard/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: Dashboard kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## Dashboard #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 A Grafana dashboard. | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,26 +66,26 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|------------------------|---------------------------------------------|----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------------- | ------------------------------------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `editable` | boolean | **Yes** | `true` | Whether a dashboard is editable or not. | | `graphTooltip` | integer | **Yes** | `0` | 0 for no shared crosshair or tooltip (default).
1 for shared crosshair.
2 for shared crosshair AND shared tooltip.
Possible values are: `0`, `1`, `2`. | | `schemaVersion` | uint16 | **Yes** | `36` | Version of the JSON schema, incremented each time a Grafana update brings
changes to said schema. | | `style` | string | **Yes** | `dark` | Theme of dashboard.
Default value: dark.
Possible values are: `dark`, `light`. | | `annotations` | [AnnotationContainer](#annotationcontainer) | No | | Contains the list of annotations that are associated with the dashboard.
Annotations are used to overlay event markers and overlay event tags on graphs.
Grafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the HTTP API.
See https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/ | | `description` | string | No | | Description of dashboard. | -| `fiscalYearStartMonth` | integer | No | `0` | The month that the fiscal year starts on. 0 = January, 11 = December
Constraint: `>=0 & <12`. | +| `fiscalYearStartMonth` | integer | No | `0` | The month that the fiscal year starts on. 0 = January, 11 = December
Constraint: `>=0 & <12`. | | `gnetId` | string | No | | ID of a dashboard imported from the https://grafana.com/grafana/dashboards/ portal | | `id` | integer | No | | Unique numeric identifier for the dashboard.
`id` is internal to a specific Grafana instance. `uid` should be used to identify a dashboard across Grafana instances. | | `links` | [DashboardLink](#dashboardlink)[] | No | | Links with references to other dashboards or external websites. | | `liveNow` | boolean | No | | When set to true, the dashboard will redraw panels at an interval matching the pixel width.
This will keep data "moving left" regardless of the query refresh rate. This setting helps
avoid dashboards presenting stale live data | | `panels` | [object](#panels)[] | No | | List of dashboard panels | | `refresh` | | No | | Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". | -| `revision` | integer | No | | This property should only be used in dashboards defined by plugins. It is a quick check
to see if the version has changed since the last time. | +| `revision` | integer | No | | This property should only be used in dashboards defined by plugins. It is a quick check
to see if the version has changed since the last time. | | `snapshot` | [Snapshot](#snapshot) | No | | A dashboard snapshot shares an interactive dashboard publicly.
It is a read-only version of a dashboard, and is not editable.
It is possible to create a snapshot of a snapshot.
Grafana strips away all sensitive information from the dashboard.
Sensitive information stripped: queries (metric, template,annotation) and panel links. | | `tags` | string[] | No | | Tags associated with dashboard. | | `templating` | [object](#templating) | No | | Configured template variables | @@ -99,7 +105,7 @@ Grafana comes with a native annotation store and the ability to add annotation e See https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/ | Property | Type | Required | Default | Description | -|----------|---------------------------------------|----------|---------|---------------------| +| -------- | ------------------------------------- | -------- | ------- | ------------------- | | `list` | [AnnotationQuery](#annotationquery)[] | No | | List of annotations | ### AnnotationQuery @@ -108,7 +114,7 @@ TODO docs FROM: AnnotationQuery in grafana-data/src/types/annotations.ts | Property | Type | Required | Default | Description | -|--------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------ | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `datasource` | [DataSourceRef](#datasourceref) | **Yes** | | Ref to a DataSource instance | | `enable` | boolean | **Yes** | `true` | When enabled the annotation query is issued with every dashboard refresh | | `iconColor` | string | **Yes** | | Color to use for the annotation event markers | @@ -121,7 +127,7 @@ FROM: AnnotationQuery in grafana-data/src/types/annotations.ts ### AnnotationPanelFilter | Property | Type | Required | Default | Description | -|-----------|-----------|----------|---------|-----------------------------------------------------| +| --------- | --------- | -------- | ------- | --------------------------------------------------- | | `ids` | integer[] | **Yes** | | Panel IDs that should be included or excluded | | `exclude` | boolean | No | `false` | Should the specified panels be included or excluded | @@ -131,7 +137,7 @@ TODO: this should be a regular DataQuery that depends on the selected dashboard these match the properties of the "grafana" datasouce that is default in most dashboards | Property | Type | Required | Default | Description | -|------------|----------|----------|---------|-------------------------------------------------------------------------------------------------------------------| +| ---------- | -------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | `limit` | integer | **Yes** | | Only required/valid for the grafana datasource...
but code+tests is already depending on it so hard to change | | `matchAny` | boolean | **Yes** | | Only required/valid for the grafana datasource...
but code+tests is already depending on it so hard to change | | `tags` | string[] | **Yes** | | Only required/valid for the grafana datasource...
but code+tests is already depending on it so hard to change | @@ -142,7 +148,7 @@ these match the properties of the "grafana" datasouce that is default in most da Ref to a DataSource instance | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|------------------------------| +| -------- | ------ | -------- | ------- | ---------------------------- | | `type` | string | No | | The plugin type-id | | `uid` | string | No | | Specific datasource instance | @@ -151,7 +157,7 @@ Ref to a DataSource instance Links with references to other dashboards or external resources | Property | Type | Required | Default | Description | -|---------------|----------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `asDropdown` | boolean | **Yes** | `false` | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards | | `icon` | string | **Yes** | | Icon name to be displayed with the link | | `includeVars` | boolean | **Yes** | `false` | If true, includes current template variables values in the link as query params | @@ -172,7 +178,7 @@ Grafana strips away all sensitive information from the dashboard. Sensitive information stripped: queries (metric, template,annotation) and panel links. | Property | Type | Required | Default | Description | -|---------------|---------|----------|---------|--------------------------------------------------------------------------------| +| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------ | | `created` | string | **Yes** | | Time when the snapshot was created | | `expires` | string | **Yes** | | Time when the snapshot expires, default is never to expire | | `externalUrl` | string | **Yes** | | external url, if snapshot was shared in external grafana instance | @@ -188,7 +194,7 @@ Sensitive information stripped: queries (metric, template,annotation) and panel ### Panels | Property | Type | Required | Default | Description | -|----------|-----------------------------------------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | --------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [Panel](#panel), [RowPanel](#rowpanel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | | ### DataTransformerConfig @@ -198,7 +204,7 @@ Using transformations you can: rename fields, join time series data, perform mat use the output of one transformation as the input to another transformation, etc. | Property | Type | Required | Default | Description | -|------------|---------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | **Yes** | | Unique identifier of transformer | | `options` | | **Yes** | | Options to be passed to the transformer
Valid options depend on the transformer id | | `disabled` | boolean | No | | Disabled transformations are skipped | @@ -210,7 +216,7 @@ Matcher is a predicate configuration. Based on the config a set of field(s) or v It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. | Property | Type | Required | Default | Description | -|-----------|--------|----------|---------|--------------------------------------------------------------------------------| +| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------ | | `id` | string | **Yes** | `` | The matcher id. This is used to find the matcher implementation from registry. | | `options` | | No | | The matcher options. This is specific to the matcher implementation. | @@ -221,7 +227,7 @@ Each column within this structure is called a field. A field can represent a sin Field options allow you to change how the data is displayed in your visualizations. | Property | Type | Required | Default | Description | -|-------------|-----------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------- | --------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.
Each column within this structure is called a field. A field can represent a single time series or table column.
Field options allow you to change how the data is displayed in your visualizations. | | `overrides` | [object](#overrides)[] | **Yes** | | Overrides are the options applied to specific fields overriding the defaults. | @@ -232,20 +238,20 @@ Each column within this structure is called a field. A field can represent a sin Field options allow you to change how the data is displayed in your visualizations. | Property | Type | Required | Default | Description | -|---------------------|---------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `color` | [FieldColor](#fieldcolor) | No | | Map a field to a color. | | `custom` | [object](#custom) | No | | custom is specified by the FieldConfig field
in panel plugin schemas. | | `decimals` | number | No | | Specify the number of decimals Grafana includes in the rendered value.
If you leave this field blank, Grafana automatically truncates the number of decimals based on the value.
For example 1.1234 will display as 1.12 and 100.456 will display as 100.
To display all decimals, set the unit to `String`. | | `description` | string | No | | Human readable field metadata | | `displayNameFromDS` | string | No | | This can be used by data sources that return and explicit naming structure for values and labels
When this property is configured, this value is used rather than the default naming strategy. | -| `displayName` | string | No | | The display value for this field. This supports template variables blank is auto | +| `displayName` | string | No | | The display value for this field. This supports template variables blank is auto | | `filterable` | boolean | No | | True if data source field supports ad-hoc filters | | `links` | | No | | The behavior when clicking on a result | | `mappings` | [ValueMapping](#valuemapping)[] | No | | Convert input values into a display string | | `max` | number | No | | The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. | | `min` | number | No | | The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. | | `noValue` | string | No | | Alternative to empty string | -| `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,
This will default to `${frame.meta.path}/${field.name}

When defined, this value can be used as an identifier within the datasource scope, and
may be used to update the results | +| `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,
This will default to `${frame.meta.path}/${field.name}

When defined, this value can be used as an identifier within the datasource scope, and
may be used to update the results | | `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | Thresholds configuration for the panel | | `unit` | string | No | | Unit a field should use. The unit you select is applied to all fields except time.
You can use the units ID availables in Grafana or a custom unit.
Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts
As custom unit, you can use the following formats:
`suffix:` for custom unit that should go after value.
`prefix:` for custom unit that should go before value.
`time:` For custom date time formats type for example `time:YYYY-MM-DD`.
`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.
`count:` for a custom count unit.
`currency:` for custom a currency unit. | | `writeable` | boolean | No | | True if data source can write a value to the path. Auth/authz are supported separately | @@ -255,7 +261,7 @@ Field options allow you to change how the data is displayed in your visualizatio Map a field to a color. | Property | Type | Required | Default | Description | -|--------------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `mode` | string | **Yes** | | Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.
Continuous color interpolates a color using the percentage of a value relative to min and max.
Accepted values are:
`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold
`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations
`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations
`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode
`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode
`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode
`continuous-YlRd`: Continuous Yellow-Red palette mode
`continuous-BlPu`: Continuous Blue-Purple palette mode
`continuous-YlBl`: Continuous Yellow-Blue palette mode
`continuous-blues`: Continuous Blue palette mode
`continuous-reds`: Continuous Red palette mode
`continuous-greens`: Continuous Green palette mode
`continuous-purples`: Continuous Purple palette mode
`shades`: Shades of a single color. Specify a single color, useful in an override rule.
`fixed`: Fixed color mode. Specify a single color, useful in an override rule.
Possible values are: `thresholds`, `palette-classic`, `palette-classic-by-name`, `continuous-GrYlRd`, `continuous-RdYlGr`, `continuous-BlYlRd`, `continuous-YlRd`, `continuous-BlPu`, `continuous-YlBl`, `continuous-blues`, `continuous-reds`, `continuous-greens`, `continuous-purples`, `fixed`, `shades`. | | `fixedColor` | string | No | | The fixed color value for fixed or shades color modes. | | `seriesBy` | string | No | | Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.
Possible values are: `min`, `max`, `last`. | @@ -265,7 +271,7 @@ Map a field to a color. Thresholds configuration for the panel | Property | Type | Required | Default | Description | -|----------|---------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| -------- | ------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `mode` | string | **Yes** | | Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).
Possible values are: `absolute`, `percentage`. | | `steps` | [Threshold](#threshold)[] | **Yes** | | Must be sorted by 'value', first value is always -Infinity | @@ -275,7 +281,7 @@ User-defined value for a metric that triggers visual changes in a panel when thi They are used to conditionally style and color visualizations based on query results , and can be applied to most visualizations. | Property | Type | Required | Default | Description | -|----------|----------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| -------- | -------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `color` | string | **Yes** | | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. | | `value` | number or null | **Yes** | | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.
Nulls currently appear here when serializing -Infinity to JSON. | @@ -284,7 +290,7 @@ They are used to conditionally style and color visualizations based on query res Allow to transform the visual representation of specific data values in a visualization, irrespective of their original units | Property | Type | Required | Default | Description | -|----------|-------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | ----------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [ValueMap](#valuemap), [RangeMap](#rangemap), [RegexMap](#regexmap), [SpecialValueMap](#specialvaluemap). | | | ### RangeMap @@ -293,7 +299,7 @@ Maps numerical ranges to a display text and color. For example, if a value is within a certain range, you can configure a range value mapping to display Low or High rather than the number. | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-----------------------------------------------------------------------------------| +| --------- | ------------------ | -------- | ------- | --------------------------------------------------------------------------------- | | `options` | [object](#options) | **Yes** | | Range to match against and the result to apply when the value is within the range | | `type` | string | **Yes** | | | @@ -312,7 +318,7 @@ Range to match against and the result to apply when the value is within the rang Result used as replacement with text and color when the value matches | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|-----------------------------------------------------------------------| +| -------- | ------- | -------- | ------- | --------------------------------------------------------------------- | | `color` | string | No | | Text to use when the value matches | | `icon` | string | No | | Icon to display when the value matches. Only specific visualizations. | | `index` | integer | No | | Position in the mapping array. Only used internally. | @@ -324,7 +330,7 @@ Maps regular expressions to replacement text and a color. For example, if a value is www.example.com, you can configure a regex value mapping so that Grafana displays www and truncates the domain. | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|----------------------------------------------------------------------------------------------| +| --------- | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------- | | `options` | [object](#options) | **Yes** | | Regular expression to match against and the result to apply when the value matches the regex | | `type` | string | **Yes** | | | @@ -333,7 +339,7 @@ For example, if a value is www.example.com, you can configure a regex value mapp Regular expression to match against and the result to apply when the value matches the regex | Property | Type | Required | Default | Description | -|-----------|-------------------------------------------|----------|---------|-----------------------------------------------------------------------| +| --------- | ----------------------------------------- | -------- | ------- | --------------------------------------------------------------------- | | `pattern` | string | **Yes** | | Regular expression to match against | | `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | Result used as replacement with text and color when the value matches | @@ -344,14 +350,14 @@ See SpecialValueMatch to see the list of special values. For example, you can configure a special value mapping so that null values appear as N/A. | Property | Type | Required | Default | Description | -|-----------|--------------------|----------|---------|-------------| +| --------- | ------------------ | -------- | ------- | ----------- | | `options` | [object](#options) | **Yes** | | | | `type` | string | **Yes** | | | ### Options | Property | Type | Required | Default | Description | -|----------|-------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------| +| -------- | ----------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `match` | string | **Yes** | | Special value types supported by the `SpecialValueMap`
Possible values are: `true`, `false`, `null`, `nan`, `null+nan`, `empty`. | | `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | Result used as replacement with text and color when the value matches | @@ -361,7 +367,7 @@ Maps text values to a color or different display text and color. For example, you can configure a value mapping so that all instances of the value 10 appear as Perfection! rather than the number. | Property | Type | Required | Default | Description | -|-----------|------------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------| +| --------- | ---------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- | | `options` | map[string][ValueMappingResult](#valuemappingresult) | **Yes** | | Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } | | `type` | string | **Yes** | | | @@ -371,19 +377,19 @@ custom is specified by the FieldConfig field in panel plugin schemas. | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Overrides | Property | Type | Required | Default | Description | -|--------------|---------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------ | ------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `matcher` | [MatcherConfig](#matcherconfig) | **Yes** | | Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.
It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. | | `properties` | [DynamicConfigValue](#dynamicconfigvalue)[] | **Yes** | | | ### DynamicConfigValue | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------| +| -------- | ------ | -------- | ------- | ----------- | | `id` | string | **Yes** | `` | | | `value` | | No | | | @@ -393,7 +399,7 @@ Support for legacy graph panel. @deprecated this a deprecated panel type | Property | Type | Required | Default | Description | -|----------|-------------------|----------|---------|----------------------------------------------------| +| -------- | ----------------- | -------- | ------- | -------------------------------------------------- | | `type` | string | **Yes** | | Possible values are: `graph`. | | `legend` | [object](#legend) | No | | @deprecated this is part of deprecated graph panel | @@ -402,7 +408,7 @@ Support for legacy graph panel. @deprecated this is part of deprecated graph panel | Property | Type | Required | Default | Description | -|------------|---------|----------|---------|-------------| +| ---------- | ------- | -------- | ------- | ----------- | | `show` | boolean | **Yes** | `true` | | | `sortDesc` | boolean | No | | | | `sort` | string | No | | | @@ -412,7 +418,7 @@ Support for legacy graph panel. Position and dimensions of a panel in the grid | Property | Type | Required | Default | Description | -|----------|---------|----------|---------|-------------------------------------------------------------------------------------------------------------------| +| -------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | `h` | uint32 | **Yes** | `9` | Panel height. The height is the number of rows from the top edge of the panel. | | `w` | integer | **Yes** | `12` | Panel width. The width is the number of columns from the left edge of the panel.
Constraint: `>0 & <=24`. | | `x` | integer | **Yes** | `0` | Panel x. The x coordinate is the number of columns from the left edge of the grid
Constraint: `>=0 & <24`. | @@ -425,7 +431,7 @@ Support for legacy heatmap panel. @deprecated this a deprecated panel type | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------- | | `type` | string | **Yes** | | Possible values are: `heatmap`. | ### LibraryPanelRef @@ -435,7 +441,7 @@ When you make a change to a library panel, that change propagates to all instanc Library panels streamline reuse of panels across multiple dashboards. | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------| +| -------- | ------ | -------- | ------- | ------------------ | | `name` | string | **Yes** | | Library panel name | | `uid` | string | **Yes** | | Library panel uid | @@ -444,7 +450,7 @@ Library panels streamline reuse of panels across multiple dashboards. Dashboard panels are the basic visualization building blocks. | Property | Type | Required | Default | Description | -|-------------------|---------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------------- | ------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.
Each column within this structure is called a field. A field can represent a single time series or table column.
Field options allow you to change how the data is displayed in your visualizations. | | `options` | [object](#options) | **Yes** | | It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. | | `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | List of transformations that are applied to the panel data before rendering.
When there are multiple transformations, Grafana applies them in the order they are listed.
Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. | @@ -454,7 +460,7 @@ Dashboard panels are the basic visualization building blocks. | `description` | string | No | | Panel description. | | `gridPos` | [GridPos](#gridpos) | No | | Position and dimensions of a panel in the grid | | `id` | uint32 | No | | Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. | -| `interval` | string | No | | The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.
This value must be formatted as a number followed by a valid time
identifier like: "40s", "3d", etc.
See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options | +| `interval` | string | No | | The min time interval setting defines a lower limit for the $**interval and $**interval_ms variables.
This value must be formatted as a number followed by a valid time
identifier like: "40s", "3d", etc.
See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options | | `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | A library panel is a reusable panel that you can use in any dashboard.
When you make a change to a library panel, that change propagates to all instances of where the panel is used.
Library panels streamline reuse of panels across multiple dashboards. | | `links` | [DashboardLink](#dashboardlink)[] | No | | Panel links. | | `maxDataPoints` | number | No | | The maximum number of data points that the panel queries are retrieving. | @@ -475,7 +481,7 @@ Each column within this structure is called a field. A field can represent a sin Field options allow you to change how the data is displayed in your visualizations. | Property | Type | Required | Default | Description | -|-------------|-----------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------- | --------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.
Each column within this structure is called a field. A field can represent a single time series or table column.
Field options allow you to change how the data is displayed in your visualizations. | | `overrides` | [overrides](#overrides)[] | **Yes** | | Overrides are the options applied to specific fields overriding the defaults. | @@ -486,20 +492,20 @@ Each column within this structure is called a field. A field can represent a sin Field options allow you to change how the data is displayed in your visualizations. | Property | Type | Required | Default | Description | -|---------------------|---------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `color` | [FieldColor](#fieldcolor) | No | | Map a field to a color. | | `custom` | [custom](#custom) | No | | custom is specified by the FieldConfig field
in panel plugin schemas. | | `decimals` | number | No | | Specify the number of decimals Grafana includes in the rendered value.
If you leave this field blank, Grafana automatically truncates the number of decimals based on the value.
For example 1.1234 will display as 1.12 and 100.456 will display as 100.
To display all decimals, set the unit to `String`. | | `description` | string | No | | Human readable field metadata | | `displayNameFromDS` | string | No | | This can be used by data sources that return and explicit naming structure for values and labels
When this property is configured, this value is used rather than the default naming strategy. | -| `displayName` | string | No | | The display value for this field. This supports template variables blank is auto | +| `displayName` | string | No | | The display value for this field. This supports template variables blank is auto | | `filterable` | boolean | No | | True if data source field supports ad-hoc filters | | `links` | | No | | The behavior when clicking on a result | | `mappings` | [ValueMapping](#valuemapping)[] | No | | Convert input values into a display string | | `max` | number | No | | The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. | | `min` | number | No | | The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. | | `noValue` | string | No | | Alternative to empty string | -| `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,
This will default to `${frame.meta.path}/${field.name}

When defined, this value can be used as an identifier within the datasource scope, and
may be used to update the results | +| `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,
This will default to `${frame.meta.path}/${field.name}

When defined, this value can be used as an identifier within the datasource scope, and
may be used to update the results | | `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | Thresholds configuration for the panel | | `unit` | string | No | | Unit a field should use. The unit you select is applied to all fields except time.
You can use the units ID availables in Grafana or a custom unit.
Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts
As custom unit, you can use the following formats:
`suffix:` for custom unit that should go after value.
`prefix:` for custom unit that should go before value.
`time:` For custom date time formats type for example `time:YYYY-MM-DD`.
`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.
`count:` for a custom count unit.
`currency:` for custom a currency unit. | | `writeable` | boolean | No | | True if data source can write a value to the path. Auth/authz are supported separately | @@ -510,7 +516,7 @@ Maps numerical ranges to a display text and color. For example, if a value is within a certain range, you can configure a range value mapping to display Low or High rather than the number. | Property | Type | Required | Default | Description | -|-----------|---------------------|----------|---------|-----------------------------------------------------------------------------------| +| --------- | ------------------- | -------- | ------- | --------------------------------------------------------------------------------- | | `options` | [options](#options) | **Yes** | | Range to match against and the result to apply when the value is within the range | | `type` | string | **Yes** | | | @@ -520,7 +526,7 @@ Maps regular expressions to replacement text and a color. For example, if a value is www.example.com, you can configure a regex value mapping so that Grafana displays www and truncates the domain. | Property | Type | Required | Default | Description | -|-----------|---------------------|----------|---------|----------------------------------------------------------------------------------------------| +| --------- | ------------------- | -------- | ------- | -------------------------------------------------------------------------------------------- | | `options` | [options](#options) | **Yes** | | Regular expression to match against and the result to apply when the value matches the regex | | `type` | string | **Yes** | | | @@ -531,7 +537,7 @@ See SpecialValueMatch to see the list of special values. For example, you can configure a special value mapping so that null values appear as N/A. | Property | Type | Required | Default | Description | -|-----------|---------------------|----------|---------|-------------| +| --------- | ------------------- | -------- | ------- | ----------- | | `options` | [options](#options) | **Yes** | | | | `type` | string | **Yes** | | | @@ -546,21 +552,21 @@ When working directly from CUE, importers can extend this type directly to achieve the same effect. | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Options It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### RowPanel Row panel | Property | Type | Required | Default | Description | -|--------------|---------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------ | ------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `collapsed` | boolean | **Yes** | `false` | Whether this row should be collapsed or not. | | `id` | uint32 | **Yes** | | Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. | | `panels` | [panels](#panels)[] | **Yes** | | List of panels in the row | @@ -573,7 +579,7 @@ Row panel ### Panels | Property | Type | Required | Default | Description | -|----------|------------------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | ---------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [Panel](#panel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | | ### GraphPanel @@ -582,7 +588,7 @@ Support for legacy graph panel. @deprecated this a deprecated panel type | Property | Type | Required | Default | Description | -|----------|-------------------|----------|---------|----------------------------------------------------| +| -------- | ----------------- | -------- | ------- | -------------------------------------------------- | | `type` | string | **Yes** | | Possible values are: `graph`. | | `legend` | [legend](#legend) | No | | @deprecated this is part of deprecated graph panel | @@ -591,7 +597,7 @@ Support for legacy graph panel. Dashboard panels are the basic visualization building blocks. | Property | Type | Required | Default | Description | -|-------------------|---------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------------- | ------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.
Each column within this structure is called a field. A field can represent a single time series or table column.
Field options allow you to change how the data is displayed in your visualizations. | | `options` | [options](#options) | **Yes** | | It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. | | `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | List of transformations that are applied to the panel data before rendering.
When there are multiple transformations, Grafana applies them in the order they are listed.
Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. | @@ -601,7 +607,7 @@ Dashboard panels are the basic visualization building blocks. | `description` | string | No | | Panel description. | | `gridPos` | [GridPos](#gridpos) | No | | Position and dimensions of a panel in the grid | | `id` | uint32 | No | | Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. | -| `interval` | string | No | | The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.
This value must be formatted as a number followed by a valid time
identifier like: "40s", "3d", etc.
See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options | +| `interval` | string | No | | The min time interval setting defines a lower limit for the $**interval and $**interval_ms variables.
This value must be formatted as a number followed by a valid time
identifier like: "40s", "3d", etc.
See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options | | `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | A library panel is a reusable panel that you can use in any dashboard.
When you make a change to a library panel, that change propagates to all instances of where the panel is used.
Library panels streamline reuse of panels across multiple dashboards. | | `links` | [DashboardLink](#dashboardlink)[] | No | | Panel links. | | `maxDataPoints` | number | No | | The maximum number of data points that the panel queries are retrieving. | @@ -620,7 +626,7 @@ Dashboard panels are the basic visualization building blocks. Configured template variables | Property | Type | Required | Default | Description | -|----------|-----------------------------------|----------|---------|----------------------------------------------------------------------------------------------| +| -------- | --------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------- | | `list` | [VariableModel](#variablemodel)[] | No | | List of configured template variables with their saved values along with some other metadata | ### VariableModel @@ -628,12 +634,12 @@ Configured template variables A variable is a placeholder for a value. You can use variables in metric queries and in panel titles. | Property | Type | Required | Default | Description | -|---------------|-------------------------------------|----------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------- | ----------------------------------- | -------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `hide` | integer | **Yes** | | Determine if the variable shows on dashboard
Accepted values are 0 (show label and value), 1 (show value only), 2 (show nothing).
Possible values are: `0`, `1`, `2`. | | `id` | string | **Yes** | `00000000-0000-0000-0000-000000000000` | Unique numeric identifier for the variable. | | `name` | string | **Yes** | | Name of variable | | `skipUrlSync` | boolean | **Yes** | `false` | Whether the variable value should be managed by URL query params or not | -| `type` | string | **Yes** | | Dashboard variable type
`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.
`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).
`constant`: Define a hidden constant.
`datasource`: Quickly change the data source for an entire dashboard.
`interval`: Interval variables represent time spans.
`textbox`: Display a free text input field with an optional default value.
`custom`: Define the variable options manually using a comma-separated list.
`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables
Possible values are: `query`, `adhoc`, `constant`, `datasource`, `interval`, `textbox`, `custom`, `system`. | +| `type` | string | **Yes** | | Dashboard variable type
`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.
`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).
`constant`: Define a hidden constant.
`datasource`: Quickly change the data source for an entire dashboard.
`interval`: Interval variables represent time spans.
`textbox`: Display a free text input field with an optional default value.
`custom`: Define the variable options manually using a comma-separated list.
`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables
Possible values are: `query`, `adhoc`, `constant`, `datasource`, `interval`, `textbox`, `custom`, `system`. | | `allFormat` | string | No | | Format to use while fetching all values from data source, eg: wildcard, glob, regex, pipe, etc. | | `current` | [VariableOption](#variableoption) | No | | Option to be selected in a variable. | | `datasource` | [DataSourceRef](#datasourceref) | No | | Ref to a DataSource instance | @@ -649,7 +655,7 @@ A variable is a placeholder for a value. You can use variables in metric queries Option to be selected in a variable. | Property | Type | Required | Default | Description | -|------------|---------|----------|---------|---------------------------------------| +| ---------- | ------- | -------- | ------- | ------------------------------------- | | `text` | | **Yes** | | Text to be displayed for the option | | `value` | | **Yes** | | Value of the option | | `selected` | boolean | No | | Whether the option is selected or not | @@ -660,7 +666,7 @@ Time range for dashboard. Accepted values are relative time strings like {from: 'now-6h', to: 'now'} or absolute time strings like {from: '2020-07-10T08:00:00.000Z', to: '2020-07-10T14:00:00.000Z'}. | Property | Type | Required | Default | Description | -|----------|--------|----------|----------|-------------| +| -------- | ------ | -------- | -------- | ----------- | | `from` | string | **Yes** | `now-6h` | | | `to` | string | **Yes** | `now` | | @@ -669,7 +675,7 @@ Accepted values are relative time strings like {from: 'now-6h', to: 'now'} or ab Configuration of the time picker shown at the top of a dashboard. | Property | Type | Required | Default | Description | -|---------------------|----------|----------|---------------------------------------|---------------------------------------------------------------------------------------------------| +| ------------------- | -------- | -------- | ------------------------------------- | ------------------------------------------------------------------------------------------------- | | `collapse` | boolean | **Yes** | `false` | Whether timepicker is collapsed or not. Has no effect on provisioned dashboard. | | `enable` | boolean | **Yes** | `true` | Whether timepicker is enabled or not. Has no effect on provisioned dashboard. | | `hidden` | boolean | **Yes** | `false` | Whether timepicker is visible or not. | @@ -679,7 +685,7 @@ Configuration of the time picker shown at the top of a dashboard. ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -688,12 +694,12 @@ Configuration of the time picker shown at the top of a dashboard. additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -704,6 +710,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/folder/schema-reference.md b/docs/sources/developers/kinds/core/folder/schema-reference.md index 6e86269e7e5..505fad84e79 100644 --- a/docs/sources/developers/kinds/core/folder/schema-reference.md +++ b/docs/sources/developers/kinds/core/folder/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: Folder kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## Folder #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 A folder is a collection of resources that are grouped together and can share permissions. | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | TODO:
common metadata will soon support setting the parent folder in the metadata | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,7 +66,7 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec @@ -68,7 +74,7 @@ TODO: common metadata will soon support setting the parent folder in the metadata | Property | Type | Required | Default | Description | -|---------------|--------|----------|---------|--------------------------------------| +| ------------- | ------ | -------- | ------- | ------------------------------------ | | `title` | string | **Yes** | | Folder title | | `uid` | string | **Yes** | | Unique folder id. (will be k8s name) | | `description` | string | No | | Description of the folder. | @@ -76,7 +82,7 @@ common metadata will soon support setting the parent folder in the metadata ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -85,12 +91,12 @@ common metadata will soon support setting the parent folder in the metadata additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -101,6 +107,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/librarypanel/schema-reference.md b/docs/sources/developers/kinds/core/librarypanel/schema-reference.md index 745566894f5..3c8c10447d4 100644 --- a/docs/sources/developers/kinds/core/librarypanel/schema-reference.md +++ b/docs/sources/developers/kinds/core/librarypanel/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: LibraryPanel kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## LibraryPanel #### Maturity: [experimental](../../../maturity/#experimental) + #### Version: 0.0 A standalone panel | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|-----------------|-------------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `model` | [object](#model) | **Yes** | | TODO: should be the same panel schema defined in dashboard
Typescript: Omit; | | `name` | string | **Yes** | | Panel name (also saved in the model)
Constraint: `length >=1`. | | `type` | string | **Yes** | | The panel type (from inside the model)
Constraint: `length >=1`. | @@ -79,7 +85,7 @@ extraFields is reserved for any fields that are pulled from the API server metad ### LibraryElementDTOMeta | Property | Type | Required | Default | Description | -|-----------------------|---------------------------------------------------------|----------|---------|-------------| +| --------------------- | ------------------------------------------------------- | -------- | ------- | ----------- | | `connectedDashboards` | integer | **Yes** | | | | `createdBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | | | | `created` | string | **Yes** | | | @@ -91,7 +97,7 @@ extraFields is reserved for any fields that are pulled from the API server metad ### LibraryElementDTOMetaUser | Property | Type | Required | Default | Description | -|-------------|---------|----------|---------|-------------| +| ----------- | ------- | -------- | ------- | ----------- | | `avatarUrl` | string | **Yes** | | | | `id` | integer | **Yes** | | | | `name` | string | **Yes** | | | @@ -102,12 +108,12 @@ TODO: should be the same panel schema defined in dashboard Typescript: Omit; | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -116,12 +122,12 @@ Typescript: Omit; additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -132,6 +138,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/playlist/schema-reference.md b/docs/sources/developers/kinds/core/playlist/schema-reference.md index 97e063b3f30..264d88b90fd 100644 --- a/docs/sources/developers/kinds/core/playlist/schema-reference.md +++ b/docs/sources/developers/kinds/core/playlist/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: Playlist kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## Playlist #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 A playlist is a series of dashboards that is automatically rotated in the browser, on a configurable interval. | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|------------|---------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `interval` | string | **Yes** | `5m` | Interval sets the time between switching views in a playlist.
FIXME: Is this based on a standardized format or what options are available? Can datemath be used? | | `name` | string | **Yes** | | Name of the playlist. | | `uid` | string | **Yes** | | Unique playlist identifier. Generated on creation, either by the
creator of the playlist of by the application. | @@ -74,7 +80,7 @@ extraFields is reserved for any fields that are pulled from the API server metad ### PlaylistItem | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| -------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | string | **Yes** | | Type of the item.
Possible values are: `dashboard_by_uid`, `dashboard_by_id`, `dashboard_by_tag`. | | `value` | string | **Yes** | | Value depends on type and describes the playlist item.

- dashboard_by_id: The value is an internal numerical identifier set by Grafana. This
is not portable as the numerical identifier is non-deterministic between different instances.
Will be replaced by dashboard_by_uid in the future. (deprecated)
- dashboard_by_tag: The value is a tag which is set on any number of dashboards. All
dashboards behind the tag will be added to the playlist.
- dashboard_by_uid: The value is the dashboard UID | | `title` | string | No | | Title is an unused property -- it will be removed in the future | @@ -82,7 +88,7 @@ extraFields is reserved for any fields that are pulled from the API server metad ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -91,12 +97,12 @@ extraFields is reserved for any fields that are pulled from the API server metad additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -107,6 +113,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/preferences/schema-reference.md b/docs/sources/developers/kinds/core/preferences/schema-reference.md index 3f77550e276..c637880e3db 100644 --- a/docs/sources/developers/kinds/core/preferences/schema-reference.md +++ b/docs/sources/developers/kinds/core/preferences/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: Preferences kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## Preferences #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 The user or team frontend preferences | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|--------------------|---------------------------------------------------|----------|---------|---------------------------------------------------------------------------------| +| ------------------ | ------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------- | | `homeDashboardUID` | string | No | | UID for the home dashboard | | `language` | string | No | | Selected language (beta) | | `queryHistory` | [QueryHistoryPreference](#queryhistorypreference) | No | | | @@ -76,13 +82,13 @@ extraFields is reserved for any fields that are pulled from the API server metad ### QueryHistoryPreference | Property | Type | Required | Default | Description | -|-----------|--------|----------|---------|---------------------------------------------| +| --------- | ------ | -------- | ------- | ------------------------------------------- | | `homeTab` | string | No | | one of: '' | 'query' | 'starred'; | ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -91,12 +97,12 @@ extraFields is reserved for any fields that are pulled from the API server metad additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -107,6 +113,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/publicdashboard/schema-reference.md b/docs/sources/developers/kinds/core/publicdashboard/schema-reference.md index 2b23cbc5e87..7bfb01769a8 100644 --- a/docs/sources/developers/kinds/core/publicdashboard/schema-reference.md +++ b/docs/sources/developers/kinds/core/publicdashboard/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: PublicDashboard kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## PublicDashboard #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 Public dashboard configuration | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|------------------------|---------|----------|---------|-----------------------------------------------------------------| +| ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------- | | `annotationsEnabled` | boolean | **Yes** | | Flag that indicates if annotations are enabled | | `dashboardUid` | string | **Yes** | | Dashboard unique identifier referenced by this public dashboard | | `isEnabled` | boolean | **Yes** | | Flag that indicates if the public dashboard is enabled | @@ -76,7 +82,7 @@ extraFields is reserved for any fields that are pulled from the API server metad ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -85,12 +91,12 @@ extraFields is reserved for any fields that are pulled from the API server metad additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -101,6 +107,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/role/schema-reference.md b/docs/sources/developers/kinds/core/role/schema-reference.md index d37932fa9af..d3f7852d200 100644 --- a/docs/sources/developers/kinds/core/role/schema-reference.md +++ b/docs/sources/developers/kinds/core/role/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: Role kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## Role #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 Roles represent a set of users+teams that should share similar access | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|---------------|---------|----------|---------|-----------------------------------------------------------| +| ------------- | ------- | -------- | ------- | --------------------------------------------------------- | | `hidden` | boolean | **Yes** | | Do not show this role | | `name` | string | **Yes** | | The role identifier `managed:builtins:editor:permissions` | | `description` | string | No | | Role description | @@ -75,7 +81,7 @@ extraFields is reserved for any fields that are pulled from the API server metad ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -84,12 +90,12 @@ extraFields is reserved for any fields that are pulled from the API server metad additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -100,6 +106,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/rolebinding/schema-reference.md b/docs/sources/developers/kinds/core/rolebinding/schema-reference.md index 9e99fa9eba6..37137e35142 100644 --- a/docs/sources/developers/kinds/core/rolebinding/schema-reference.md +++ b/docs/sources/developers/kinds/core/rolebinding/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: RoleBinding kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## RoleBinding #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 Role bindings links a user|team to a configured role | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,19 +66,19 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|-----------|-------------------------------------------|----------|---------|----------------------------| +| --------- | ----------------------------------------- | -------- | ------- | -------------------------- | | `role` | [object](#role) | **Yes** | | The role we are discussing | | `subject` | [RoleBindingSubject](#rolebindingsubject) | **Yes** | | | ### RoleBindingSubject | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------ | | `kind` | string | **Yes** | | Possible values are: `Team`, `User`. | | `name` | string | **Yes** | | The team/user identifier name | @@ -81,27 +87,27 @@ extraFields is reserved for any fields that are pulled from the API server metad The role we are discussing | Property | Type | Required | Default | Description | -|----------|-----------------------------------------------------------------------------------------|----------|---------|-------------| +| -------- | --------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | `object` | Possible types are: [BuiltinRoleRef](#builtinroleref), [CustomRoleRef](#customroleref). | | | ### BuiltinRoleRef | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|---------------------------------------------------| +| -------- | ------ | -------- | ------- | ------------------------------------------------- | | `kind` | string | **Yes** | | Possible values are: `BuiltinRole`. | | `name` | string | **Yes** | | Possible values are: `viewer`, `editor`, `admin`. | ### CustomRoleRef | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|------------------------------| +| -------- | ------ | -------- | ------- | ---------------------------- | | `kind` | string | **Yes** | | Possible values are: `Role`. | | `name` | string | **Yes** | | | ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -110,12 +116,12 @@ The role we are discussing additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -126,6 +132,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/serviceaccount/schema-reference.md b/docs/sources/developers/kinds/core/serviceaccount/schema-reference.md index 8faa4626bf9..4c609ec6bba 100644 --- a/docs/sources/developers/kinds/core/serviceaccount/schema-reference.md +++ b/docs/sources/developers/kinds/core/serviceaccount/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: ServiceAccount kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## ServiceAccount #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 system account | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|-----------------|--------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| --------------- | ------------------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `avatarUrl` | string | **Yes** | | AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front
of the service account. | | `id` | integer | **Yes** | | ID is the unique identifier of the service account in the database. | | `isDisabled` | boolean | **Yes** | | IsDisabled indicates if the service account is disabled. | @@ -80,7 +86,7 @@ extraFields is reserved for any fields that are pulled from the API server metad ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -89,12 +95,12 @@ extraFields is reserved for any fields that are pulled from the API server metad additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -105,6 +111,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/core/team/schema-reference.md b/docs/sources/developers/kinds/core/team/schema-reference.md index d3db608266d..c2836611182 100644 --- a/docs/sources/developers/kinds/core/team/schema-reference.md +++ b/docs/sources/developers/kinds/core/team/schema-reference.md @@ -1,20 +1,26 @@ --- keywords: - - grafana - - schema +- grafana +- schema +labels: + products: + - enterprise + - oss title: Team kind --- + > Both documentation generation and kinds schemas are in active development and subject to change without prior notice. ## Team #### Maturity: [merged](../../../maturity/#merged) + #### Version: 0.0 A team is a named grouping of Grafana users to which access control rules may be assigned. | Property | Type | Required | Default | Description | -|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
without external reference as using the CommonMetadata reference breaks thema codegen. | | `spec` | [object](#spec) | **Yes** | | | | `status` | [object](#status) | **Yes** | | | @@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. -It extends [_kubeObjectMetadata](#_kubeobjectmetadata). +It extends [\_kubeObjectMetadata](#_kubeobjectmetadata). | Property | Type | Required | Default | Description | -|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | string | **Yes** | | | -| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | -| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | -| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | +| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | | `updateTimestamp` | string | **Yes** | | | | `updatedBy` | string | **Yes** | | | -| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* | +| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ | -### _kubeObjectMetadata +### \_kubeObjectMetadata -_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. +\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field. It is not exhaustive and only includes fields which may be relevant to a kind's implementation, As it is also intended to be generic enough to function with any API Server. | Property | Type | Required | Default | Description | -|---------------------|-------------------|----------|---------|-------------| +| ------------------- | ----------------- | -------- | ------- | ----------- | | `creationTimestamp` | string | **Yes** | | | | `finalizers` | string[] | **Yes** | | | | `labels` | map[string]string | **Yes** | | | @@ -60,19 +66,19 @@ As it is also intended to be generic enough to function with any API Server. extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Spec | Property | Type | Required | Default | Description | -|----------|--------|----------|---------|--------------------| +| -------- | ------ | -------- | ------- | ------------------ | | `name` | string | **Yes** | | Name of the team. | | `email` | string | No | | Email of the team. | ### Status | Property | Type | Required | Default | Description | -|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use | | `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.
Any operator which consumes this kind SHOULD add its state evaluation information to this field. | @@ -81,12 +87,12 @@ extraFields is reserved for any fields that are pulled from the API server metad additionalFields is reserved for future use | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| +| -------- | ---- | -------- | ------- | ----------- | ### Status.#OperatorState | Property | Type | Required | Default | Description | -|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated | | `state` | string | **Yes** | | state describes the state of the lastEvaluation.
It is limited to three possible states for machine evaluation.
Possible values are: `success`, `in_progress`, `failed`. | | `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format | @@ -97,6 +103,4 @@ additionalFields is reserved for future use details contains any extra information that is operator-specific | Property | Type | Required | Default | Description | -|----------|------|----------|---------|-------------| - - +| -------- | ---- | -------- | ------- | ----------- | diff --git a/docs/sources/developers/kinds/maturity.md b/docs/sources/developers/kinds/maturity.md index 17c2a00d0cd..e9a6264f2f0 100644 --- a/docs/sources/developers/kinds/maturity.md +++ b/docs/sources/developers/kinds/maturity.md @@ -3,6 +3,10 @@ keywords: - grafana - schema - maturity +labels: + products: + - enterprise + - oss title: Grafana Kinds - From Zero to Maturity weight: 300 --- @@ -11,50 +15,50 @@ weight: 300 > Grafana’s schema, Kind, and related codegen systems are under intense development. -Fear of unknown impacts leads to defensive coding, slow PRs, circular arguments, and an overall hesitance to engage. -That friction alone is sufficient to sink a large-scale project. This guide seeks to counteract this friction by +Fear of unknown impacts leads to defensive coding, slow PRs, circular arguments, and an overall hesitance to engage. +That friction alone is sufficient to sink a large-scale project. This guide seeks to counteract this friction by defining an end goal for all schemas: “mature.” This is the word we’re using to refer to the commonsense notion of “this software reached 1.0.” In general, 1.0/mature suggests: “we’ve thought about this thing, done the necessary experimenting, know what it is, and -feel confident about presenting it to the world.” In the context of schemas intended to act as a single source of truth +feel confident about presenting it to the world.” In the context of schemas intended to act as a single source of truth driving many use cases, we can intuitively phrase maturity as: -- The schema follows general best practices (e.g. good comments, follows field type rules), and the team owning the -schema believes that the fields described in the schema are accurate. -- Automation propagates the schema as source of truth to every relevant -[domain](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.67pop2k2f8fq) -(for example: types in frontend, backend, as-code; plugins SDK; docs; APIs and storage; search indexing) +- The schema follows general best practices (e.g. good comments, follows field type rules), and the team owning the + schema believes that the fields described in the schema are accurate. +- Automation propagates the schema as source of truth to every relevant + [domain](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.67pop2k2f8fq) + (for example: types in frontend, backend, as-code; plugins SDK; docs; APIs and storage; search indexing) -This intuitive definition gets us pointed in the right direction. But we can’t just jump straight there - we have to +This intuitive definition gets us pointed in the right direction. But we can’t just jump straight there - we have to approach it methodically. To that end, this doc outlines four (ok five, but really, four) basic maturity milestones that we expect Kinds and their schemas to progress through: -- *(Planned - Put a Kind name on the official TODO list)* +- _(Planned - Put a Kind name on the official TODO list)_ - **Merged** - Get an initial schema written down. Not final. Not perfect. - **Experimental** - Kind schemas are the source of truth for basic working code. - **Stable** - Kind schemas are the source of truth for all target domains. - **Mature** - The operational transition path for the Kind is battle-tested and reliable. -These milestones have functional definitions, tied to code and enforced in CI. A Kind having reached a particular -milestone corresponds to properties of the code that are enforced in CI; advancing to the next milestone likely has a +These milestones have functional definitions, tied to code and enforced in CI. A Kind having reached a particular +milestone corresponds to properties of the code that are enforced in CI; advancing to the next milestone likely has a direct impact on code generation and runtime behavior. -Finally, the above definitions imply that maturity for *individual Kinds/schemas* depends on *the Kind system* being -mature, as well. This is by design: **Grafana Labs does not intend to publicize any single schema as mature until +Finally, the above definitions imply that maturity for _individual Kinds/schemas_ depends on _the Kind system_ being +mature, as well. This is by design: **Grafana Labs does not intend to publicize any single schema as mature until [certain schema system milestones are met](https://github.com/orgs/grafana/projects/133/views/8).** ## Schema Maturity Milestones Maturity milestones are a linear progression. Each milestone implies that the conditions of its predecessors continue to -be met. +be met. Reaching a particular milestone implies that the properties of all prior milestones are still met. ### (Milestone 0 - Planned) {#planned} | **Goal** | Put a Kind name on the official TODO list: [Kind Schematization Progress Tracker](https://docs.google.com/spreadsheets/d/1DL6nZHyX42X013QraWYbKsMmHozLrtXDj8teLKvwYMY/edit#gid=0) | -|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Reached when** | The planned Kind is listed in the relevant sheet of the progress tracker with a link to track / be able to see when exactly it is planned and who is responsible for doing it | | **Common hurdles** | Existing definitions may not correspond clearly to an object boundary - e.g. playlists are currently in denormalized SQL tables playlist and playlist_item | | **Public-facing guarantees** | None | @@ -63,7 +67,7 @@ Reaching a particular milestone implies that the properties of all prior milesto ### Milestone 1 - Merged {#merged} | **Goal** | Get an initial schema written down. Not final. Not perfect. | -|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Reached when** | A PR introducing the initial version of a schema has been merged. | | **Common hurdles** | Getting comfortable with Thema and CUE
Figuring out where all the existing definitions of the Kind are
Knowing whether it’s safe to omit possibly-crufty fields from the existing definitions when writing the schema | | **Public-facing guarantees** | None | @@ -72,51 +76,51 @@ Reaching a particular milestone implies that the properties of all prior milesto ### Milestone 2 - Experimental {#experimental} | **Goal** | Schemas are the source of truth for basic working code. | -|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Reached when** | Go and TypeScript types generated from schema are used in all relevant production code, having replaced handwritten type definitions (if any). | | **Common hurdles** | Compromises on field definitions that seemed fine to reach “committed” start to feel unacceptable
Ergonomics of generated code may start to bite
Aligning with the look and feel of related schemas | | **Public-facing guarantees** | Kinds are available for as-code usage in [grok](https://github.com/grafana/grok), and in tools downstream of grok, following all of grok’s standard patterns. | | **Stage comms** | Internal users:- Start using the schema and give feedback internally to help move to the next stage.External users:- Align with the [experimental](https://docs.google.com/document/d/1lqp0hALax2PT7jSObsX52EbQmIDFnLFMqIbBrJ4EYCE/edit#heading=h.ehl5iy7pcjvq) stage in the release definition document.  - Experimental schemas will be discoverable, and from a customer PoV should never be used in production, but they can be explored and we are more than happy to receive feedback | - ## Schema-writing guidelines ### Avoid anonymous nested structs -***Always name your sub-objects.*** +**_Always name your sub-objects._** In CUE, nesting structs is like nesting objects in JSON, and just as easy: -~~~ json + +```json one: { two: { three: { } } -~~~ +``` While these can be accurately represented in other languages, they aren’t especially friendly to work with: -~~~ typescript +```typescript // TypeScript export interface One { two: { three: string; }; } -~~~ +``` -~~~ go +```go // Go type One struct { Two struct { Three string `json:"three"` } `json:"two"` } -~~~ +``` Instead, within your schema, prefer to make root-level definitions with the appropriate attributes: -~~~ cue +```cue // Cue one: { two: #Two @@ -124,9 +128,9 @@ one: { three: string } @cuetsy(kind="interface") } -~~~ +``` -~~~ Typescript +```Typescript // TypeScript export interface Two { three: string; @@ -134,9 +138,9 @@ export interface Two { export interface One { two: Two; } -~~~ +``` -~~~ Go +```Go // Go type One struct { Two Two `json:"two"` @@ -144,11 +148,11 @@ type One struct { type Two struct { Three string `json:"three"` } -~~~ +``` ### Use precise numeric types -***Use precise numeric types like `float64` or `uint32`. Never use `number`.*** +**_Use precise numeric types like `float64` or `uint32`. Never use `number`._** Never use `number` for a numeric type in a schema. @@ -160,7 +164,7 @@ like `uint32` or `int32`, unless the use case specifically requires a huge numer ### No explicit `null` -***Do not use `null` as a type in any schema.*** +**_Do not use `null` as a type in any schema._** This one is tricky to think about, and requires some background. @@ -169,9 +173,9 @@ This was problematic, because explicit `null` introduces an ambiguity: is a JSON with value null meaningfully different from the field being absent? That is, should a program behave differently if it encounters a null vs. an absent field? -In almost all cases, the answer is “no.” Thus, the ambiguity: if both explicit null and absence are *accepted* +In almost all cases, the answer is “no.” Thus, the ambiguity: if both explicit null and absence are _accepted_ by a system, it pushes responsibility onto anyone writing code in that system to decide, case-by-case, -whether the two are *intended to be meaningfully different*, and therefore whether behavior should be different. +whether the two are _intended to be meaningfully different_, and therefore whether behavior should be different. CUE does have a `null` type, and only accepts data containing `nulls` as valid if the schema explicitly allows a `null`. That means, by default, using CUE for schemas removes the possibility of ambiguity in code that receives data validated @@ -179,11 +183,12 @@ by those schemas, even if the language they’re writing in still allows for amb As a schema author, this means you’re being unambiguous by default - no `nulls`. That’s good! The only question is whether it’s worth explicitly allowing a `null` for some particular case: -~~~ Cue -someField: int32 | null -~~~ -The *only* time this *may* be a good idea is if your field needs to be able to represent a value +```Cue +someField: int32 | null +``` + +The _only_ time this _may_ be a good idea is if your field needs to be able to represent a value that is not otherwise acceptable within the value space - for example, if `someField` needs to be able to contain [Infinity](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/POSITIVE_INFINITY). When such values are serialized to null by default, it can be convenient to accept null in the schema - but even then, @@ -201,39 +206,40 @@ Schematization is an opportunity to get rid of this ambiguity. Fix the accidenta information as `nil`, when MySQL and SQLite save it as `{}`. If we found it in the rest of the cases, it isn't necessary to set `?` in the field in the schema. - ## Schema Attributes -Grafana’s schema system relies on [CUE attributes](https://cuelang.org/docs/references/spec/#attributes)declared on -properties within schemas to control some aspects of code generation behavior. +Grafana’s schema system relies on [CUE attributes](https://cuelang.org/docs/references/spec/#attributes)declared on +properties within schemas to control some aspects of code generation behavior. In a schema, an attribute is the whole of `@cuetsy(kind=”type”)`: -~~~ Cue +```Cue field: string @cuetsy(kind="type") -~~~ +``` -CUE attributes are purely informational - they cannot influence CUE evaluation behavior, including the types being +CUE attributes are purely informational - they cannot influence CUE evaluation behavior, including the types being expressed in a Thema schema. CUE attributes have three parts. In `@cuetsy(kind=”type”)`, those are: + - name - `@cuetsy` - arg - `kind` - argval - `“type”` -Any given attribute may consist of `{name}`, `{name,arg}`, or `{name,arg,argval}`. These three levels form a tree -(meaning of any argval is specific to its arg, which is specific to its name). The following documentation represents +Any given attribute may consist of `{name}`, `{name,arg}`, or `{name,arg,argval}`. These three levels form a tree +(meaning of any argval is specific to its arg, which is specific to its name). The following documentation represents this tree using a header hierarchy. ### @cuetsy -These attributes control the behavior of the [cuetsy code generator](https://github.com/grafana/cuetsy), which converts +These attributes control the behavior of the [cuetsy code generator](https://github.com/grafana/cuetsy), which converts CUE to TypeScript. We include only the kind arg here for brevity; cuetsy’s README has the canonical documentation on all supported args and argvals, and their intended usage. Notes: + - Only top-level fields in a Thema schema are scanned for `@cuetsy` attributes. -- Grafana’s code generators hardcode that an interface (`@cuetsy(kind=”interface”)`) is generated to represent the root -schema object, unless it is known to be a [grouped lineage](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.vx7stzpxtw4t). +- Grafana’s code generators hardcode that an interface (`@cuetsy(kind=”interface”)`) is generated to represent the root + schema object, unless it is known to be a [grouped lineage](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.vx7stzpxtw4t). #### kind @@ -259,21 +265,21 @@ in plugin code generators. #### TSVeneer Applying a TSVeneer arg to a field in a schema indicates that the schema author wants to enrich the generated type -(for example by adding generic type parameters), so code generation should expect a handwritten +(for example by adding generic type parameters), so code generation should expect a handwritten [veneer](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.bmtjq0bb1yxp). -TSVeneer requires at least one argval, each of which impacts TypeScript code generation in its own way. +TSVeneer requires at least one argval, each of which impacts TypeScript code generation in its own way. Multiple argvals may be given, separated by `|`. -A TSVeneer arg has no effect if it is applied to a field that is not exported as a standalone TypeScript type +A TSVeneer arg has no effect if it is applied to a field that is not exported as a standalone TypeScript type (which usually means a CUE field that also has an `@cuetsy(kind=)` attribute). #### type -A handwritten veneer is needed to refine the raw generated TypeScript type, for example by adding generics. -See [the dashboard types veneer](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/packages/grafana-schema/src/veneer/dashboard.types.ts) -for an example, and [some](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/kinds/dashboard/dashboard_kind.cue#L12) -[corresponding](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/kinds/dashboard/dashboard_kind.cue#L143) +A handwritten veneer is needed to refine the raw generated TypeScript type, for example by adding generics. +See [the dashboard types veneer](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/packages/grafana-schema/src/veneer/dashboard.types.ts) +for an example, and [some](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/kinds/dashboard/dashboard_kind.cue#L12) +[corresponding](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/kinds/dashboard/dashboard_kind.cue#L143) CUE attributes. ### @grafanamaturity @@ -286,7 +292,7 @@ Grafana code generators and CI enforce that schemas marked as mature MUST NOT ha Indicates that a non-expert on that schema wrote the field, and was not fully confident in its type and/or docs. -Primarily useful on very large schemas, like the dashboard schema, for getting *something* written down for a given +Primarily useful on very large schemas, like the dashboard schema, for getting _something_ written down for a given field that at least makes validation tests pass, but making clear that the field isn’t necessarily properly correct. No argval is accepted. (Use a `//` comment to say more about the attention that’s needed.) diff --git a/docs/sources/developers/plugins/_index.md b/docs/sources/developers/plugins/_index.md index 0ae1d2b88b1..da8ca364f61 100644 --- a/docs/sources/developers/plugins/_index.md +++ b/docs/sources/developers/plugins/_index.md @@ -1,9 +1,13 @@ --- -title: Grafana plugin developer's guide -menuTitle: Plugin developer's guide aliases: - ../plugins/developing/ description: Resources for creating Grafana plugins +labels: + products: + - enterprise + - oss +menuTitle: Plugin developer's guide +title: Grafana plugin developer's guide weight: 200 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/_index.md b/docs/sources/developers/plugins/create-a-grafana-plugin/_index.md index 19d026c60a8..0037016e608 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/_index.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/_index.md @@ -1,12 +1,16 @@ --- -title: Create a Grafana plugin -menuTitle: Create a plugin +description: An index of how-to topics for Grafana plugin development. keywords: - grafana - plugins - plugin - documentation -description: An index of how-to topics for Grafana plugin development. +labels: + products: + - enterprise + - oss +menuTitle: Create a plugin +title: Create a Grafana plugin weight: 300 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/_index.md b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/_index.md index 49797918462..929473edb18 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/_index.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/_index.md @@ -1,13 +1,17 @@ --- -title: Develop a Grafana plugin -menuTitle: Develop a plugin +description: An index of how-to topics for Grafana plugin development. keywords: - grafana - plugins - plugin - development - documentation -description: An index of how-to topics for Grafana plugin development. +labels: + products: + - enterprise + - oss +menuTitle: Develop a plugin +title: Develop a Grafana plugin weight: 100 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-data-source-backend-plugin.md b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-data-source-backend-plugin.md index 411678329e8..2f62c86d3d4 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-data-source-backend-plugin.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-data-source-backend-plugin.md @@ -1,7 +1,5 @@ --- -title: Build a data source backend plugin description: Create a backend for your data source plugin. -weight: 400 keywords: - grafana - plugins @@ -9,6 +7,12 @@ keywords: - backend - backend data source - datasource +labels: + products: + - enterprise + - oss +title: Build a data source backend plugin +weight: 400 --- ## Introduction diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-data-source-plugin.md b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-data-source-plugin.md index 0f6e0a2b839..6ca315a58fa 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-data-source-plugin.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-data-source-plugin.md @@ -1,13 +1,17 @@ --- -title: Build a data source plugin description: Create a plugin to add support for your own data sources. -weight: 300 keywords: - grafana - plugins - plugin - data source - datasource +labels: + products: + - enterprise + - oss +title: Build a data source plugin +weight: 300 --- ## Introduction diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-logs-data-source-plugin.md b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-logs-data-source-plugin.md index f1f607c2708..83cffac618a 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-logs-data-source-plugin.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-logs-data-source-plugin.md @@ -1,8 +1,7 @@ --- -title: Build a logs data source plugin -description: How to build a logs data source plugin. aliases: - ../../../plugins/build-a-logs-data-source-plugin/ +description: How to build a logs data source plugin. keywords: - grafana - plugins @@ -10,6 +9,11 @@ keywords: - logs - logs data source - datasource +labels: + products: + - enterprise + - oss +title: Build a logs data source plugin weight: 500 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-panel-plugin-with-d3.md b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-panel-plugin-with-d3.md index 8b8117617bd..6f0b7043a03 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-panel-plugin-with-d3.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-panel-plugin-with-d3.md @@ -1,7 +1,5 @@ --- -title: Build a panel plugin with D3.js description: how to use D3.js in your panel plugins. -weight: 200 keywords: - grafana - plugins @@ -10,6 +8,12 @@ keywords: - d3 - panel - panel plugin +labels: + products: + - enterprise + - oss +title: Build a panel plugin with D3.js +weight: 200 --- ## Introduction diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-panel-plugin.md b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-panel-plugin.md index b31c56deec8..ea67c1f7474 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-panel-plugin.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-panel-plugin.md @@ -1,7 +1,5 @@ --- -title: Build a panel plugin description: Learn how to create a custom visualization for your dashboards. -weight: 100 keywords: - grafana - plugins @@ -10,6 +8,12 @@ keywords: - custom visualization - dashboard - dashboards +labels: + products: + - enterprise + - oss +title: Build a panel plugin +weight: 100 --- ## Introduction diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-streaming-data-source-plugin.md b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-streaming-data-source-plugin.md index 8b1dca863c0..0a92b01f86c 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-streaming-data-source-plugin.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-a-streaming-data-source-plugin.md @@ -1,5 +1,4 @@ --- -title: Build a streaming data source plugin aliases: - ../../../plugins/build-a-streaming-data-source-plugin/ description: How to build a streaming data source plugin. @@ -10,6 +9,11 @@ keywords: - streaming - streaming data source - datasource +labels: + products: + - enterprise + - oss +title: Build a streaming data source plugin weight: 600 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-an-app-plugin.md b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-an-app-plugin.md index 2ebbd79d1da..7810250eb42 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-an-app-plugin.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/build-an-app-plugin.md @@ -1,7 +1,5 @@ --- -title: Build an app plugin description: Learn at how to create an app for Grafana. -weight: 700 draft: true keywords: - grafana @@ -9,6 +7,12 @@ keywords: - plugin - app - app plugin +labels: + products: + - enterprise + - oss +title: Build an app plugin +weight: 700 --- ## Introduction diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/working-with-data-frames.md b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/working-with-data-frames.md index 189068ccebf..92e3b1a30e2 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/working-with-data-frames.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/develop-a-plugin/working-with-data-frames.md @@ -1,5 +1,4 @@ --- -title: Work with data frames aliases: - ../../../plugins/working-with-data-frames/ description: How to work with data frames. @@ -9,6 +8,11 @@ keywords: - plugin - data frames - dataframes +labels: + products: + - enterprise + - oss +title: Work with data frames weight: 900 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/_index.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/_index.md index b918779dcf5..e175de6e3bf 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/_index.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/_index.md @@ -1,6 +1,5 @@ --- -title: Extend a Grafana plugin -menuTitle: Extend a plugin +description: An index of how-to topics for extending or enhancing Grafana plugins. keywords: - grafana - plugins @@ -8,7 +7,12 @@ keywords: - development - extension - documentation -description: An index of how-to topics for extending or enhancing Grafana plugins. +labels: + products: + - enterprise + - oss +menuTitle: Extend a plugin +title: Extend a Grafana plugin weight: 200 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-anonymous-usage-reporting.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-anonymous-usage-reporting.md index eef9f3b1694..235aeb91ae7 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-anonymous-usage-reporting.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-anonymous-usage-reporting.md @@ -1,14 +1,18 @@ --- -title: Add anonymous usage reporting aliases: - ../../../plugins/add-anonymous-usage-reporting/ +description: How to add anonymous usage tracking to your Grafana plugin. keywords: - grafana - plugins - plugin - anonymous usage - reporting -description: How to add anonymous usage tracking to your Grafana plugin. +labels: + products: + - enterprise + - oss +title: Add anonymous usage reporting weight: 200 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-authentication-for-data-source-plugins.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-authentication-for-data-source-plugins.md index 53af41fc973..0623edd20a1 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-authentication-for-data-source-plugins.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-authentication-for-data-source-plugins.md @@ -1,18 +1,20 @@ --- -title: Add authentication for data source plugins aliases: - - ../../../plugins/add-authentication-for-data-source-plugins/ + - ../../plugins/developing/auth-for-datasources/ + - /docs/grafana/next/developers/plugins/authentication/ description: How to add authentication for data source plugins. -keywords: +keywords: - grafana - plugins - plugin - authentication - data source - datasource -aliases: - - ../../plugins/developing/auth-for-datasources/ - - /docs/grafana/next/developers/plugins/authentication/ +labels: + products: + - enterprise + - oss +title: Add authentication for data source plugins weight: 300 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-distributed-tracing-for-backend-plugins.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-distributed-tracing-for-backend-plugins.md index 506fe3e8891..b0f11361481 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-distributed-tracing-for-backend-plugins.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-distributed-tracing-for-backend-plugins.md @@ -1,7 +1,7 @@ --- -title: Add distributed tracing for backend plugins aliases: - ../../../plugins/add-distributed-tracing-for-backend-plugins/ +description: How to add distributed tracing for backend plugins. keywords: - grafana - plugins @@ -10,7 +10,11 @@ keywords: - tracing - backend - back-end -description: How to add distributed tracing for backend plugins. +labels: + products: + - enterprise + - oss +title: Add distributed tracing for backend plugins weight: 350 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-query-editor-help.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-query-editor-help.md index a5bfe2f3dd0..7f7c219ab7a 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-query-editor-help.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-query-editor-help.md @@ -1,7 +1,7 @@ --- -title: Add query editor help aliases: - ../../../plugins/add-query-editor-help/ +description: How to add a help component to query editors in Grafana. keywords: - grafana - plugins @@ -9,7 +9,11 @@ keywords: - queries - query editor - query editor help -description: How to add a help component to query editors in Grafana. +labels: + products: + - enterprise + - oss +title: Add query editor help weight: 500 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-annotations.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-annotations.md index 85c6a24daa9..d0b7a1a3897 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-annotations.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-annotations.md @@ -1,6 +1,4 @@ --- -title: Enable annotations -menuTitle: Enable annotations aliases: - ../../../plugins/add-support-for-annotations/ description: Add support for annotations in your plugin. @@ -9,6 +7,12 @@ keywords: - plugins - plugin - annotations +labels: + products: + - enterprise + - oss +menuTitle: Enable annotations +title: Enable annotations weight: 100 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-explore-queries.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-explore-queries.md index a54e20e61f3..a945664be63 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-explore-queries.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-explore-queries.md @@ -1,5 +1,4 @@ --- -title: Add features to Explore queries aliases: - ../../../plugins/add-support-for-explore-queries/ description: Add features to Explore queries. @@ -10,6 +9,11 @@ keywords: - queries - explore queries - explore +labels: + products: + - enterprise + - oss +title: Add features to Explore queries weight: 400 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-variables.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-variables.md index 502052307ec..4eabf59e3f2 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-variables.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-variables.md @@ -1,5 +1,4 @@ --- -title: Add support for variables aliases: - ../../../plugins/add-support-for-variables/ description: Add support for variables. @@ -9,6 +8,11 @@ keywords: - plugin - queries - variables +labels: + products: + - enterprise + - oss +title: Add support for variables weight: 600 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/cross-plugin-linking.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/cross-plugin-linking.md index 5a71acff2e8..4b499d0cc01 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/cross-plugin-linking.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/cross-plugin-linking.md @@ -1,7 +1,7 @@ --- -title: Work with cross-plugin links aliases: - ../../../plugins/cross-plugin-linking/ +description: Learn how to add plugin links to a Grafana app plugin. keywords: - grafana - plugins @@ -10,7 +10,11 @@ keywords: - cross-plugin links - extensions - extensions api -description: Learn how to add plugin links to a Grafana app plugin. +labels: + products: + - enterprise + - oss +title: Work with cross-plugin links weight: 800 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/custom-panel-option-editors.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/custom-panel-option-editors.md index 9175397c3b1..cb92cf425d3 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/custom-panel-option-editors.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/custom-panel-option-editors.md @@ -1,5 +1,4 @@ --- -title: Build a custom panel option editor aliases: - ../../../plugins/custom-panel-option-editors/ description: How to build a custom panel option editor. @@ -10,6 +9,11 @@ keywords: - custom panel option editor - customizing panel options - panel options +labels: + products: + - enterprise + - oss +title: Build a custom panel option editor weight: 700 --- diff --git a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/extend-the-grafana-ui-with-links.md b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/extend-the-grafana-ui-with-links.md index ec772e50ce1..5a793e7c6e0 100644 --- a/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/extend-the-grafana-ui-with-links.md +++ b/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/extend-the-grafana-ui-with-links.md @@ -1,7 +1,7 @@ --- -title: Use extensions to add links to app plugins aliases: - ../../../plugins/extend-the-grafana-ui-with-links/ +description: Learn how to add links to the Grafana user interface from an app plugin keywords: - grafana - plugins @@ -9,7 +9,11 @@ keywords: - links - extensions - app plugins -description: Learn how to add links to the Grafana user interface from an app plugin +labels: + products: + - enterprise + - oss +title: Use extensions to add links to app plugins weight: 760 --- diff --git a/docs/sources/developers/plugins/get-started-with-plugins/_index.md b/docs/sources/developers/plugins/get-started-with-plugins/_index.md index 40eb24f608f..f551b23969c 100644 --- a/docs/sources/developers/plugins/get-started-with-plugins/_index.md +++ b/docs/sources/developers/plugins/get-started-with-plugins/_index.md @@ -1,12 +1,16 @@ --- -title: Get started with Grafana plugin development -menuTitle: Get started with plugins +description: Get started with Grafana plugin development. keywords: - grafana - plugins - plugin - documentation -description: Get started with Grafana plugin development. +labels: + products: + - enterprise + - oss +menuTitle: Get started with plugins +title: Get started with Grafana plugin development weight: 200 --- diff --git a/docs/sources/developers/plugins/get-started-with-plugins/development-with-local-grafana.md b/docs/sources/developers/plugins/get-started-with-plugins/development-with-local-grafana.md index 24b6328f07c..fa9f78f578e 100644 --- a/docs/sources/developers/plugins/get-started-with-plugins/development-with-local-grafana.md +++ b/docs/sources/developers/plugins/get-started-with-plugins/development-with-local-grafana.md @@ -1,5 +1,4 @@ --- -title: Develop with a local environment aliases: - ../../plugins/development-with-local-grafana/ description: How to develop with a local Grafana environment. @@ -9,6 +8,11 @@ keywords: - plugin - development environment - local environment +labels: + products: + - enterprise + - oss +title: Develop with a local environment weight: 400 --- diff --git a/docs/sources/developers/plugins/introduction-to-plugin-development/_index.md b/docs/sources/developers/plugins/introduction-to-plugin-development/_index.md index 16727e205a9..afcdbe06e22 100644 --- a/docs/sources/developers/plugins/introduction-to-plugin-development/_index.md +++ b/docs/sources/developers/plugins/introduction-to-plugin-development/_index.md @@ -1,12 +1,16 @@ --- -title: Introduction to Grafana plugin development -menuTitle: Introduction to plugin development +description: Conceptual topics for Grafana plugin development. keywords: - grafana - plugins - plugin - documentation -description: Conceptual topics for Grafana plugin development. +labels: + products: + - enterprise + - oss +menuTitle: Introduction to plugin development +title: Introduction to Grafana plugin development weight: 100 --- diff --git a/docs/sources/developers/plugins/introduction-to-plugin-development/backend/_index.md b/docs/sources/developers/plugins/introduction-to-plugin-development/backend/_index.md index 407a0571719..00ba5a9aaa4 100644 --- a/docs/sources/developers/plugins/introduction-to-plugin-development/backend/_index.md +++ b/docs/sources/developers/plugins/introduction-to-plugin-development/backend/_index.md @@ -1,8 +1,9 @@ --- -title: Backend plugins aliases: - ../../plugins/developing/backend-plugins-guide/ - ../../plugins/backend/ +description: Learn about the Grafana plugin system for backend development of Grafana + integrations. keywords: - grafana - plugins @@ -10,7 +11,11 @@ keywords: - plugin - backend-plugins - documentation -description: Learn about the Grafana plugin system for backend development of Grafana integrations. +labels: + products: + - enterprise + - oss +title: Backend plugins --- # Backend plugins diff --git a/docs/sources/developers/plugins/introduction-to-plugin-development/backend/grafana-plugin-sdk-for-go.md b/docs/sources/developers/plugins/introduction-to-plugin-development/backend/grafana-plugin-sdk-for-go.md index b1717677c4d..7729d2ebd3f 100644 --- a/docs/sources/developers/plugins/introduction-to-plugin-development/backend/grafana-plugin-sdk-for-go.md +++ b/docs/sources/developers/plugins/introduction-to-plugin-development/backend/grafana-plugin-sdk-for-go.md @@ -1,7 +1,8 @@ --- -title: Grafana plugin SDK for Go aliases: - ../../plugins/backend/grafana-plugin-sdk-for-go/ +description: Learn about the Grafana plugin SDK for Go, a Go module with packages + for implementing a Grafana backend plugin. keywords: - grafana - plugins @@ -10,7 +11,11 @@ keywords: - backend-plugins - sdk - documentation -description: Learn about the Grafana plugin SDK for Go, a Go module with packages for implementing a Grafana backend plugin. +labels: + products: + - enterprise + - oss +title: Grafana plugin SDK for Go --- # Grafana plugin SDK for Go diff --git a/docs/sources/developers/plugins/introduction-to-plugin-development/backend/plugin-protocol.md b/docs/sources/developers/plugins/introduction-to-plugin-development/backend/plugin-protocol.md index 1bb45efd86a..5b129e265ba 100644 --- a/docs/sources/developers/plugins/introduction-to-plugin-development/backend/plugin-protocol.md +++ b/docs/sources/developers/plugins/introduction-to-plugin-development/backend/plugin-protocol.md @@ -1,7 +1,8 @@ --- -title: Plugin protocol aliases: - ../../plugins/backend/plugin-protocol/ +description: Learn about the Grafana wire protocol used for communication between + the Grafana server and backend plugins. keywords: - grafana - plugins @@ -9,7 +10,11 @@ keywords: - plugin - backend-plugins - documentation -description: Learn about the Grafana wire protocol used for communication between the Grafana server and backend plugins. +labels: + products: + - enterprise + - oss +title: Plugin protocol --- # Plugin protocol diff --git a/docs/sources/developers/plugins/introduction-to-plugin-development/data-frames.md b/docs/sources/developers/plugins/introduction-to-plugin-development/data-frames.md index e91acc82e09..414a65933b7 100644 --- a/docs/sources/developers/plugins/introduction-to-plugin-development/data-frames.md +++ b/docs/sources/developers/plugins/introduction-to-plugin-development/data-frames.md @@ -1,5 +1,4 @@ --- -title: Data frames aliases: - ../../plugins/data-frames/ description: Learn about data frames and how they work in plugins. @@ -9,6 +8,11 @@ keywords: - plugin - data frames - dataframes +labels: + products: + - enterprise + - oss +title: Data frames --- # Data frames diff --git a/docs/sources/developers/plugins/introduction-to-plugin-development/error-handling.md b/docs/sources/developers/plugins/introduction-to-plugin-development/error-handling.md index ef9268a6c39..c9c719db32e 100644 --- a/docs/sources/developers/plugins/introduction-to-plugin-development/error-handling.md +++ b/docs/sources/developers/plugins/introduction-to-plugin-development/error-handling.md @@ -1,5 +1,4 @@ --- -title: Work with error handling aliases: - ../../plugins/error-handling/ description: How to handle errors in plugins. @@ -9,6 +8,11 @@ keywords: - plugin - errors - error handling +labels: + products: + - enterprise + - oss +title: Work with error handling --- # Work with error handling diff --git a/docs/sources/developers/plugins/legacy/_index.md b/docs/sources/developers/plugins/legacy/_index.md index 9dd7ed7f98e..8bbe397f701 100644 --- a/docs/sources/developers/plugins/legacy/_index.md +++ b/docs/sources/developers/plugins/legacy/_index.md @@ -1,5 +1,4 @@ --- -title: Work with legacy plugins aliases: - ../../plugins/development/ - /docs/grafana/next/plugins/apps/ @@ -7,6 +6,11 @@ aliases: - /docs/grafana/next/plugins/developing/development/ - /docs/grafana/next/plugins/panels/ description: Deprecated guide for Angular plugin development. +labels: + products: + - enterprise + - oss +title: Work with legacy plugins weight: 600 --- diff --git a/docs/sources/developers/plugins/legacy/apps.md b/docs/sources/developers/plugins/legacy/apps.md index 44b8aec0cb5..7adf0dc43b0 100644 --- a/docs/sources/developers/plugins/legacy/apps.md +++ b/docs/sources/developers/plugins/legacy/apps.md @@ -1,12 +1,16 @@ --- -title: Legacy app plugins aliases: - ../../../plugins/developing/apps/ +description: Deprecated guide for Angular plugin development. keywords: - grafana - plugins - documentation -description: Deprecated guide for Angular plugin development. +labels: + products: + - enterprise + - oss +title: Legacy app plugins --- # Legacy app plugins diff --git a/docs/sources/developers/plugins/legacy/data-sources.md b/docs/sources/developers/plugins/legacy/data-sources.md index 137aa1c6f50..fbfc4eafc00 100644 --- a/docs/sources/developers/plugins/legacy/data-sources.md +++ b/docs/sources/developers/plugins/legacy/data-sources.md @@ -1,12 +1,16 @@ --- -title: Legacy data source plugins aliases: - ../../../plugins/developing/datasources/ +description: Deprecated guide for Angular plugin development. keywords: - grafana - plugins - documentation -description: Deprecated guide for Angular plugin development. +labels: + products: + - enterprise + - oss +title: Legacy data source plugins --- # Legacy data source plugins diff --git a/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md b/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md index 6bcb503b0f1..ee4471733e3 100644 --- a/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md +++ b/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md @@ -1,8 +1,12 @@ --- -title: Legacy defaults and editor mode aliases: - ../../../plugins/developing/defaults-and-editor-mode/ description: Deprecated guide for Angular plugin development. +labels: + products: + - enterprise + - oss +title: Legacy defaults and editor mode --- # Legacy defaults and editor mode diff --git a/docs/sources/developers/plugins/legacy/panels.md b/docs/sources/developers/plugins/legacy/panels.md index 5dcd161a28a..397ab401428 100644 --- a/docs/sources/developers/plugins/legacy/panels.md +++ b/docs/sources/developers/plugins/legacy/panels.md @@ -1,13 +1,17 @@ --- -title: Legacy panel plugins aliases: - ../../../plugins/developing/panels/ +description: Deprecated guide for Angular plugin development. keywords: - grafana - plugins - panel - documentation -description: Deprecated guide for Angular plugin development. +labels: + products: + - enterprise + - oss +title: Legacy panel plugins --- # Legacy panel plugins diff --git a/docs/sources/developers/plugins/legacy/review-guidelines.md b/docs/sources/developers/plugins/legacy/review-guidelines.md index b17d02c5b63..56099d70840 100644 --- a/docs/sources/developers/plugins/legacy/review-guidelines.md +++ b/docs/sources/developers/plugins/legacy/review-guidelines.md @@ -1,8 +1,12 @@ --- -title: Legacy review guidelines aliases: - ../../../plugins/developing/plugin-review-guidelines/ description: Deprecated guide for Angular plugin development. +labels: + products: + - enterprise + - oss +title: Legacy review guidelines --- # Legacy review guidelines diff --git a/docs/sources/developers/plugins/legacy/snapshot-mode.md b/docs/sources/developers/plugins/legacy/snapshot-mode.md index b2901c513cf..f46fe9641e5 100644 --- a/docs/sources/developers/plugins/legacy/snapshot-mode.md +++ b/docs/sources/developers/plugins/legacy/snapshot-mode.md @@ -1,8 +1,12 @@ --- -title: Legacy snapshot mode aliases: - ../../../plugins/developing/snapshot-mode/ description: Deprecated guide for Angular plugin development. +labels: + products: + - enterprise + - oss +title: Legacy snapshot mode --- # Legacy snapshot mode diff --git a/docs/sources/developers/plugins/legacy/style-guide.md b/docs/sources/developers/plugins/legacy/style-guide.md index 18227ac4d30..6aa40b7023f 100644 --- a/docs/sources/developers/plugins/legacy/style-guide.md +++ b/docs/sources/developers/plugins/legacy/style-guide.md @@ -1,8 +1,12 @@ --- -title: Legacy code style guide aliases: - ../../../plugins/developing/code-styleguide/ description: Deprecated guide for Angular plugin development. +labels: + products: + - enterprise + - oss +title: Legacy code style guide --- # Legacy code style guide diff --git a/docs/sources/developers/plugins/metadata.md b/docs/sources/developers/plugins/metadata.md index 6a41947d786..fa528d1bbaf 100644 --- a/docs/sources/developers/plugins/metadata.md +++ b/docs/sources/developers/plugins/metadata.md @@ -1,13 +1,17 @@ --- aliases: - ../../plugins/developing/plugin.json/ +description: Reference for the plugin.json metadata file. keywords: - grafana - plugins - documentation -description: Reference for the plugin.json metadata file. -title: plugin.json +labels: + products: + - enterprise + - oss menuTitle: Reference (plugin.json) +title: plugin.json weight: 700 --- diff --git a/docs/sources/developers/plugins/migration-guide/_index.md b/docs/sources/developers/plugins/migration-guide/_index.md index b134e362279..12452f92db7 100644 --- a/docs/sources/developers/plugins/migration-guide/_index.md +++ b/docs/sources/developers/plugins/migration-guide/_index.md @@ -1,5 +1,4 @@ --- -title: Migrate a plugin aliases: - ../../plugins/developing/migration-guide description: A guide for migrating and updating a Grafana plugin. @@ -9,6 +8,11 @@ keywords: - migration - plugin - documentation +labels: + products: + - enterprise + - oss +title: Migrate a plugin weight: 500 --- diff --git a/docs/sources/developers/plugins/migration-guide/angular-react/_index.md b/docs/sources/developers/plugins/migration-guide/angular-react/_index.md index 9c44328ffb0..48d049e563d 100644 --- a/docs/sources/developers/plugins/migration-guide/angular-react/_index.md +++ b/docs/sources/developers/plugins/migration-guide/angular-react/_index.md @@ -1,6 +1,4 @@ --- -title: Migrate a plugin from AngularJS to React -menuTitle: Angular to React description: Guide for migrating plugins from AngularJS to React. keywords: - grafana @@ -8,6 +6,12 @@ keywords: - migration - plugin - documentation +labels: + products: + - enterprise + - oss +menuTitle: Angular to React +title: Migrate a plugin from AngularJS to React weight: 1000 --- diff --git a/docs/sources/developers/plugins/migration-guide/v10.0.x-v10.1.x/_index.md b/docs/sources/developers/plugins/migration-guide/v10.0.x-v10.1.x/_index.md index 01818e3e5f2..07652454364 100644 --- a/docs/sources/developers/plugins/migration-guide/v10.0.x-v10.1.x/_index.md +++ b/docs/sources/developers/plugins/migration-guide/v10.0.x-v10.1.x/_index.md @@ -6,8 +6,12 @@ keywords: - migration - plugin - documentation -title: Migrate plugins from Grafana 10.0.x to 10.1.x +labels: + products: + - enterprise + - oss menutitle: v10.0.x to v10.1.x +title: Migrate plugins from Grafana 10.0.x to 10.1.x weight: 1900 --- diff --git a/docs/sources/developers/plugins/migration-guide/v6.x-v7.x/_index.md b/docs/sources/developers/plugins/migration-guide/v6.x-v7.x/_index.md index 3ebc25676c5..e38e576775d 100644 --- a/docs/sources/developers/plugins/migration-guide/v6.x-v7.x/_index.md +++ b/docs/sources/developers/plugins/migration-guide/v6.x-v7.x/_index.md @@ -1,6 +1,4 @@ --- -title: Migrate plugins from Grafana version 6.x to 7.0 -menuTitle: v6.x to v7.x description: Guide for migrating plugins from Grafana v6.x to v7.x keywords: - grafana @@ -8,6 +6,12 @@ keywords: - migration - plugin - documentation +labels: + products: + - enterprise + - oss +menuTitle: v6.x to v7.x +title: Migrate plugins from Grafana version 6.x to 7.0 weight: 2500 --- diff --git a/docs/sources/developers/plugins/migration-guide/v7.x-v8.x/_index.md b/docs/sources/developers/plugins/migration-guide/v7.x-v8.x/_index.md index fcac642a412..35bd9ed57ef 100644 --- a/docs/sources/developers/plugins/migration-guide/v7.x-v8.x/_index.md +++ b/docs/sources/developers/plugins/migration-guide/v7.x-v8.x/_index.md @@ -1,6 +1,4 @@ --- -title: Migrate plugins from Grafana version 7.x.x to 8.x.x -menuTitle: v7.x to v8.x description: Guide for migrating plugins from Grafana v7.x to v8.x. keywords: - grafana @@ -8,6 +6,12 @@ keywords: - migration - plugin - documentation +labels: + products: + - enterprise + - oss +menuTitle: v7.x to v8.x +title: Migrate plugins from Grafana version 7.x.x to 8.x.x weight: 2400 --- diff --git a/docs/sources/developers/plugins/migration-guide/v8.3.x-8.4.x/_index.md b/docs/sources/developers/plugins/migration-guide/v8.3.x-8.4.x/_index.md index 94b4d669660..b2afb37e1f4 100644 --- a/docs/sources/developers/plugins/migration-guide/v8.3.x-8.4.x/_index.md +++ b/docs/sources/developers/plugins/migration-guide/v8.3.x-8.4.x/_index.md @@ -1,6 +1,4 @@ --- -title: Migrate plugins from Grafana version 8.3.x to 8.4.x -menuTitle: v8.3.x to v8.4.x description: Guide for migrating plugins from Grafana v8.3.x to v8.4.x keywords: - grafana @@ -8,6 +6,12 @@ keywords: - migration - plugin - documentation +labels: + products: + - enterprise + - oss +menuTitle: v8.3.x to v8.4.x +title: Migrate plugins from Grafana version 8.3.x to 8.4.x weight: 2200 --- diff --git a/docs/sources/developers/plugins/migration-guide/v8.x-v9.x/_index.md b/docs/sources/developers/plugins/migration-guide/v8.x-v9.x/_index.md index a608c5091ec..67a122aeb36 100644 --- a/docs/sources/developers/plugins/migration-guide/v8.x-v9.x/_index.md +++ b/docs/sources/developers/plugins/migration-guide/v8.x-v9.x/_index.md @@ -1,6 +1,4 @@ --- -title: Migrate plugins from Grafana version 8.x to 9.x -menuTitle: v8.x to v9.x description: Guide for migrating plugins from Grafana v8.x to v9.x keywords: - grafana @@ -8,6 +6,12 @@ keywords: - migration - plugin - documentation +labels: + products: + - enterprise + - oss +menuTitle: v8.x to v9.x +title: Migrate plugins from Grafana version 8.x to 9.x weight: 2300 --- diff --git a/docs/sources/developers/plugins/migration-guide/v9.1.x-v9.2.x/_index.md b/docs/sources/developers/plugins/migration-guide/v9.1.x-v9.2.x/_index.md index 1b0cf590db0..b77fca280ec 100644 --- a/docs/sources/developers/plugins/migration-guide/v9.1.x-v9.2.x/_index.md +++ b/docs/sources/developers/plugins/migration-guide/v9.1.x-v9.2.x/_index.md @@ -1,6 +1,4 @@ --- -title: Migrate plugins from Grafana version 9.1.x to 9.2.x -menuTitle: v9.1.x to v9.2.x description: Guide for migrating plugins from Grafana v9.1.x to v9.2.x keywords: - grafana @@ -8,6 +6,12 @@ keywords: - migration - plugin - documentation +labels: + products: + - enterprise + - oss +menuTitle: v9.1.x to v9.2.x +title: Migrate plugins from Grafana version 9.1.x to 9.2.x weight: 2100 --- diff --git a/docs/sources/developers/plugins/migration-guide/v9.3.x-9.4.x/_index.md b/docs/sources/developers/plugins/migration-guide/v9.3.x-9.4.x/_index.md index f4df05fd026..d116f3f34a8 100644 --- a/docs/sources/developers/plugins/migration-guide/v9.3.x-9.4.x/_index.md +++ b/docs/sources/developers/plugins/migration-guide/v9.3.x-9.4.x/_index.md @@ -1,6 +1,4 @@ --- -title: Migrate plugins from Grafana 9.3.x to 9.4.x -menuTitle: v9.3.x to v9.4.x description: Guide for migrating plugins from Grafana v9.3.x to v9.4.x keywords: - grafana @@ -8,6 +6,12 @@ keywords: - migration - plugin - documentation +labels: + products: + - enterprise + - oss +menuTitle: v9.3.x to v9.4.x +title: Migrate plugins from Grafana 9.3.x to 9.4.x weight: 2000 --- diff --git a/docs/sources/developers/plugins/migration-guide/v9.x-v10.x/_index.md b/docs/sources/developers/plugins/migration-guide/v9.x-v10.x/_index.md index 1b71b4fe378..694cebc63ac 100644 --- a/docs/sources/developers/plugins/migration-guide/v9.x-v10.x/_index.md +++ b/docs/sources/developers/plugins/migration-guide/v9.x-v10.x/_index.md @@ -1,6 +1,4 @@ --- -title: Migrate plugins from Grafana version 9.x to 10.x -menuTitle: v9.x to v10.x description: Guide for migrating plugins from Grafana v9.x to v10.x keywords: - grafana @@ -8,6 +6,12 @@ keywords: - migration - plugin - documentation +labels: + products: + - enterprise + - oss +menuTitle: v9.x to v10.x +title: Migrate plugins from Grafana version 9.x to 10.x weight: 1900 --- diff --git a/docs/sources/developers/plugins/plugin-spellcheck.md b/docs/sources/developers/plugins/plugin-spellcheck.md index abfd2d9df27..d2e61c9762e 100644 --- a/docs/sources/developers/plugins/plugin-spellcheck.md +++ b/docs/sources/developers/plugins/plugin-spellcheck.md @@ -1,7 +1,11 @@ --- -title: Configuring plugin spellcheck description: Internal docs on how to setup the plugin spellcheck draft: true +labels: + products: + - enterprise + - oss +title: Configuring plugin spellcheck --- # Configuring plugin spellcheck diff --git a/docs/sources/developers/plugins/publish-a-plugin/_index.md b/docs/sources/developers/plugins/publish-a-plugin/_index.md index 9d227e66064..ce383521df0 100644 --- a/docs/sources/developers/plugins/publish-a-plugin/_index.md +++ b/docs/sources/developers/plugins/publish-a-plugin/_index.md @@ -1,13 +1,17 @@ --- -title: Publish or sign a plugin -menuTitle: Publish a plugin +description: An index to documentation related to plugin publishing and signing. keywords: - grafana - plugins - plugin - publish - publishing -description: An index to documentation related to plugin publishing and signing. +labels: + products: + - enterprise + - oss +menuTitle: Publish a plugin +title: Publish or sign a plugin weight: 400 --- diff --git a/docs/sources/developers/plugins/publish-a-plugin/package-a-plugin.md b/docs/sources/developers/plugins/publish-a-plugin/package-a-plugin.md index 31e48c190d8..8248f9aac35 100644 --- a/docs/sources/developers/plugins/publish-a-plugin/package-a-plugin.md +++ b/docs/sources/developers/plugins/publish-a-plugin/package-a-plugin.md @@ -1,5 +1,7 @@ --- -title: Package a plugin +aliases: + - ../package-a-plugin/ +description: How to package a plugin keywords: - grafana - plugins @@ -8,10 +10,12 @@ keywords: - package - packaging - packages -description: How to package a plugin +labels: + products: + - enterprise + - oss +title: Package a plugin weight: 100 -aliases: - - ../package-a-plugin/ --- # Package a plugin diff --git a/docs/sources/developers/plugins/publish-a-plugin/publish-or-update-a-plugin.md b/docs/sources/developers/plugins/publish-a-plugin/publish-or-update-a-plugin.md index 53b204f10e9..0113b08328f 100644 --- a/docs/sources/developers/plugins/publish-a-plugin/publish-or-update-a-plugin.md +++ b/docs/sources/developers/plugins/publish-a-plugin/publish-or-update-a-plugin.md @@ -1,15 +1,19 @@ --- -title: Publish or update a plugin aliases: - ../../plugins/publish-a-plugin/ - share-a-plugin/ +description: Learn how to package and share your plugin. keywords: - grafana - plugins - plugin - publish plugin - update plugin -description: Learn how to package and share your plugin. +labels: + products: + - enterprise + - oss +title: Publish or update a plugin type: docs weight: 300 --- diff --git a/docs/sources/developers/plugins/publish-a-plugin/publishing-and-signing-criteria.md b/docs/sources/developers/plugins/publish-a-plugin/publishing-and-signing-criteria.md index b4beb276509..ed6dbad8b0f 100644 --- a/docs/sources/developers/plugins/publish-a-plugin/publishing-and-signing-criteria.md +++ b/docs/sources/developers/plugins/publish-a-plugin/publishing-and-signing-criteria.md @@ -1,8 +1,7 @@ --- -title: Plugin publishing and signing criteria -description: Acceptance criteria for publishing and signing Grafana plugins. aliases: - ../../plugins/publishing-and-signing-criteria/ +description: Acceptance criteria for publishing and signing Grafana plugins. keywords: - grafana - plugins @@ -11,6 +10,11 @@ keywords: - sign plugin - publishing - signing +labels: + products: + - enterprise + - oss +title: Plugin publishing and signing criteria weight: 200 --- diff --git a/docs/sources/developers/plugins/publish-a-plugin/sign-a-plugin.md b/docs/sources/developers/plugins/publish-a-plugin/sign-a-plugin.md index 2530632ffc0..e60bc41897a 100644 --- a/docs/sources/developers/plugins/publish-a-plugin/sign-a-plugin.md +++ b/docs/sources/developers/plugins/publish-a-plugin/sign-a-plugin.md @@ -1,5 +1,4 @@ --- -title: Sign a plugin aliases: - ../sign-a-plugin/ description: How to sign a Grafana plugin. @@ -9,6 +8,11 @@ keywords: - plugin - sign plugin - signing plugin +labels: + products: + - enterprise + - oss +title: Sign a plugin weight: 400 --- diff --git a/docs/sources/explore/_index.md b/docs/sources/explore/_index.md index 0bae5337996..4d2efad9874 100644 --- a/docs/sources/explore/_index.md +++ b/docs/sources/explore/_index.md @@ -5,6 +5,11 @@ keywords: - explore - loki - logs +labels: + products: + - cloud + - enterprise + - oss title: Explore weight: 90 --- diff --git a/docs/sources/explore/explore-inspector.md b/docs/sources/explore/explore-inspector.md index 261d9e543c4..2958659a389 100644 --- a/docs/sources/explore/explore-inspector.md +++ b/docs/sources/explore/explore-inspector.md @@ -1,4 +1,9 @@ --- +labels: + products: + - cloud + - enterprise + - oss title: Inspector in Explore weight: 400 --- diff --git a/docs/sources/explore/logs-integration.md b/docs/sources/explore/logs-integration.md index 18204a6f224..26c0db20793 100644 --- a/docs/sources/explore/logs-integration.md +++ b/docs/sources/explore/logs-integration.md @@ -3,6 +3,11 @@ description: Logs in Explore keywords: - explore - logs +labels: + products: + - cloud + - enterprise + - oss title: Logs in Explore weight: 15 --- diff --git a/docs/sources/explore/query-management.md b/docs/sources/explore/query-management.md index 731e694b0f5..e2b269fd553 100644 --- a/docs/sources/explore/query-management.md +++ b/docs/sources/explore/query-management.md @@ -3,6 +3,11 @@ keywords: - explore - loki - logs +labels: + products: + - cloud + - enterprise + - oss title: Query management weight: 10 --- diff --git a/docs/sources/explore/trace-integration.md b/docs/sources/explore/trace-integration.md index 5d1694b798f..6a3afe24676 100644 --- a/docs/sources/explore/trace-integration.md +++ b/docs/sources/explore/trace-integration.md @@ -3,6 +3,11 @@ description: Tracing in Explore keywords: - explore - trace +labels: + products: + - cloud + - enterprise + - oss title: Tracing in Explore weight: 20 --- diff --git a/docs/sources/fundamentals/_index.md b/docs/sources/fundamentals/_index.md index 1452af2704b..8472fc320e7 100644 --- a/docs/sources/fundamentals/_index.md +++ b/docs/sources/fundamentals/_index.md @@ -1,8 +1,13 @@ --- aliases: - basics/ -title: Fundamentals description: Learn about the basics of observability. +labels: + products: + - cloud + - enterprise + - oss +title: Fundamentals weight: 8 --- diff --git a/docs/sources/fundamentals/dashboards-overview/index.md b/docs/sources/fundamentals/dashboards-overview/index.md index 0ff6b70d634..4bcec23e965 100644 --- a/docs/sources/fundamentals/dashboards-overview/index.md +++ b/docs/sources/fundamentals/dashboards-overview/index.md @@ -7,8 +7,13 @@ keywords: - data source - transform - query -title: Grafana dashboards overview +labels: + products: + - cloud + - enterprise + - oss menuTitle: Dashboard overview +title: Grafana dashboards overview weight: 390 --- diff --git a/docs/sources/fundamentals/exemplars/index.md b/docs/sources/fundamentals/exemplars/index.md index b9138f00e11..363bc122b47 100644 --- a/docs/sources/fundamentals/exemplars/index.md +++ b/docs/sources/fundamentals/exemplars/index.md @@ -8,6 +8,11 @@ keywords: - concepts - exemplars - prometheus +labels: + products: + - cloud + - enterprise + - oss menuTitle: Exemplars title: Introduction to exemplars weight: 800 diff --git a/docs/sources/fundamentals/glossary/index.md b/docs/sources/fundamentals/glossary/index.md index 39a7271dbcf..eee83a7f2de 100644 --- a/docs/sources/fundamentals/glossary/index.md +++ b/docs/sources/fundamentals/glossary/index.md @@ -9,6 +9,11 @@ keywords: - intro - glossary - dictionary +labels: + products: + - cloud + - enterprise + - oss title: Glossary weight: 850 --- diff --git a/docs/sources/fundamentals/intro-histograms/index.md b/docs/sources/fundamentals/intro-histograms/index.md index 49022de6d11..4b78139e391 100644 --- a/docs/sources/fundamentals/intro-histograms/index.md +++ b/docs/sources/fundamentals/intro-histograms/index.md @@ -9,6 +9,11 @@ keywords: - panel - documentation - histogram +labels: + products: + - cloud + - enterprise + - oss menuTitle: Histograms and heatmaps title: Introduction to histograms and heatmaps weight: 650 diff --git a/docs/sources/fundamentals/intro-to-prometheus/index.md b/docs/sources/fundamentals/intro-to-prometheus/index.md index 574951aa734..a377e6b8f9e 100644 --- a/docs/sources/fundamentals/intro-to-prometheus/index.md +++ b/docs/sources/fundamentals/intro-to-prometheus/index.md @@ -8,6 +8,11 @@ keywords: - Prometheus - metrics - time series +labels: + products: + - cloud + - enterprise + - oss title: What is Prometheus? weight: 300 --- diff --git a/docs/sources/fundamentals/timeseries-dimensions/index.md b/docs/sources/fundamentals/timeseries-dimensions/index.md index 63ffd6cafb9..e7d2382283f 100644 --- a/docs/sources/fundamentals/timeseries-dimensions/index.md +++ b/docs/sources/fundamentals/timeseries-dimensions/index.md @@ -11,6 +11,11 @@ keywords: - concepts - timeseries - labels +labels: + products: + - cloud + - enterprise + - oss title: Time series dimensions weight: 500 --- diff --git a/docs/sources/fundamentals/timeseries/index.md b/docs/sources/fundamentals/timeseries/index.md index a0aac81ef8f..f95f6e6aa41 100644 --- a/docs/sources/fundamentals/timeseries/index.md +++ b/docs/sources/fundamentals/timeseries/index.md @@ -8,6 +8,11 @@ keywords: - guide - concepts - timeseries +labels: + products: + - cloud + - enterprise + - oss title: Introduction to time series weight: 400 --- diff --git a/docs/sources/getting-started/_index.md b/docs/sources/getting-started/_index.md index 7e39ba93c2f..53e8f5a9866 100644 --- a/docs/sources/getting-started/_index.md +++ b/docs/sources/getting-started/_index.md @@ -1,8 +1,12 @@ --- aliases: - guides/what-is-grafana/ -title: Get started description: Learn how build your first dashboard after you have installed Grafana. +labels: + products: + - enterprise + - oss +title: Get started weight: 9 --- diff --git a/docs/sources/getting-started/build-first-dashboard.md b/docs/sources/getting-started/build-first-dashboard.md index 981543e9fcc..31f65058c9a 100644 --- a/docs/sources/getting-started/build-first-dashboard.md +++ b/docs/sources/getting-started/build-first-dashboard.md @@ -4,6 +4,10 @@ aliases: - ../guides/gettingstarted/ - getting-started/ description: Learn how to get started with Grafana by adding a preconfigured dashboard. +labels: + products: + - enterprise + - oss title: Build your first dashboard weight: 200 --- diff --git a/docs/sources/getting-started/get-started-grafana-influxdb.md b/docs/sources/getting-started/get-started-grafana-influxdb.md index c7679c13f2c..90a7193a478 100644 --- a/docs/sources/getting-started/get-started-grafana-influxdb.md +++ b/docs/sources/getting-started/get-started-grafana-influxdb.md @@ -2,6 +2,10 @@ aliases: - getting-started-influxdb/ description: Learn how to build your first InfluxDB dashboard in Grafana. +labels: + products: + - enterprise + - oss title: Get started with Grafana and InfluxDB weight: 400 --- diff --git a/docs/sources/getting-started/get-started-grafana-ms-sql-server.md b/docs/sources/getting-started/get-started-grafana-ms-sql-server.md index 58ffc1792c4..b9f0a95fa47 100644 --- a/docs/sources/getting-started/get-started-grafana-ms-sql-server.md +++ b/docs/sources/getting-started/get-started-grafana-ms-sql-server.md @@ -4,6 +4,10 @@ aliases: - ../guides/gettingstarted/ - getting-started-sql/ description: Learn how to build your first MS SQL Server dashboard in Grafana. +labels: + products: + - enterprise + - oss title: Get started with Grafana and MS SQL Server weight: 500 --- diff --git a/docs/sources/getting-started/get-started-grafana-prometheus.md b/docs/sources/getting-started/get-started-grafana-prometheus.md index 1394c4984f0..1ed833b034a 100644 --- a/docs/sources/getting-started/get-started-grafana-prometheus.md +++ b/docs/sources/getting-started/get-started-grafana-prometheus.md @@ -4,6 +4,10 @@ aliases: - ../guides/gettingstarted/ - getting-started-prometheus/ description: Learn how to build your first Prometheus dashboard in Grafana. +labels: + products: + - enterprise + - oss title: Get started with Grafana and Prometheus weight: 300 --- diff --git a/docs/sources/introduction/_index.md b/docs/sources/introduction/_index.md index 0e33a5be4cc..2e96e66c41b 100644 --- a/docs/sources/introduction/_index.md +++ b/docs/sources/introduction/_index.md @@ -2,8 +2,13 @@ aliases: - guides/what-is-grafana/ - oss-details/ -title: Introduction to Grafana description: Learn about Grafana OSS, Grafana Enterprise, and Grafana Cloud. +labels: + products: + - cloud + - enterprise + - oss +title: Introduction to Grafana weight: 5 --- diff --git a/docs/sources/introduction/grafana-cloud.md b/docs/sources/introduction/grafana-cloud.md index ffc7262f346..c4a3801f991 100644 --- a/docs/sources/introduction/grafana-cloud.md +++ b/docs/sources/introduction/grafana-cloud.md @@ -1,6 +1,9 @@ --- -title: Grafana Cloud description: Learn about Grafana Cloud. +labels: + products: + - cloud +title: Grafana Cloud weight: 300 --- diff --git a/docs/sources/introduction/grafana-enterprise.md b/docs/sources/introduction/grafana-enterprise.md index 0b101cdbb49..be5ba8375d3 100644 --- a/docs/sources/introduction/grafana-enterprise.md +++ b/docs/sources/introduction/grafana-enterprise.md @@ -2,6 +2,9 @@ aliases: - ../enterprise/ description: Grafana Enterprise overview +labels: + products: + - enterprise title: Grafana Enterprise weight: 200 --- diff --git a/docs/sources/old-alerting/_index.md b/docs/sources/old-alerting/_index.md index becff29e77e..f630efd68db 100644 --- a/docs/sources/old-alerting/_index.md +++ b/docs/sources/old-alerting/_index.md @@ -1,5 +1,9 @@ --- draft: true +labels: + products: + - enterprise + - oss title: Legacy Grafana alerts weight: 114 --- diff --git a/docs/sources/old-alerting/add-notification-template.md b/docs/sources/old-alerting/add-notification-template.md index a10d95a2013..f2cea0cac27 100644 --- a/docs/sources/old-alerting/add-notification-template.md +++ b/docs/sources/old-alerting/add-notification-template.md @@ -9,6 +9,10 @@ keywords: - alerts - notification - templating +labels: + products: + - enterprise + - oss title: Alert notification templating weight: 110 --- diff --git a/docs/sources/old-alerting/create-alerts.md b/docs/sources/old-alerting/create-alerts.md index a9556b7c1c4..f60f8afebf1 100644 --- a/docs/sources/old-alerting/create-alerts.md +++ b/docs/sources/old-alerting/create-alerts.md @@ -8,6 +8,10 @@ keywords: - alerting - guide - rules +labels: + products: + - enterprise + - oss title: Create alerts weight: 200 --- diff --git a/docs/sources/old-alerting/notifications.md b/docs/sources/old-alerting/notifications.md index 92284f4651b..c450f8cbdb0 100644 --- a/docs/sources/old-alerting/notifications.md +++ b/docs/sources/old-alerting/notifications.md @@ -8,6 +8,10 @@ keywords: - alerting - guide - notifications +labels: + products: + - enterprise + - oss title: Alert notifications weight: 100 --- diff --git a/docs/sources/old-alerting/pause-an-alert-rule.md b/docs/sources/old-alerting/pause-an-alert-rule.md index 09afe7f0c89..8cc675f7d66 100644 --- a/docs/sources/old-alerting/pause-an-alert-rule.md +++ b/docs/sources/old-alerting/pause-an-alert-rule.md @@ -9,6 +9,10 @@ keywords: - guide - rules - view +labels: + products: + - enterprise + - oss title: Pause an alert rule weight: 400 --- diff --git a/docs/sources/old-alerting/troubleshoot-alerts.md b/docs/sources/old-alerting/troubleshoot-alerts.md index 7c8a260be9e..053bc34690f 100644 --- a/docs/sources/old-alerting/troubleshoot-alerts.md +++ b/docs/sources/old-alerting/troubleshoot-alerts.md @@ -9,6 +9,10 @@ keywords: - guide - rules - troubleshoot +labels: + products: + - enterprise + - oss title: Troubleshoot alerts weight: 500 --- diff --git a/docs/sources/old-alerting/view-alerts.md b/docs/sources/old-alerting/view-alerts.md index 83916156d50..b927715685b 100644 --- a/docs/sources/old-alerting/view-alerts.md +++ b/docs/sources/old-alerting/view-alerts.md @@ -9,8 +9,12 @@ keywords: - guide - rules - view -title: View existing alert rules +labels: + products: + - enterprise + - oss menuTitle: View alerts +title: View existing alert rules weight: 400 --- diff --git a/docs/sources/panels-visualizations/_index.md b/docs/sources/panels-visualizations/_index.md index d5f6742c79a..9820926c8d8 100644 --- a/docs/sources/panels-visualizations/_index.md +++ b/docs/sources/panels-visualizations/_index.md @@ -8,6 +8,11 @@ keywords: - configure - panels - visualizations +labels: + products: + - cloud + - enterprise + - oss menuTitle: Panels and visualizations title: Panels and visualizations weight: 80 diff --git a/docs/sources/panels-visualizations/calculation-types/index.md b/docs/sources/panels-visualizations/calculation-types/index.md index 3b676420637..316fe512ac7 100644 --- a/docs/sources/panels-visualizations/calculation-types/index.md +++ b/docs/sources/panels-visualizations/calculation-types/index.md @@ -3,6 +3,11 @@ aliases: - ../panels/calculation-types/ - ../panels/calculations-list/ - ../panels/reference-calculation-types/ +labels: + products: + - cloud + - enterprise + - oss title: Calculation types weight: 1100 --- diff --git a/docs/sources/panels-visualizations/configure-data-links/index.md b/docs/sources/panels-visualizations/configure-data-links/index.md index 76459b920eb..2e0313c4058 100644 --- a/docs/sources/panels-visualizations/configure-data-links/index.md +++ b/docs/sources/panels-visualizations/configure-data-links/index.md @@ -13,6 +13,11 @@ keywords: - data link - documentation - playlist +labels: + products: + - cloud + - enterprise + - oss menuTitle: Configure data links title: Configure data links weight: 400 diff --git a/docs/sources/panels-visualizations/configure-legend/index.md b/docs/sources/panels-visualizations/configure-legend/index.md index 6694068f96e..9e0f71da33f 100644 --- a/docs/sources/panels-visualizations/configure-legend/index.md +++ b/docs/sources/panels-visualizations/configure-legend/index.md @@ -2,6 +2,11 @@ aliases: - ../panels/working-with-panels/configure-legend/ - visualizations/configure-legend/ +labels: + products: + - cloud + - enterprise + - oss title: Configure a legend weight: 400 --- diff --git a/docs/sources/panels-visualizations/configure-overrides/index.md b/docs/sources/panels-visualizations/configure-overrides/index.md index cebc810755d..077e0f3c20a 100644 --- a/docs/sources/panels-visualizations/configure-overrides/index.md +++ b/docs/sources/panels-visualizations/configure-overrides/index.md @@ -8,6 +8,11 @@ aliases: - ../panels/override-field-values/delete-a-field-override/ - ../panels/override-field-values/edit-field-override/ - ../panels/override-field-values/view-field-override/ +labels: + products: + - cloud + - enterprise + - oss menuTitle: Configure field overrides title: Configure field overrides weight: 400 diff --git a/docs/sources/panels-visualizations/configure-panel-options/index.md b/docs/sources/panels-visualizations/configure-panel-options/index.md index 7409994b6c8..da69bc06113 100644 --- a/docs/sources/panels-visualizations/configure-panel-options/index.md +++ b/docs/sources/panels-visualizations/configure-panel-options/index.md @@ -12,6 +12,11 @@ keywords: - title - description - JSON model +labels: + products: + - cloud + - enterprise + - oss menuTitle: Configure panel options title: Configure panel options weight: 2 diff --git a/docs/sources/panels-visualizations/configure-standard-options/index.md b/docs/sources/panels-visualizations/configure-standard-options/index.md index 6d5d81b6395..b4650f3b0e0 100644 --- a/docs/sources/panels-visualizations/configure-standard-options/index.md +++ b/docs/sources/panels-visualizations/configure-standard-options/index.md @@ -12,6 +12,11 @@ keywords: - dashboard - standard - option +labels: + products: + - cloud + - enterprise + - oss menuTitle: Configure standard options title: Configure standard options weight: 2 diff --git a/docs/sources/panels-visualizations/configure-thresholds/index.md b/docs/sources/panels-visualizations/configure-thresholds/index.md index a0822de0553..b3efad1df60 100644 --- a/docs/sources/panels-visualizations/configure-thresholds/index.md +++ b/docs/sources/panels-visualizations/configure-thresholds/index.md @@ -8,6 +8,11 @@ aliases: - ../panels/specify-thresholds/delete-a-threshold/ - ../panels/thresholds/ description: This section includes information about using thresholds in your visualizations. +labels: + products: + - cloud + - enterprise + - oss menuTitle: Configure thresholds title: Configure thresholds weight: 300 diff --git a/docs/sources/panels-visualizations/configure-value-mappings/index.md b/docs/sources/panels-visualizations/configure-value-mappings/index.md index 29060d61ba7..e108a255a3b 100644 --- a/docs/sources/panels-visualizations/configure-value-mappings/index.md +++ b/docs/sources/panels-visualizations/configure-value-mappings/index.md @@ -9,6 +9,11 @@ aliases: - ../panels/format-data/map-a-special-value/ - ../panels/format-data/map-a-value/ - ../panels/value-mappings/ +labels: + products: + - cloud + - enterprise + - oss menuTitle: Configure value mappings title: Configure value mappings weight: 600 diff --git a/docs/sources/panels-visualizations/panel-editor-overview/index.md b/docs/sources/panels-visualizations/panel-editor-overview/index.md index 9c173b44612..ffa3a83e1c2 100644 --- a/docs/sources/panels-visualizations/panel-editor-overview/index.md +++ b/docs/sources/panels-visualizations/panel-editor-overview/index.md @@ -17,6 +17,11 @@ keywords: - dynamic - rows - add +labels: + products: + - cloud + - enterprise + - oss menuTitle: Panel editor overview title: Panel editor overview weight: 1 diff --git a/docs/sources/panels-visualizations/panel-inspector/index.md b/docs/sources/panels-visualizations/panel-inspector/index.md index 66012f748e4..01cbef7570e 100644 --- a/docs/sources/panels-visualizations/panel-inspector/index.md +++ b/docs/sources/panels-visualizations/panel-inspector/index.md @@ -4,6 +4,11 @@ aliases: - ../panels/query-a-data-source/inspect-query-performance/ - ../panels/query-a-data-source/inspect-request-and-response-data/ - ../panels/working-with-panels/navigate-inspector-panel/ +labels: + products: + - cloud + - enterprise + - oss title: The panel inspect view weight: 1200 --- diff --git a/docs/sources/panels-visualizations/query-transform-data/_index.md b/docs/sources/panels-visualizations/query-transform-data/_index.md index 9fc71e326b1..61d0aae85e7 100644 --- a/docs/sources/panels-visualizations/query-transform-data/_index.md +++ b/docs/sources/panels-visualizations/query-transform-data/_index.md @@ -13,6 +13,11 @@ aliases: - ../panels/share-query-results/ - manage-queries/ - query-options/ +labels: + products: + - cloud + - enterprise + - oss title: Query and transform data weight: 200 --- diff --git a/docs/sources/panels-visualizations/query-transform-data/expression-queries/index.md b/docs/sources/panels-visualizations/query-transform-data/expression-queries/index.md index 3ed00b20245..5f468026ff4 100644 --- a/docs/sources/panels-visualizations/query-transform-data/expression-queries/index.md +++ b/docs/sources/panels-visualizations/query-transform-data/expression-queries/index.md @@ -4,6 +4,11 @@ aliases: - ../../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions/ - ../../panels/query-a-data-source/use-expressions-to-manipulate-data/write-an-expression/ - ./ +labels: + products: + - cloud + - enterprise + - oss menuTitle: Write expression queries title: Write expression queries weight: 40 diff --git a/docs/sources/panels-visualizations/query-transform-data/share-query/index.md b/docs/sources/panels-visualizations/query-transform-data/share-query/index.md index acc72dff712..e0a16dcf4ae 100644 --- a/docs/sources/panels-visualizations/query-transform-data/share-query/index.md +++ b/docs/sources/panels-visualizations/query-transform-data/share-query/index.md @@ -1,6 +1,11 @@ --- aliases: - ../../panels/query-a-data-source/share-query/ +labels: + products: + - cloud + - enterprise + - oss menuTitle: Share query results title: Share query results with another panel weight: 60 diff --git a/docs/sources/panels-visualizations/query-transform-data/transform-data/index.md b/docs/sources/panels-visualizations/query-transform-data/transform-data/index.md index 5089d78e76d..d9cf5a8b541 100644 --- a/docs/sources/panels-visualizations/query-transform-data/transform-data/index.md +++ b/docs/sources/panels-visualizations/query-transform-data/transform-data/index.md @@ -13,6 +13,11 @@ aliases: - ../../panels/transformations/config-from-query/ - ../../panels/transformations/rows-to-fields/ - ../../panels/transformations/types-options/ +labels: + products: + - cloud + - enterprise + - oss title: Transform data weight: 100 --- diff --git a/docs/sources/panels-visualizations/query-transform-data/troubleshoot-queries/index.md b/docs/sources/panels-visualizations/query-transform-data/troubleshoot-queries/index.md index 395afc3da7f..00364d49563 100644 --- a/docs/sources/panels-visualizations/query-transform-data/troubleshoot-queries/index.md +++ b/docs/sources/panels-visualizations/query-transform-data/troubleshoot-queries/index.md @@ -8,6 +8,11 @@ keywords: - documentation - guide - queries +labels: + products: + - cloud + - enterprise + - oss title: Troubleshoot queries weight: 200 --- diff --git a/docs/sources/panels-visualizations/visualizations/_index.md b/docs/sources/panels-visualizations/visualizations/_index.md index e3c7e45a7ab..4633842cc82 100644 --- a/docs/sources/panels-visualizations/visualizations/_index.md +++ b/docs/sources/panels-visualizations/visualizations/_index.md @@ -6,6 +6,11 @@ aliases: - ../reference/graph/ - ../visualizations/ - ../visualizations/graph-panel/ +labels: + products: + - cloud + - enterprise + - oss title: Visualizations weight: 75 --- diff --git a/docs/sources/panels-visualizations/visualizations/alert-list/index.md b/docs/sources/panels-visualizations/visualizations/alert-list/index.md index 593435feaef..6f94acea094 100644 --- a/docs/sources/panels-visualizations/visualizations/alert-list/index.md +++ b/docs/sources/panels-visualizations/visualizations/alert-list/index.md @@ -10,6 +10,11 @@ keywords: - documentation - panel - alertlist +labels: + products: + - cloud + - enterprise + - oss title: Alert list weight: 100 --- diff --git a/docs/sources/panels-visualizations/visualizations/annotations/index.md b/docs/sources/panels-visualizations/visualizations/annotations/index.md index 6ee7e13985e..5ed92400621 100644 --- a/docs/sources/panels-visualizations/visualizations/annotations/index.md +++ b/docs/sources/panels-visualizations/visualizations/annotations/index.md @@ -9,6 +9,11 @@ keywords: - Annotations - panel - documentation +labels: + products: + - cloud + - enterprise + - oss title: Annotations weight: 105 --- diff --git a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md index 72369865de0..e404dbae2ca 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md @@ -9,6 +9,11 @@ keywords: - bar chart - panel - barchart +labels: + products: + - cloud + - enterprise + - oss title: Bar chart weight: 170 --- diff --git a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md index 8c2dd6cd4e5..d0eb7e6e1f9 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md @@ -8,6 +8,11 @@ keywords: - grafana - bar - bar gauge +labels: + products: + - cloud + - enterprise + - oss title: Bar gauge weight: 200 --- diff --git a/docs/sources/panels-visualizations/visualizations/candlestick/index.md b/docs/sources/panels-visualizations/visualizations/candlestick/index.md index 27c8c660e0f..f58d7bf50ea 100644 --- a/docs/sources/panels-visualizations/visualizations/candlestick/index.md +++ b/docs/sources/panels-visualizations/visualizations/candlestick/index.md @@ -10,6 +10,11 @@ keywords: - OHLC - panel - documentation +labels: + products: + - cloud + - enterprise + - oss title: Candlestick weight: 600 --- diff --git a/docs/sources/panels-visualizations/visualizations/canvas/index.md b/docs/sources/panels-visualizations/visualizations/canvas/index.md index d174271322a..d87a7f5021f 100644 --- a/docs/sources/panels-visualizations/visualizations/canvas/index.md +++ b/docs/sources/panels-visualizations/visualizations/canvas/index.md @@ -8,6 +8,11 @@ keywords: - canvas - panel - documentation +labels: + products: + - cloud + - enterprise + - oss title: Canvas weight: 600 --- diff --git a/docs/sources/panels-visualizations/visualizations/dashboard-list/index.md b/docs/sources/panels-visualizations/visualizations/dashboard-list/index.md index 94b579778f2..2184d1d175a 100644 --- a/docs/sources/panels-visualizations/visualizations/dashboard-list/index.md +++ b/docs/sources/panels-visualizations/visualizations/dashboard-list/index.md @@ -10,6 +10,11 @@ keywords: - documentation - panel - dashlist +labels: + products: + - cloud + - enterprise + - oss title: Dashboard list weight: 300 --- diff --git a/docs/sources/panels-visualizations/visualizations/datagrid/index.md b/docs/sources/panels-visualizations/visualizations/datagrid/index.md index 50099a9da55..a5e4e91091e 100644 --- a/docs/sources/panels-visualizations/visualizations/datagrid/index.md +++ b/docs/sources/panels-visualizations/visualizations/datagrid/index.md @@ -11,6 +11,11 @@ keywords: - datagrid - datagrid panel - datagrid options +labels: + products: + - cloud + - enterprise + - oss menuTitle: Datagrid title: Datagrid weight: 350 diff --git a/docs/sources/panels-visualizations/visualizations/flame-graph/index.md b/docs/sources/panels-visualizations/visualizations/flame-graph/index.md index 90fbeda4585..91d19cbe8c4 100644 --- a/docs/sources/panels-visualizations/visualizations/flame-graph/index.md +++ b/docs/sources/panels-visualizations/visualizations/flame-graph/index.md @@ -7,6 +7,11 @@ keywords: - documentation - panels - flame graph +labels: + products: + - cloud + - enterprise + - oss title: Flame graph weight: 850 --- diff --git a/docs/sources/panels-visualizations/visualizations/gauge/index.md b/docs/sources/panels-visualizations/visualizations/gauge/index.md index 50c219d27a4..6a5365157c8 100644 --- a/docs/sources/panels-visualizations/visualizations/gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/gauge/index.md @@ -8,6 +8,11 @@ keywords: - grafana - gauge - gauge panel +labels: + products: + - cloud + - enterprise + - oss title: Gauge weight: 400 --- diff --git a/docs/sources/panels-visualizations/visualizations/geomap/index.md b/docs/sources/panels-visualizations/visualizations/geomap/index.md index cf48d7d5f27..d1ee05f69f3 100644 --- a/docs/sources/panels-visualizations/visualizations/geomap/index.md +++ b/docs/sources/panels-visualizations/visualizations/geomap/index.md @@ -27,6 +27,11 @@ keywords: - Geomap - panel - documentation +labels: + products: + - cloud + - enterprise + - oss title: Geomap weight: 600 --- diff --git a/docs/sources/panels-visualizations/visualizations/heatmap/index.md b/docs/sources/panels-visualizations/visualizations/heatmap/index.md index c8141cb1ced..32da224f35a 100644 --- a/docs/sources/panels-visualizations/visualizations/heatmap/index.md +++ b/docs/sources/panels-visualizations/visualizations/heatmap/index.md @@ -8,6 +8,11 @@ keywords: - heatmap - panel - documentation +labels: + products: + - cloud + - enterprise + - oss title: Heatmap weight: 600 --- diff --git a/docs/sources/panels-visualizations/visualizations/histogram/index.md b/docs/sources/panels-visualizations/visualizations/histogram/index.md index d49d15c7e71..ed568d79198 100644 --- a/docs/sources/panels-visualizations/visualizations/histogram/index.md +++ b/docs/sources/panels-visualizations/visualizations/histogram/index.md @@ -10,6 +10,11 @@ keywords: - bar chart - panel - barchart +labels: + products: + - cloud + - enterprise + - oss title: Histogram weight: 605 --- diff --git a/docs/sources/panels-visualizations/visualizations/logs/index.md b/docs/sources/panels-visualizations/visualizations/logs/index.md index 54b20df51b8..cdf3c26ef24 100644 --- a/docs/sources/panels-visualizations/visualizations/logs/index.md +++ b/docs/sources/panels-visualizations/visualizations/logs/index.md @@ -10,6 +10,11 @@ keywords: - documentation - panels - logs panel +labels: + products: + - cloud + - enterprise + - oss title: Logs panel weight: 700 --- diff --git a/docs/sources/panels-visualizations/visualizations/news/index.md b/docs/sources/panels-visualizations/visualizations/news/index.md index a8d9838fbde..fa696cdd343 100644 --- a/docs/sources/panels-visualizations/visualizations/news/index.md +++ b/docs/sources/panels-visualizations/visualizations/news/index.md @@ -8,6 +8,11 @@ keywords: - documentation - panels - news panel +labels: + products: + - cloud + - enterprise + - oss title: News weight: 800 --- diff --git a/docs/sources/panels-visualizations/visualizations/node-graph/index.md b/docs/sources/panels-visualizations/visualizations/node-graph/index.md index e2041aec56a..6eb788fd1a4 100644 --- a/docs/sources/panels-visualizations/visualizations/node-graph/index.md +++ b/docs/sources/panels-visualizations/visualizations/node-graph/index.md @@ -9,6 +9,11 @@ keywords: - panels - node graph - directed graph +labels: + products: + - cloud + - enterprise + - oss title: Node graph weight: 850 --- diff --git a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md index 31566987429..94f19d05fe2 100644 --- a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md @@ -5,6 +5,11 @@ aliases: keywords: - grafana - pie chart +labels: + products: + - cloud + - enterprise + - oss title: Pie chart weight: 850 --- diff --git a/docs/sources/panels-visualizations/visualizations/stat/index.md b/docs/sources/panels-visualizations/visualizations/stat/index.md index 14e7926a802..1077a035f94 100644 --- a/docs/sources/panels-visualizations/visualizations/stat/index.md +++ b/docs/sources/panels-visualizations/visualizations/stat/index.md @@ -10,6 +10,11 @@ keywords: - grafana - docs - stat panel +labels: + products: + - cloud + - enterprise + - oss title: Stat weight: 900 --- diff --git a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md index 151ab5a5010..f7d51a17e0a 100644 --- a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md +++ b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md @@ -8,6 +8,11 @@ keywords: - docs - state timeline - panel +labels: + products: + - cloud + - enterprise + - oss title: State timeline weight: 900 --- diff --git a/docs/sources/panels-visualizations/visualizations/status-history/index.md b/docs/sources/panels-visualizations/visualizations/status-history/index.md index e633829657e..65ff3032f97 100644 --- a/docs/sources/panels-visualizations/visualizations/status-history/index.md +++ b/docs/sources/panels-visualizations/visualizations/status-history/index.md @@ -8,6 +8,11 @@ keywords: - docs - status history - panel +labels: + products: + - cloud + - enterprise + - oss title: Status history weight: 900 --- diff --git a/docs/sources/panels-visualizations/visualizations/table/index.md b/docs/sources/panels-visualizations/visualizations/table/index.md index f935951d558..fe932bf0e64 100644 --- a/docs/sources/panels-visualizations/visualizations/table/index.md +++ b/docs/sources/panels-visualizations/visualizations/table/index.md @@ -16,6 +16,11 @@ keywords: - format tables - table filter - filter columns +labels: + products: + - cloud + - enterprise + - oss menuTitle: Table title: Table weight: 1000 diff --git a/docs/sources/panels-visualizations/visualizations/text/index.md b/docs/sources/panels-visualizations/visualizations/text/index.md index 403e2d3f0f7..0e49b32e1c9 100644 --- a/docs/sources/panels-visualizations/visualizations/text/index.md +++ b/docs/sources/panels-visualizations/visualizations/text/index.md @@ -9,6 +9,11 @@ keywords: - text - documentation - panel +labels: + products: + - cloud + - enterprise + - oss title: Text weight: 1100 --- diff --git a/docs/sources/panels-visualizations/visualizations/time-series/index.md b/docs/sources/panels-visualizations/visualizations/time-series/index.md index 2b3e56758f7..d21ae947211 100644 --- a/docs/sources/panels-visualizations/visualizations/time-series/index.md +++ b/docs/sources/panels-visualizations/visualizations/time-series/index.md @@ -24,6 +24,11 @@ keywords: - documentation - guide - graph +labels: + products: + - cloud + - enterprise + - oss title: Time series weight: 90 --- diff --git a/docs/sources/panels-visualizations/visualizations/traces/index.md b/docs/sources/panels-visualizations/visualizations/traces/index.md index bd14624f945..489ecb03f0c 100644 --- a/docs/sources/panels-visualizations/visualizations/traces/index.md +++ b/docs/sources/panels-visualizations/visualizations/traces/index.md @@ -7,6 +7,11 @@ keywords: - documentation - panels - traces +labels: + products: + - cloud + - enterprise + - oss title: Traces weight: 850 --- diff --git a/docs/sources/panels-visualizations/visualizations/trend/index.md b/docs/sources/panels-visualizations/visualizations/trend/index.md index 1ad28738727..5d02c0f1264 100644 --- a/docs/sources/panels-visualizations/visualizations/trend/index.md +++ b/docs/sources/panels-visualizations/visualizations/trend/index.md @@ -7,6 +7,11 @@ keywords: - guide - graph - line chart +labels: + products: + - cloud + - enterprise + - oss title: Trend weight: 1200 --- diff --git a/docs/sources/release-notes/_index.md b/docs/sources/release-notes/_index.md index 9873fef84c3..bdc839a1df3 100644 --- a/docs/sources/release-notes/_index.md +++ b/docs/sources/release-notes/_index.md @@ -1,4 +1,9 @@ --- +labels: + products: + - cloud + - enterprise + - oss title: Release notes weight: 10000 --- diff --git a/docs/sources/release-notes/release-notes-7-3-0.md b/docs/sources/release-notes/release-notes-7-3-0.md index 03291886cbf..156b9a42c30 100644 --- a/docs/sources/release-notes/release-notes-7-3-0.md +++ b/docs/sources/release-notes/release-notes-7-3-0.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.3.0 --- diff --git a/docs/sources/release-notes/release-notes-7-3-1.md b/docs/sources/release-notes/release-notes-7-3-1.md index dbe07540b19..ee224a208c9 100644 --- a/docs/sources/release-notes/release-notes-7-3-1.md +++ b/docs/sources/release-notes/release-notes-7-3-1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.3.1 --- diff --git a/docs/sources/release-notes/release-notes-7-3-10.md b/docs/sources/release-notes/release-notes-7-3-10.md index a5425da057e..bec4e5397d7 100644 --- a/docs/sources/release-notes/release-notes-7-3-10.md +++ b/docs/sources/release-notes/release-notes-7-3-10.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.3.10 --- diff --git a/docs/sources/release-notes/release-notes-7-3-2.md b/docs/sources/release-notes/release-notes-7-3-2.md index 5e184d43651..41635c59605 100644 --- a/docs/sources/release-notes/release-notes-7-3-2.md +++ b/docs/sources/release-notes/release-notes-7-3-2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.3.2 --- diff --git a/docs/sources/release-notes/release-notes-7-3-3.md b/docs/sources/release-notes/release-notes-7-3-3.md index d5b71bfd432..3f8c4b01731 100644 --- a/docs/sources/release-notes/release-notes-7-3-3.md +++ b/docs/sources/release-notes/release-notes-7-3-3.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.3.3 --- diff --git a/docs/sources/release-notes/release-notes-7-3-4.md b/docs/sources/release-notes/release-notes-7-3-4.md index 0cc5c76fb50..3bdc4846283 100644 --- a/docs/sources/release-notes/release-notes-7-3-4.md +++ b/docs/sources/release-notes/release-notes-7-3-4.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.3.4 --- diff --git a/docs/sources/release-notes/release-notes-7-3-5.md b/docs/sources/release-notes/release-notes-7-3-5.md index 1a2a0484e5b..0e18bb060b1 100644 --- a/docs/sources/release-notes/release-notes-7-3-5.md +++ b/docs/sources/release-notes/release-notes-7-3-5.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.3.5 --- diff --git a/docs/sources/release-notes/release-notes-7-3-6.md b/docs/sources/release-notes/release-notes-7-3-6.md index fb40b10f3be..2b9f7ad2b35 100644 --- a/docs/sources/release-notes/release-notes-7-3-6.md +++ b/docs/sources/release-notes/release-notes-7-3-6.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.3.6 --- diff --git a/docs/sources/release-notes/release-notes-7-3-7.md b/docs/sources/release-notes/release-notes-7-3-7.md index add24b19ab8..73b782858b3 100644 --- a/docs/sources/release-notes/release-notes-7-3-7.md +++ b/docs/sources/release-notes/release-notes-7-3-7.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.3.7 --- diff --git a/docs/sources/release-notes/release-notes-7-4-0.md b/docs/sources/release-notes/release-notes-7-4-0.md index 5bb5f9aff00..57e16aca6f5 100644 --- a/docs/sources/release-notes/release-notes-7-4-0.md +++ b/docs/sources/release-notes/release-notes-7-4-0.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.4.0 --- diff --git a/docs/sources/release-notes/release-notes-7-4-1.md b/docs/sources/release-notes/release-notes-7-4-1.md index 356c3eaa1db..bce666062e8 100644 --- a/docs/sources/release-notes/release-notes-7-4-1.md +++ b/docs/sources/release-notes/release-notes-7-4-1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.4.1 --- diff --git a/docs/sources/release-notes/release-notes-7-4-2.md b/docs/sources/release-notes/release-notes-7-4-2.md index ae74a6f989c..b854f434b43 100644 --- a/docs/sources/release-notes/release-notes-7-4-2.md +++ b/docs/sources/release-notes/release-notes-7-4-2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.4.2 --- diff --git a/docs/sources/release-notes/release-notes-7-4-3.md b/docs/sources/release-notes/release-notes-7-4-3.md index 68b479fb789..f47528978f2 100644 --- a/docs/sources/release-notes/release-notes-7-4-3.md +++ b/docs/sources/release-notes/release-notes-7-4-3.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.4.3 --- diff --git a/docs/sources/release-notes/release-notes-7-4-5.md b/docs/sources/release-notes/release-notes-7-4-5.md index 2550b295363..4fc8acfa8a2 100644 --- a/docs/sources/release-notes/release-notes-7-4-5.md +++ b/docs/sources/release-notes/release-notes-7-4-5.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.4.5 --- diff --git a/docs/sources/release-notes/release-notes-7-5-0-beta1.md b/docs/sources/release-notes/release-notes-7-5-0-beta1.md index de845a23448..6a32b1442f2 100644 --- a/docs/sources/release-notes/release-notes-7-5-0-beta1.md +++ b/docs/sources/release-notes/release-notes-7-5-0-beta1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.0-beta1 --- diff --git a/docs/sources/release-notes/release-notes-7-5-0-beta2.md b/docs/sources/release-notes/release-notes-7-5-0-beta2.md index 64c6eb4a1a5..42b574fe0dc 100644 --- a/docs/sources/release-notes/release-notes-7-5-0-beta2.md +++ b/docs/sources/release-notes/release-notes-7-5-0-beta2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.0-beta2 --- diff --git a/docs/sources/release-notes/release-notes-7-5-0.md b/docs/sources/release-notes/release-notes-7-5-0.md index 5be1d0fdb34..9307d219889 100644 --- a/docs/sources/release-notes/release-notes-7-5-0.md +++ b/docs/sources/release-notes/release-notes-7-5-0.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.0 --- diff --git a/docs/sources/release-notes/release-notes-7-5-1.md b/docs/sources/release-notes/release-notes-7-5-1.md index d517fccbed9..4c0a1351caa 100644 --- a/docs/sources/release-notes/release-notes-7-5-1.md +++ b/docs/sources/release-notes/release-notes-7-5-1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.1 --- diff --git a/docs/sources/release-notes/release-notes-7-5-10.md b/docs/sources/release-notes/release-notes-7-5-10.md index 5b5aa3a3505..d67dceb63f7 100644 --- a/docs/sources/release-notes/release-notes-7-5-10.md +++ b/docs/sources/release-notes/release-notes-7-5-10.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.10 --- diff --git a/docs/sources/release-notes/release-notes-7-5-11.md b/docs/sources/release-notes/release-notes-7-5-11.md index 6c258c57036..a11566efb12 100644 --- a/docs/sources/release-notes/release-notes-7-5-11.md +++ b/docs/sources/release-notes/release-notes-7-5-11.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.11 --- diff --git a/docs/sources/release-notes/release-notes-7-5-12.md b/docs/sources/release-notes/release-notes-7-5-12.md index df0e293c4cb..28ccfbc117b 100644 --- a/docs/sources/release-notes/release-notes-7-5-12.md +++ b/docs/sources/release-notes/release-notes-7-5-12.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.12 --- diff --git a/docs/sources/release-notes/release-notes-7-5-13.md b/docs/sources/release-notes/release-notes-7-5-13.md index e61ce4ef069..b0dadf61338 100644 --- a/docs/sources/release-notes/release-notes-7-5-13.md +++ b/docs/sources/release-notes/release-notes-7-5-13.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.13 --- diff --git a/docs/sources/release-notes/release-notes-7-5-15.md b/docs/sources/release-notes/release-notes-7-5-15.md index 3470e253ab2..a1a8a0a7956 100644 --- a/docs/sources/release-notes/release-notes-7-5-15.md +++ b/docs/sources/release-notes/release-notes-7-5-15.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.15 --- diff --git a/docs/sources/release-notes/release-notes-7-5-2.md b/docs/sources/release-notes/release-notes-7-5-2.md index c478a7e2e6b..8935563f6f7 100644 --- a/docs/sources/release-notes/release-notes-7-5-2.md +++ b/docs/sources/release-notes/release-notes-7-5-2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.2 --- diff --git a/docs/sources/release-notes/release-notes-7-5-3.md b/docs/sources/release-notes/release-notes-7-5-3.md index 55c31305e9c..381559d0cfa 100644 --- a/docs/sources/release-notes/release-notes-7-5-3.md +++ b/docs/sources/release-notes/release-notes-7-5-3.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.3 --- diff --git a/docs/sources/release-notes/release-notes-7-5-4.md b/docs/sources/release-notes/release-notes-7-5-4.md index 2a2104614b6..63974b41b8d 100644 --- a/docs/sources/release-notes/release-notes-7-5-4.md +++ b/docs/sources/release-notes/release-notes-7-5-4.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.4 --- diff --git a/docs/sources/release-notes/release-notes-7-5-5.md b/docs/sources/release-notes/release-notes-7-5-5.md index fb940024c88..66c22b37743 100644 --- a/docs/sources/release-notes/release-notes-7-5-5.md +++ b/docs/sources/release-notes/release-notes-7-5-5.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.5 --- diff --git a/docs/sources/release-notes/release-notes-7-5-6.md b/docs/sources/release-notes/release-notes-7-5-6.md index cf4598225a1..562cae49b5b 100644 --- a/docs/sources/release-notes/release-notes-7-5-6.md +++ b/docs/sources/release-notes/release-notes-7-5-6.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.6 --- diff --git a/docs/sources/release-notes/release-notes-7-5-7.md b/docs/sources/release-notes/release-notes-7-5-7.md index f52ca7a98d2..80980c875de 100644 --- a/docs/sources/release-notes/release-notes-7-5-7.md +++ b/docs/sources/release-notes/release-notes-7-5-7.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.7 --- diff --git a/docs/sources/release-notes/release-notes-7-5-8.md b/docs/sources/release-notes/release-notes-7-5-8.md index f034be7dabe..96a82405517 100644 --- a/docs/sources/release-notes/release-notes-7-5-8.md +++ b/docs/sources/release-notes/release-notes-7-5-8.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.8 --- diff --git a/docs/sources/release-notes/release-notes-7-5-9.md b/docs/sources/release-notes/release-notes-7-5-9.md index 864d8658659..f78005ea30a 100644 --- a/docs/sources/release-notes/release-notes-7-5-9.md +++ b/docs/sources/release-notes/release-notes-7-5-9.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 7.5.9 --- diff --git a/docs/sources/release-notes/release-notes-8-0-0-beta1.md b/docs/sources/release-notes/release-notes-8-0-0-beta1.md index 371f77cb296..a1f3d5fd385 100644 --- a/docs/sources/release-notes/release-notes-8-0-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-0-0-beta1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.0-beta1 --- diff --git a/docs/sources/release-notes/release-notes-8-0-0-beta2.md b/docs/sources/release-notes/release-notes-8-0-0-beta2.md index cf4429112e3..9ef5242c927 100644 --- a/docs/sources/release-notes/release-notes-8-0-0-beta2.md +++ b/docs/sources/release-notes/release-notes-8-0-0-beta2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.0-beta2 --- diff --git a/docs/sources/release-notes/release-notes-8-0-0-beta3.md b/docs/sources/release-notes/release-notes-8-0-0-beta3.md index d34cc2c9e5a..9e8f3fa7893 100644 --- a/docs/sources/release-notes/release-notes-8-0-0-beta3.md +++ b/docs/sources/release-notes/release-notes-8-0-0-beta3.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.0-beta3 --- diff --git a/docs/sources/release-notes/release-notes-8-0-0.md b/docs/sources/release-notes/release-notes-8-0-0.md index ce6d87ac25f..0783d464720 100644 --- a/docs/sources/release-notes/release-notes-8-0-0.md +++ b/docs/sources/release-notes/release-notes-8-0-0.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.0 --- diff --git a/docs/sources/release-notes/release-notes-8-0-1.md b/docs/sources/release-notes/release-notes-8-0-1.md index 95069611cc2..97a10754b1d 100644 --- a/docs/sources/release-notes/release-notes-8-0-1.md +++ b/docs/sources/release-notes/release-notes-8-0-1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.1 --- diff --git a/docs/sources/release-notes/release-notes-8-0-2.md b/docs/sources/release-notes/release-notes-8-0-2.md index e4eb4943c8f..72304c0595a 100644 --- a/docs/sources/release-notes/release-notes-8-0-2.md +++ b/docs/sources/release-notes/release-notes-8-0-2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.2 --- diff --git a/docs/sources/release-notes/release-notes-8-0-3.md b/docs/sources/release-notes/release-notes-8-0-3.md index 0958b0f4dff..7088755955b 100644 --- a/docs/sources/release-notes/release-notes-8-0-3.md +++ b/docs/sources/release-notes/release-notes-8-0-3.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.3 --- diff --git a/docs/sources/release-notes/release-notes-8-0-4.md b/docs/sources/release-notes/release-notes-8-0-4.md index 9a174cd9c3f..8cd08b4150a 100644 --- a/docs/sources/release-notes/release-notes-8-0-4.md +++ b/docs/sources/release-notes/release-notes-8-0-4.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.4 --- diff --git a/docs/sources/release-notes/release-notes-8-0-5.md b/docs/sources/release-notes/release-notes-8-0-5.md index dfb9896dfbc..cdb4b1d10a0 100644 --- a/docs/sources/release-notes/release-notes-8-0-5.md +++ b/docs/sources/release-notes/release-notes-8-0-5.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.5 --- diff --git a/docs/sources/release-notes/release-notes-8-0-6.md b/docs/sources/release-notes/release-notes-8-0-6.md index 4f216090b77..1fb3572d0d4 100644 --- a/docs/sources/release-notes/release-notes-8-0-6.md +++ b/docs/sources/release-notes/release-notes-8-0-6.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.6 --- diff --git a/docs/sources/release-notes/release-notes-8-0-7.md b/docs/sources/release-notes/release-notes-8-0-7.md index aac854a8f6c..77f2071843b 100644 --- a/docs/sources/release-notes/release-notes-8-0-7.md +++ b/docs/sources/release-notes/release-notes-8-0-7.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.0.7 --- diff --git a/docs/sources/release-notes/release-notes-8-1-0-beta1.md b/docs/sources/release-notes/release-notes-8-1-0-beta1.md index 5f22c67368a..980c59f695f 100644 --- a/docs/sources/release-notes/release-notes-8-1-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-1-0-beta1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.0-beta1 --- diff --git a/docs/sources/release-notes/release-notes-8-1-0-beta2.md b/docs/sources/release-notes/release-notes-8-1-0-beta2.md index 0782b758daa..e9ba04da4af 100644 --- a/docs/sources/release-notes/release-notes-8-1-0-beta2.md +++ b/docs/sources/release-notes/release-notes-8-1-0-beta2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.0-beta2 --- diff --git a/docs/sources/release-notes/release-notes-8-1-0-beta3.md b/docs/sources/release-notes/release-notes-8-1-0-beta3.md index accf7ca7d45..616bdaaa850 100644 --- a/docs/sources/release-notes/release-notes-8-1-0-beta3.md +++ b/docs/sources/release-notes/release-notes-8-1-0-beta3.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.0-beta3 --- diff --git a/docs/sources/release-notes/release-notes-8-1-0.md b/docs/sources/release-notes/release-notes-8-1-0.md index 3e384e2021e..e94b8ebe810 100644 --- a/docs/sources/release-notes/release-notes-8-1-0.md +++ b/docs/sources/release-notes/release-notes-8-1-0.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.0 --- diff --git a/docs/sources/release-notes/release-notes-8-1-1.md b/docs/sources/release-notes/release-notes-8-1-1.md index cff0d6e1bcd..f04cbb02705 100644 --- a/docs/sources/release-notes/release-notes-8-1-1.md +++ b/docs/sources/release-notes/release-notes-8-1-1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.1 --- diff --git a/docs/sources/release-notes/release-notes-8-1-2.md b/docs/sources/release-notes/release-notes-8-1-2.md index 15e9e2cadc4..d015fe7218c 100644 --- a/docs/sources/release-notes/release-notes-8-1-2.md +++ b/docs/sources/release-notes/release-notes-8-1-2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.2 --- diff --git a/docs/sources/release-notes/release-notes-8-1-3.md b/docs/sources/release-notes/release-notes-8-1-3.md index df829e7434f..a15cd051019 100644 --- a/docs/sources/release-notes/release-notes-8-1-3.md +++ b/docs/sources/release-notes/release-notes-8-1-3.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.3 --- diff --git a/docs/sources/release-notes/release-notes-8-1-4.md b/docs/sources/release-notes/release-notes-8-1-4.md index 728e5db47d4..4cd3c036eb5 100644 --- a/docs/sources/release-notes/release-notes-8-1-4.md +++ b/docs/sources/release-notes/release-notes-8-1-4.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.4 --- diff --git a/docs/sources/release-notes/release-notes-8-1-5.md b/docs/sources/release-notes/release-notes-8-1-5.md index afbbf4ffabd..c224f333128 100644 --- a/docs/sources/release-notes/release-notes-8-1-5.md +++ b/docs/sources/release-notes/release-notes-8-1-5.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.5 --- diff --git a/docs/sources/release-notes/release-notes-8-1-6.md b/docs/sources/release-notes/release-notes-8-1-6.md index b9a8824cdfa..fb62fd32e59 100644 --- a/docs/sources/release-notes/release-notes-8-1-6.md +++ b/docs/sources/release-notes/release-notes-8-1-6.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.6 --- diff --git a/docs/sources/release-notes/release-notes-8-1-7.md b/docs/sources/release-notes/release-notes-8-1-7.md index 881bb675298..6c1e5abc411 100644 --- a/docs/sources/release-notes/release-notes-8-1-7.md +++ b/docs/sources/release-notes/release-notes-8-1-7.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.7 --- diff --git a/docs/sources/release-notes/release-notes-8-1-8.md b/docs/sources/release-notes/release-notes-8-1-8.md index 5c40a3fbb2d..ad2388e6ed1 100644 --- a/docs/sources/release-notes/release-notes-8-1-8.md +++ b/docs/sources/release-notes/release-notes-8-1-8.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.1.8 --- diff --git a/docs/sources/release-notes/release-notes-8-2-0-beta1.md b/docs/sources/release-notes/release-notes-8-2-0-beta1.md index 4ea05ce9f01..1d0934c3957 100644 --- a/docs/sources/release-notes/release-notes-8-2-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-2-0-beta1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.0-beta1 --- diff --git a/docs/sources/release-notes/release-notes-8-2-0-beta2.md b/docs/sources/release-notes/release-notes-8-2-0-beta2.md index 096e061496f..a0f6b931534 100644 --- a/docs/sources/release-notes/release-notes-8-2-0-beta2.md +++ b/docs/sources/release-notes/release-notes-8-2-0-beta2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.0-beta2 --- diff --git a/docs/sources/release-notes/release-notes-8-2-0.md b/docs/sources/release-notes/release-notes-8-2-0.md index fe578e10fa5..25d61e450ea 100644 --- a/docs/sources/release-notes/release-notes-8-2-0.md +++ b/docs/sources/release-notes/release-notes-8-2-0.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.0 --- diff --git a/docs/sources/release-notes/release-notes-8-2-1.md b/docs/sources/release-notes/release-notes-8-2-1.md index 12a1c16627a..67994dab057 100644 --- a/docs/sources/release-notes/release-notes-8-2-1.md +++ b/docs/sources/release-notes/release-notes-8-2-1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.1 --- diff --git a/docs/sources/release-notes/release-notes-8-2-2.md b/docs/sources/release-notes/release-notes-8-2-2.md index 43657411271..304de3d666a 100644 --- a/docs/sources/release-notes/release-notes-8-2-2.md +++ b/docs/sources/release-notes/release-notes-8-2-2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.2 --- diff --git a/docs/sources/release-notes/release-notes-8-2-3.md b/docs/sources/release-notes/release-notes-8-2-3.md index c4cd158bd00..b0c344e1201 100644 --- a/docs/sources/release-notes/release-notes-8-2-3.md +++ b/docs/sources/release-notes/release-notes-8-2-3.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.3 --- diff --git a/docs/sources/release-notes/release-notes-8-2-4.md b/docs/sources/release-notes/release-notes-8-2-4.md index d06750adcd2..b1f40cd8a70 100644 --- a/docs/sources/release-notes/release-notes-8-2-4.md +++ b/docs/sources/release-notes/release-notes-8-2-4.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.4 --- diff --git a/docs/sources/release-notes/release-notes-8-2-5.md b/docs/sources/release-notes/release-notes-8-2-5.md index 542f391f795..bf180886a25 100644 --- a/docs/sources/release-notes/release-notes-8-2-5.md +++ b/docs/sources/release-notes/release-notes-8-2-5.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.5 --- diff --git a/docs/sources/release-notes/release-notes-8-2-6.md b/docs/sources/release-notes/release-notes-8-2-6.md index 3e671d3025d..b5f5baf0d2b 100644 --- a/docs/sources/release-notes/release-notes-8-2-6.md +++ b/docs/sources/release-notes/release-notes-8-2-6.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.6 --- diff --git a/docs/sources/release-notes/release-notes-8-2-7.md b/docs/sources/release-notes/release-notes-8-2-7.md index ea4e741c116..fa52252bff0 100644 --- a/docs/sources/release-notes/release-notes-8-2-7.md +++ b/docs/sources/release-notes/release-notes-8-2-7.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.2.7 --- diff --git a/docs/sources/release-notes/release-notes-8-3-0-beta1.md b/docs/sources/release-notes/release-notes-8-3-0-beta1.md index ff4419e3611..a22f1d4e568 100644 --- a/docs/sources/release-notes/release-notes-8-3-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-3-0-beta1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.0-beta1 --- diff --git a/docs/sources/release-notes/release-notes-8-3-0-beta2.md b/docs/sources/release-notes/release-notes-8-3-0-beta2.md index a60d31768cf..7d894dae66a 100644 --- a/docs/sources/release-notes/release-notes-8-3-0-beta2.md +++ b/docs/sources/release-notes/release-notes-8-3-0-beta2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.0-beta2 --- diff --git a/docs/sources/release-notes/release-notes-8-3-0.md b/docs/sources/release-notes/release-notes-8-3-0.md index 1e194c5a0f7..bea49d9ade5 100644 --- a/docs/sources/release-notes/release-notes-8-3-0.md +++ b/docs/sources/release-notes/release-notes-8-3-0.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.0 --- diff --git a/docs/sources/release-notes/release-notes-8-3-1.md b/docs/sources/release-notes/release-notes-8-3-1.md index 3d7503f75a8..6d7f0c986ac 100644 --- a/docs/sources/release-notes/release-notes-8-3-1.md +++ b/docs/sources/release-notes/release-notes-8-3-1.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.1 --- diff --git a/docs/sources/release-notes/release-notes-8-3-11.md b/docs/sources/release-notes/release-notes-8-3-11.md index 05d0b7ebd5f..a14d5789f5b 100644 --- a/docs/sources/release-notes/release-notes-8-3-11.md +++ b/docs/sources/release-notes/release-notes-8-3-11.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.11 --- diff --git a/docs/sources/release-notes/release-notes-8-3-2.md b/docs/sources/release-notes/release-notes-8-3-2.md index fe46ed1be0b..4f9a0d38e34 100644 --- a/docs/sources/release-notes/release-notes-8-3-2.md +++ b/docs/sources/release-notes/release-notes-8-3-2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.2 --- diff --git a/docs/sources/release-notes/release-notes-8-3-3.md b/docs/sources/release-notes/release-notes-8-3-3.md index 4545111b4eb..fcf72987cbd 100644 --- a/docs/sources/release-notes/release-notes-8-3-3.md +++ b/docs/sources/release-notes/release-notes-8-3-3.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.3 --- diff --git a/docs/sources/release-notes/release-notes-8-3-4.md b/docs/sources/release-notes/release-notes-8-3-4.md index f5396d6d7e7..cd2abf45b03 100644 --- a/docs/sources/release-notes/release-notes-8-3-4.md +++ b/docs/sources/release-notes/release-notes-8-3-4.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.4 --- diff --git a/docs/sources/release-notes/release-notes-8-3-5.md b/docs/sources/release-notes/release-notes-8-3-5.md index 8d3e5c5ebd4..f4b67584c0e 100644 --- a/docs/sources/release-notes/release-notes-8-3-5.md +++ b/docs/sources/release-notes/release-notes-8-3-5.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.5 --- diff --git a/docs/sources/release-notes/release-notes-8-3-6.md b/docs/sources/release-notes/release-notes-8-3-6.md index 919e3c4b946..c9b0ba1c542 100644 --- a/docs/sources/release-notes/release-notes-8-3-6.md +++ b/docs/sources/release-notes/release-notes-8-3-6.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.6 --- diff --git a/docs/sources/release-notes/release-notes-8-3-7.md b/docs/sources/release-notes/release-notes-8-3-7.md index b48f6d7949a..a5d67866c68 100644 --- a/docs/sources/release-notes/release-notes-8-3-7.md +++ b/docs/sources/release-notes/release-notes-8-3-7.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.3.7 --- diff --git a/docs/sources/release-notes/release-notes-8-4-0-beta1.md b/docs/sources/release-notes/release-notes-8-4-0-beta1.md index 7328e2abd20..dd1da255367 100644 --- a/docs/sources/release-notes/release-notes-8-4-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-4-0-beta1.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.0-beta1 --- diff --git a/docs/sources/release-notes/release-notes-8-4-0.md b/docs/sources/release-notes/release-notes-8-4-0.md index dbb92df633f..b5947e7cc76 100644 --- a/docs/sources/release-notes/release-notes-8-4-0.md +++ b/docs/sources/release-notes/release-notes-8-4-0.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.0 --- diff --git a/docs/sources/release-notes/release-notes-8-4-1.md b/docs/sources/release-notes/release-notes-8-4-1.md index a9be18ca394..4c4ef609f3e 100644 --- a/docs/sources/release-notes/release-notes-8-4-1.md +++ b/docs/sources/release-notes/release-notes-8-4-1.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.1 --- diff --git a/docs/sources/release-notes/release-notes-8-4-10.md b/docs/sources/release-notes/release-notes-8-4-10.md index cac1371f572..e3bfeaa70d0 100644 --- a/docs/sources/release-notes/release-notes-8-4-10.md +++ b/docs/sources/release-notes/release-notes-8-4-10.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.10 --- diff --git a/docs/sources/release-notes/release-notes-8-4-11.md b/docs/sources/release-notes/release-notes-8-4-11.md index 413ccbfe301..9ad601baafd 100644 --- a/docs/sources/release-notes/release-notes-8-4-11.md +++ b/docs/sources/release-notes/release-notes-8-4-11.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.11 --- diff --git a/docs/sources/release-notes/release-notes-8-4-2.md b/docs/sources/release-notes/release-notes-8-4-2.md index ecece22c9e2..249b552a3e6 100644 --- a/docs/sources/release-notes/release-notes-8-4-2.md +++ b/docs/sources/release-notes/release-notes-8-4-2.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.2 --- diff --git a/docs/sources/release-notes/release-notes-8-4-3.md b/docs/sources/release-notes/release-notes-8-4-3.md index 3bbe37a9751..6ed87292ed7 100644 --- a/docs/sources/release-notes/release-notes-8-4-3.md +++ b/docs/sources/release-notes/release-notes-8-4-3.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.3 --- diff --git a/docs/sources/release-notes/release-notes-8-4-4.md b/docs/sources/release-notes/release-notes-8-4-4.md index 49afa491013..a372a519f5a 100644 --- a/docs/sources/release-notes/release-notes-8-4-4.md +++ b/docs/sources/release-notes/release-notes-8-4-4.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.4 --- diff --git a/docs/sources/release-notes/release-notes-8-4-5.md b/docs/sources/release-notes/release-notes-8-4-5.md index 5c7d6c499d5..67568d62494 100644 --- a/docs/sources/release-notes/release-notes-8-4-5.md +++ b/docs/sources/release-notes/release-notes-8-4-5.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.5 --- diff --git a/docs/sources/release-notes/release-notes-8-4-6.md b/docs/sources/release-notes/release-notes-8-4-6.md index 123a029cda7..51119129c99 100644 --- a/docs/sources/release-notes/release-notes-8-4-6.md +++ b/docs/sources/release-notes/release-notes-8-4-6.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.6 --- diff --git a/docs/sources/release-notes/release-notes-8-4-7.md b/docs/sources/release-notes/release-notes-8-4-7.md index 24564ba6d93..43f43da0cb7 100644 --- a/docs/sources/release-notes/release-notes-8-4-7.md +++ b/docs/sources/release-notes/release-notes-8-4-7.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.4.7 --- diff --git a/docs/sources/release-notes/release-notes-8-5-0-beta1.md b/docs/sources/release-notes/release-notes-8-5-0-beta1.md index 6cd5eb6a4c1..6172d345564 100644 --- a/docs/sources/release-notes/release-notes-8-5-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-5-0-beta1.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.0-beta1 --- diff --git a/docs/sources/release-notes/release-notes-8-5-0.md b/docs/sources/release-notes/release-notes-8-5-0.md index 9ea04a4b249..1c8c2e8ac52 100644 --- a/docs/sources/release-notes/release-notes-8-5-0.md +++ b/docs/sources/release-notes/release-notes-8-5-0.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.0 --- diff --git a/docs/sources/release-notes/release-notes-8-5-1.md b/docs/sources/release-notes/release-notes-8-5-1.md index e5ad6085d17..e0845e7cc28 100644 --- a/docs/sources/release-notes/release-notes-8-5-1.md +++ b/docs/sources/release-notes/release-notes-8-5-1.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.1 --- diff --git a/docs/sources/release-notes/release-notes-8-5-10.md b/docs/sources/release-notes/release-notes-8-5-10.md index 20a9851fb8a..c1e4c974852 100644 --- a/docs/sources/release-notes/release-notes-8-5-10.md +++ b/docs/sources/release-notes/release-notes-8-5-10.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.10 --- diff --git a/docs/sources/release-notes/release-notes-8-5-11.md b/docs/sources/release-notes/release-notes-8-5-11.md index a5faa53f168..4ca08c037d3 100644 --- a/docs/sources/release-notes/release-notes-8-5-11.md +++ b/docs/sources/release-notes/release-notes-8-5-11.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.11 --- diff --git a/docs/sources/release-notes/release-notes-8-5-13.md b/docs/sources/release-notes/release-notes-8-5-13.md index c407e045948..8c671db57bb 100644 --- a/docs/sources/release-notes/release-notes-8-5-13.md +++ b/docs/sources/release-notes/release-notes-8-5-13.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.13 --- diff --git a/docs/sources/release-notes/release-notes-8-5-2.md b/docs/sources/release-notes/release-notes-8-5-2.md index 8da0882f8d3..0764583e1a5 100644 --- a/docs/sources/release-notes/release-notes-8-5-2.md +++ b/docs/sources/release-notes/release-notes-8-5-2.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.2 --- diff --git a/docs/sources/release-notes/release-notes-8-5-3.md b/docs/sources/release-notes/release-notes-8-5-3.md index e1cf44deacd..728f6764276 100644 --- a/docs/sources/release-notes/release-notes-8-5-3.md +++ b/docs/sources/release-notes/release-notes-8-5-3.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.3 --- diff --git a/docs/sources/release-notes/release-notes-8-5-4.md b/docs/sources/release-notes/release-notes-8-5-4.md index 9d96406c0db..ca013340e7e 100644 --- a/docs/sources/release-notes/release-notes-8-5-4.md +++ b/docs/sources/release-notes/release-notes-8-5-4.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.4 --- diff --git a/docs/sources/release-notes/release-notes-8-5-5.md b/docs/sources/release-notes/release-notes-8-5-5.md index dbc87678b43..459b2f4fa47 100644 --- a/docs/sources/release-notes/release-notes-8-5-5.md +++ b/docs/sources/release-notes/release-notes-8-5-5.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.5 --- diff --git a/docs/sources/release-notes/release-notes-8-5-6.md b/docs/sources/release-notes/release-notes-8-5-6.md index bdf949ce6aa..912378f7be8 100644 --- a/docs/sources/release-notes/release-notes-8-5-6.md +++ b/docs/sources/release-notes/release-notes-8-5-6.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.6 --- diff --git a/docs/sources/release-notes/release-notes-8-5-9.md b/docs/sources/release-notes/release-notes-8-5-9.md index 49f82d4c27d..91d3c88af59 100644 --- a/docs/sources/release-notes/release-notes-8-5-9.md +++ b/docs/sources/release-notes/release-notes-8-5-9.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 8.5.9 --- diff --git a/docs/sources/release-notes/release-notes-9-0-0-beta1.md b/docs/sources/release-notes/release-notes-9-0-0-beta1.md index 7160d3f0176..6159ad3b218 100644 --- a/docs/sources/release-notes/release-notes-9-0-0-beta1.md +++ b/docs/sources/release-notes/release-notes-9-0-0-beta1.md @@ -1,5 +1,10 @@ --- hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.0-beta1 --- diff --git a/docs/sources/release-notes/release-notes-9-0-0-beta2.md b/docs/sources/release-notes/release-notes-9-0-0-beta2.md index 811604742c0..095c476d443 100644 --- a/docs/sources/release-notes/release-notes-9-0-0-beta2.md +++ b/docs/sources/release-notes/release-notes-9-0-0-beta2.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.0-beta2 --- diff --git a/docs/sources/release-notes/release-notes-9-0-0-beta3.md b/docs/sources/release-notes/release-notes-9-0-0-beta3.md index 5f73419fbe7..52b337a79d3 100644 --- a/docs/sources/release-notes/release-notes-9-0-0-beta3.md +++ b/docs/sources/release-notes/release-notes-9-0-0-beta3.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.0-beta3 --- diff --git a/docs/sources/release-notes/release-notes-9-0-0.md b/docs/sources/release-notes/release-notes-9-0-0.md index bacaba15f6e..2f6ebae37bb 100644 --- a/docs/sources/release-notes/release-notes-9-0-0.md +++ b/docs/sources/release-notes/release-notes-9-0-0.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.0 --- diff --git a/docs/sources/release-notes/release-notes-9-0-1.md b/docs/sources/release-notes/release-notes-9-0-1.md index 58e2f6aea35..93c18bffa8c 100644 --- a/docs/sources/release-notes/release-notes-9-0-1.md +++ b/docs/sources/release-notes/release-notes-9-0-1.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.1 --- diff --git a/docs/sources/release-notes/release-notes-9-0-2.md b/docs/sources/release-notes/release-notes-9-0-2.md index fef9d9adedf..08d648270c4 100644 --- a/docs/sources/release-notes/release-notes-9-0-2.md +++ b/docs/sources/release-notes/release-notes-9-0-2.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.2 --- diff --git a/docs/sources/release-notes/release-notes-9-0-3.md b/docs/sources/release-notes/release-notes-9-0-3.md index 070e53ab128..0bd6ceb5ae9 100644 --- a/docs/sources/release-notes/release-notes-9-0-3.md +++ b/docs/sources/release-notes/release-notes-9-0-3.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.3 --- diff --git a/docs/sources/release-notes/release-notes-9-0-4.md b/docs/sources/release-notes/release-notes-9-0-4.md index 46be0d0f2a2..8e8f4f68c4e 100644 --- a/docs/sources/release-notes/release-notes-9-0-4.md +++ b/docs/sources/release-notes/release-notes-9-0-4.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.4 --- diff --git a/docs/sources/release-notes/release-notes-9-0-5.md b/docs/sources/release-notes/release-notes-9-0-5.md index e89077d163e..21c0afb2edb 100644 --- a/docs/sources/release-notes/release-notes-9-0-5.md +++ b/docs/sources/release-notes/release-notes-9-0-5.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.5 --- diff --git a/docs/sources/release-notes/release-notes-9-0-6.md b/docs/sources/release-notes/release-notes-9-0-6.md index ee8e7d83489..2667aa909b7 100644 --- a/docs/sources/release-notes/release-notes-9-0-6.md +++ b/docs/sources/release-notes/release-notes-9-0-6.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.6 --- diff --git a/docs/sources/release-notes/release-notes-9-0-7.md b/docs/sources/release-notes/release-notes-9-0-7.md index 5e1a54e4e7f..547ac15f405 100644 --- a/docs/sources/release-notes/release-notes-9-0-7.md +++ b/docs/sources/release-notes/release-notes-9-0-7.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.7 --- diff --git a/docs/sources/release-notes/release-notes-9-0-8.md b/docs/sources/release-notes/release-notes-9-0-8.md index 30f023c34bf..821e2a3fd77 100644 --- a/docs/sources/release-notes/release-notes-9-0-8.md +++ b/docs/sources/release-notes/release-notes-9-0-8.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.8 --- diff --git a/docs/sources/release-notes/release-notes-9-0-9.md b/docs/sources/release-notes/release-notes-9-0-9.md index 25ab2cb0f5a..f300f8cdce6 100644 --- a/docs/sources/release-notes/release-notes-9-0-9.md +++ b/docs/sources/release-notes/release-notes-9-0-9.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.0.9 --- diff --git a/docs/sources/release-notes/release-notes-9-1-0-beta1.md b/docs/sources/release-notes/release-notes-9-1-0-beta1.md index a3288ec3826..8e4758f105c 100644 --- a/docs/sources/release-notes/release-notes-9-1-0-beta1.md +++ b/docs/sources/release-notes/release-notes-9-1-0-beta1.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.1.0-beta1 --- diff --git a/docs/sources/release-notes/release-notes-9-1-0.md b/docs/sources/release-notes/release-notes-9-1-0.md index e31583709af..fd304535ae0 100644 --- a/docs/sources/release-notes/release-notes-9-1-0.md +++ b/docs/sources/release-notes/release-notes-9-1-0.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.1.0 --- diff --git a/docs/sources/release-notes/release-notes-9-1-1.md b/docs/sources/release-notes/release-notes-9-1-1.md index b9cd5af8ef8..6e489dd8b6f 100644 --- a/docs/sources/release-notes/release-notes-9-1-1.md +++ b/docs/sources/release-notes/release-notes-9-1-1.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.1.1 --- diff --git a/docs/sources/release-notes/release-notes-9-1-2.md b/docs/sources/release-notes/release-notes-9-1-2.md index ef7dc3f6643..3ed1f863ab6 100644 --- a/docs/sources/release-notes/release-notes-9-1-2.md +++ b/docs/sources/release-notes/release-notes-9-1-2.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.1.2 --- diff --git a/docs/sources/release-notes/release-notes-9-1-3.md b/docs/sources/release-notes/release-notes-9-1-3.md index e237c765ab4..d0cf502c8d7 100644 --- a/docs/sources/release-notes/release-notes-9-1-3.md +++ b/docs/sources/release-notes/release-notes-9-1-3.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.1.3 --- diff --git a/docs/sources/release-notes/release-notes-9-1-4.md b/docs/sources/release-notes/release-notes-9-1-4.md index 4d2e6734936..c0b03d18768 100644 --- a/docs/sources/release-notes/release-notes-9-1-4.md +++ b/docs/sources/release-notes/release-notes-9-1-4.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.1.4 --- diff --git a/docs/sources/release-notes/release-notes-9-1-5.md b/docs/sources/release-notes/release-notes-9-1-5.md index 4e4605b0a9e..3024d787402 100644 --- a/docs/sources/release-notes/release-notes-9-1-5.md +++ b/docs/sources/release-notes/release-notes-9-1-5.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.1.5 --- diff --git a/docs/sources/release-notes/release-notes-9-1-6.md b/docs/sources/release-notes/release-notes-9-1-6.md index 483e08d8f9c..0a37175b5eb 100644 --- a/docs/sources/release-notes/release-notes-9-1-6.md +++ b/docs/sources/release-notes/release-notes-9-1-6.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.1.6 --- diff --git a/docs/sources/release-notes/release-notes-9-1-7.md b/docs/sources/release-notes/release-notes-9-1-7.md index 2025e4292e3..917936045dc 100644 --- a/docs/sources/release-notes/release-notes-9-1-7.md +++ b/docs/sources/release-notes/release-notes-9-1-7.md @@ -1,6 +1,11 @@ --- aliases: [] hide_menu: true +labels: + products: + - cloud + - enterprise + - oss title: Release notes for Grafana 9.1.7 --- diff --git a/docs/sources/release-notes/release-notes-v7-4-2.md b/docs/sources/release-notes/release-notes-v7-4-2.md index 4fe9fbfc760..ba19e3b2b2e 100644 --- a/docs/sources/release-notes/release-notes-v7-4-2.md +++ b/docs/sources/release-notes/release-notes-v7-4-2.md @@ -1,6 +1,11 @@ --- _build: list: false +labels: + products: + - cloud + - enterprise + - oss title: undefined --- diff --git a/docs/sources/search/_index.md b/docs/sources/search/_index.md index fc49ec14037..2d736973616 100644 --- a/docs/sources/search/_index.md +++ b/docs/sources/search/_index.md @@ -3,6 +3,11 @@ description: Learn how to search for Grafana dashboards keywords: - search - dashboard +labels: + products: + - cloud + - enterprise + - oss menutitle: Search title: Search weight: 80 diff --git a/docs/sources/setup-grafana/_index.md b/docs/sources/setup-grafana/_index.md index fb339d094a6..bd8f66e14e6 100644 --- a/docs/sources/setup-grafana/_index.md +++ b/docs/sources/setup-grafana/_index.md @@ -1,7 +1,11 @@ --- description: Includes topics for setting up a Grafana instance. -title: Set up Grafana +labels: + products: + - enterprise + - oss menuTitle: Set up +title: Set up Grafana weight: 10 --- diff --git a/docs/sources/setup-grafana/configure-docker.md b/docs/sources/setup-grafana/configure-docker.md index d2889dbca07..f70ca7a37b5 100644 --- a/docs/sources/setup-grafana/configure-docker.md +++ b/docs/sources/setup-grafana/configure-docker.md @@ -9,8 +9,12 @@ keywords: - documentation - docker - docker compose -title: Configure a Grafana Docker image +labels: + products: + - enterprise + - oss menuTitle: Configure a Docker image +title: Configure a Grafana Docker image weight: 1800 --- diff --git a/docs/sources/setup-grafana/configure-grafana/_index.md b/docs/sources/setup-grafana/configure-grafana/_index.md index c3db64c55a3..10e67076630 100644 --- a/docs/sources/setup-grafana/configure-grafana/_index.md +++ b/docs/sources/setup-grafana/configure-grafana/_index.md @@ -3,6 +3,10 @@ aliases: - ../administration/configuration/ - ../installation/configuration/ description: Configuration documentation +labels: + products: + - enterprise + - oss title: Configure Grafana weight: 200 --- diff --git a/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md b/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md index 28629fcacf2..26ee1e7a581 100644 --- a/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md +++ b/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md @@ -3,6 +3,10 @@ aliases: - ../../enterprise/white-labeling/ - ../enable-custom-branding/ description: Change the look of Grafana to match your corporate brand. +labels: + products: + - enterprise + - oss title: Configure custom branding weight: 300 --- diff --git a/docs/sources/setup-grafana/configure-grafana/configure-tracing/index.md b/docs/sources/setup-grafana/configure-grafana/configure-tracing/index.md index 7a94c6c3742..50e0e6ea702 100644 --- a/docs/sources/setup-grafana/configure-grafana/configure-tracing/index.md +++ b/docs/sources/setup-grafana/configure-grafana/configure-tracing/index.md @@ -2,9 +2,13 @@ aliases: - ../../troubleshooting/diagnostics/ - ../enable-diagnostics/ +description: Learn how to configure tracing so that you can troubleshoot Grafana. +labels: + products: + - enterprise + - oss menuTitle: Configure tracing title: Configure tracing to troubleshoot Grafana -description: Learn how to configure tracing so that you can troubleshoot Grafana. weight: 200 --- diff --git a/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md b/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md index b89da73aba3..bf0df5380a9 100644 --- a/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md +++ b/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md @@ -2,6 +2,10 @@ aliases: - ../../enterprise/enterprise-configuration/ description: Learn about Grafana Enterprise configuration options that you can specify. +labels: + products: + - enterprise + - oss title: Configure Grafana Enterprise weight: 100 --- diff --git a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md index 34b525fa186..e8ab0a8d446 100644 --- a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md +++ b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md @@ -2,6 +2,10 @@ aliases: - /docs/grafana/latest/setup-grafana/configure-grafana/feature-toggles/ description: Learn about feature toggles, which you can enable or disable. +labels: + products: + - enterprise + - oss title: Configure feature toggles weight: 150 --- diff --git a/docs/sources/setup-grafana/configure-grafana/proxy/index.md b/docs/sources/setup-grafana/configure-grafana/proxy/index.md index bd8227592da..2ad831764cc 100644 --- a/docs/sources/setup-grafana/configure-grafana/proxy/index.md +++ b/docs/sources/setup-grafana/configure-grafana/proxy/index.md @@ -4,8 +4,12 @@ keywords: - proxy - guide - Grafana -title: Configure a data source connection proxy +labels: + products: + - enterprise + - oss menuTitle: Configure data source proxy +title: Configure a data source connection proxy weight: 1110 --- diff --git a/docs/sources/setup-grafana/configure-grafana/settings-updates-at-runtime/index.md b/docs/sources/setup-grafana/configure-grafana/settings-updates-at-runtime/index.md index 72ca5ae789e..5a43030817b 100644 --- a/docs/sources/setup-grafana/configure-grafana/settings-updates-at-runtime/index.md +++ b/docs/sources/setup-grafana/configure-grafana/settings-updates-at-runtime/index.md @@ -6,6 +6,10 @@ keywords: - grafana - runtime - settings +labels: + products: + - enterprise + - oss title: Settings updates at runtime weight: 500 --- diff --git a/docs/sources/setup-grafana/configure-security/_index.md b/docs/sources/setup-grafana/configure-security/_index.md index 3d3c1ab3cf4..715d6d3b284 100644 --- a/docs/sources/setup-grafana/configure-security/_index.md +++ b/docs/sources/setup-grafana/configure-security/_index.md @@ -3,6 +3,10 @@ aliases: - ../administration/security/ - ../installation/security/ description: Learn how to make Grafana secure. +labels: + products: + - enterprise + - oss title: Configure security weight: 600 --- diff --git a/docs/sources/setup-grafana/configure-security/audit-grafana.md b/docs/sources/setup-grafana/configure-security/audit-grafana.md index 699482b2071..a5470ff334f 100644 --- a/docs/sources/setup-grafana/configure-security/audit-grafana.md +++ b/docs/sources/setup-grafana/configure-security/audit-grafana.md @@ -7,6 +7,10 @@ keywords: - auditing - audit - logs +labels: + products: + - cloud + - enterprise title: Audit a Grafana instance weight: 800 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md index 980d8301600..22ef0d65b55 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md @@ -8,6 +8,7 @@ labels: products: - cloud - enterprise + - oss title: Configure authentication weight: 100 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy/index.md index 5f5c54cb58e..48825b13b99 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy/index.md @@ -8,8 +8,13 @@ keywords: - configuration - documentation - proxy -title: Configure auth proxy authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: Auth proxy +title: Configure auth proxy authentication weight: 1500 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md index f99349fddd8..7c3d163a79a 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md @@ -7,8 +7,13 @@ keywords: - configuration - documentation - oauth -title: Configure Azure AD OAuth2 authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: Azure AD OAuth2 +title: Configure Azure AD OAuth2 authentication weight: 800 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md index 6344f7c771e..7dbe7ac5f60 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md @@ -10,8 +10,12 @@ keywords: - ldap - active directory - enterprise -title: Configure enhanced LDAP integration +labels: + products: + - cloud + - enterprise menuTitle: Enhanced LDAP +title: Configure enhanced LDAP integration weight: 400 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md index 17aa7a95ed3..eaddeb891eb 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md @@ -7,8 +7,13 @@ keywords: - configuration - documentation - oauth -title: Configure generic OAuth2 authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: Generic OAuth2 +title: Configure generic OAuth2 authentication weight: 700 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md index 0233fca5adb..940d545a311 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md @@ -7,8 +7,13 @@ keywords: - configuration - documentation - oauth -title: Configure GitHub OAuth2 authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: GitHub OAuth2 +title: Configure GitHub OAuth2 authentication weight: 900 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md index fb17147a693..2eddacc5c22 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md @@ -7,8 +7,13 @@ keywords: - configuration - documentation - oauth -title: Configure GitLab OAuth2 authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: GitLab OAuth2 +title: Configure GitLab OAuth2 authentication weight: 1000 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md index 12759606d8d..8d78022c7d1 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md @@ -2,8 +2,13 @@ aliases: - ../../../auth/google/ description: Grafana OAuthentication Guide -title: Configure Google OAuth2 authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: Google OAuth2 +title: Configure Google OAuth2 authentication weight: 1100 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/grafana-com/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/grafana-com/index.md index 50e3ca8bcf4..b93b0b2bedc 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/grafana-com/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/grafana-com/index.md @@ -2,8 +2,13 @@ aliases: - ../../../auth/grafana-com/ description: Grafana Com Authentication -title: Configure Grafana Com authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: Grafana Com OAuth2 +title: Configure Grafana Com authentication weight: 1200 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/grafana/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/grafana/index.md index 267b6ba78e1..0e5d0721111 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/grafana/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/grafana/index.md @@ -2,8 +2,13 @@ aliases: - ../../../auth/grafana/ description: Grafana OAuthentication Guide -title: Configure Grafana authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: Basic auth +title: Configure Grafana authentication weight: 200 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md index 1de6dcdb4c3..08ebde16948 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md @@ -2,8 +2,13 @@ aliases: - ../../../auth/jwt/ description: Grafana JWT Authentication -title: Configure JWT authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: JWT +title: Configure JWT authentication weight: 1600 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md index f4b28be9b5f..45c2e487c88 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md @@ -8,8 +8,13 @@ keywords: - configuration - documentation - oauth -title: Configure Keycloak OAuth2 authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: Keycloak OAuth2 +title: Configure Keycloak OAuth2 authentication weight: 1300 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/ldap/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/ldap/index.md index 86816877a35..c15e2f2dbd7 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/ldap/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/ldap/index.md @@ -3,8 +3,13 @@ aliases: - ../../../auth/ldap/ - ../../../installation/ldap/ description: Grafana LDAP Authentication Guide -title: Configure LDAP authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: LDAP +title: Configure LDAP authentication weight: 300 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md index 3f712de21dc..e547ae0b778 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md @@ -2,8 +2,13 @@ aliases: - ../../../auth/okta/ description: Grafana Okta OAuth Guide -title: Configure Okta OAuth2 authentication +labels: + products: + - cloud + - enterprise + - oss menuTitle: Okta OAuth2 +title: Configure Okta OAuth2 authentication weight: 1400 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/saml-ui/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/saml-ui/index.md index 0a377d95c39..46af9c8314a 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/saml-ui/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/saml-ui/index.md @@ -1,5 +1,10 @@ --- description: Learn how to configure SAML authentication in Grafana's UI. +labels: + products: + - cloud + - enterprise + - oss menuTitle: SAML user interface title: Configure SAML authentication using the Grafana user interface weight: 600 diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/saml/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/saml/index.md index 40ecfe09265..298d857eb4c 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/saml/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/saml/index.md @@ -8,12 +8,13 @@ aliases: - ../../../enterprise/saml/enable-saml/ - ../../../enterprise/saml/set-up-saml-with-okta/ - ../../../enterprise/saml/troubleshoot-saml/ -description: Learn how to configure SAML authentication in Grafana's configuration file. -menuTitle: SAML +description: Learn how to configure SAML authentication in Grafana's configuration + file. labels: products: - cloud - enterprise +menuTitle: SAML title: Configure SAML authentication using the configuration file weight: 500 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md index b1d4e19aa27..52a34ebc39b 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md @@ -4,6 +4,10 @@ aliases: - ../../enterprise/enterprise-encryption/ description: If you have a Grafana Enterprise license, you can integrate with a variety of key management system providers. +labels: + products: + - enterprise + - oss title: Configure database encryption weight: 700 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms/index.md index 9123c968a3c..32e1c77a279 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms/index.md @@ -2,6 +2,10 @@ aliases: - ../../../enterprise/enterprise-encryption/using-aws-kms-to-encrypt-database-secrets/ description: Learn how to use AWS KMS to encrypt secrets in the Grafana database. +labels: + products: + - enterprise + - oss title: Encrypt database secrets using AWS KMS weight: 300 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault/index.md index 771c6160aaf..7a6b8736c02 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault/index.md @@ -2,6 +2,10 @@ aliases: - ../../../enterprise/enterprise-encryption/using-azure-key-vault-to-encrypt-database-secrets/ description: Learn how to use Azure Key Vault to encrypt secrets in the Grafana database. +labels: + products: + - enterprise + - oss title: Encrypt database secrets using Azure Key Vault weight: 400 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms/index.md index 27af5a90d34..95433c423f5 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms/index.md @@ -2,6 +2,10 @@ aliases: - ../../../enterprise/enterprise-encryption/using-google-cloud-kms-to-encrypt-database-secrets/ description: Learn how to use Google Cloud KMS to encrypt secrets in the Grafana database. +labels: + products: + - enterprise + - oss title: Encrypt database secrets using Google Cloud KMS weight: 100 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/index.md index 60062a8ff0d..b7626e5d603 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/index.md @@ -2,6 +2,10 @@ aliases: - ../../../enterprise/enterprise-encryption/using-hashicorp-key-vault-to-encrypt-database-secrets/ description: Learn how to use Hashicorp Vault to encrypt secrets in the Grafana database. +labels: + products: + - cloud + - enterprise title: Encrypt database secrets using Hashicorp Vault weight: 200 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/index.md index c06898a59f8..2817648ee08 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/index.md @@ -3,6 +3,10 @@ aliases: - ../../../enterprise/vault/ description: Learn how to integrate Grafana with Hashicorp Vault so that you can use secrets for configuration and provisioning. +labels: + products: + - enterprise + - oss title: Integrate Grafana with Hashicorp Vault weight: 500 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-request-security.md b/docs/sources/setup-grafana/configure-security/configure-request-security.md index 0c89800684c..9a2fb05cb9a 100644 --- a/docs/sources/setup-grafana/configure-security/configure-request-security.md +++ b/docs/sources/setup-grafana/configure-security/configure-request-security.md @@ -4,6 +4,11 @@ aliases: description: Request security enables you to limit requests from the Grafana server by targeting requests generated by users, such as data source metric queries and alert notifications. +labels: + products: + - cloud + - enterprise + - oss title: Configure request security weight: 1100 --- diff --git a/docs/sources/setup-grafana/configure-security/configure-security-hardening/index.md b/docs/sources/setup-grafana/configure-security/configure-security-hardening/index.md index 40d153be34f..fd68b7cc40a 100644 --- a/docs/sources/setup-grafana/configure-security/configure-security-hardening/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-security-hardening/index.md @@ -1,7 +1,12 @@ --- aliases: - /docs/grafana/latest/setup-grafana/configure-security/configure-security-hardening/ -description: Security hardening enables you to apply additional security which might stop certain vulnerabilities from being exploited by a malicious attacker. +description: Security hardening enables you to apply additional security which might + stop certain vulnerabilities from being exploited by a malicious attacker. +labels: + products: + - enterprise + - oss title: Configure security hardening --- diff --git a/docs/sources/setup-grafana/configure-security/configure-team-sync.md b/docs/sources/setup-grafana/configure-security/configure-team-sync.md index def907e096b..c503e6c6b62 100644 --- a/docs/sources/setup-grafana/configure-security/configure-team-sync.md +++ b/docs/sources/setup-grafana/configure-security/configure-team-sync.md @@ -4,6 +4,10 @@ aliases: - ../../enterprise/team-sync/ description: Learn how to use Team Sync to synchronize between your authentication provider teams and Grafana teams. +labels: + products: + - cloud + - enterprise title: Configure Team Sync weight: 1000 --- diff --git a/docs/sources/setup-grafana/configure-security/export-logs.md b/docs/sources/setup-grafana/configure-security/export-logs.md index aac698c9904..907c980a4f9 100644 --- a/docs/sources/setup-grafana/configure-security/export-logs.md +++ b/docs/sources/setup-grafana/configure-security/export-logs.md @@ -7,6 +7,10 @@ keywords: - export - usage-insights - enterprise +labels: + products: + - cloud + - enterprise title: Export logs of usage insights weight: 900 --- diff --git a/docs/sources/setup-grafana/configure-security/secret-scan.md b/docs/sources/setup-grafana/configure-security/secret-scan.md index a4b615bdd8e..f5782e012f7 100644 --- a/docs/sources/setup-grafana/configure-security/secret-scan.md +++ b/docs/sources/setup-grafana/configure-security/secret-scan.md @@ -2,11 +2,10 @@ description: Detect and revoke leaked Grafana service account tokens labels: products: - - cloud - enterprise - oss -title: Configure Grafana secret scanning and notifications menuTitle: Configure secret scanning +title: Configure Grafana secret scanning and notifications weight: 1000 --- diff --git a/docs/sources/setup-grafana/image-rendering/_index.md b/docs/sources/setup-grafana/image-rendering/_index.md index 13bfe9e8293..ebec88da519 100644 --- a/docs/sources/setup-grafana/image-rendering/_index.md +++ b/docs/sources/setup-grafana/image-rendering/_index.md @@ -8,6 +8,10 @@ keywords: - image - rendering - plugin +labels: + products: + - enterprise + - oss title: Set up image rendering weight: 1000 --- diff --git a/docs/sources/setup-grafana/image-rendering/monitoring/index.md b/docs/sources/setup-grafana/image-rendering/monitoring/index.md index 614efa282ce..1d6779133d5 100644 --- a/docs/sources/setup-grafana/image-rendering/monitoring/index.md +++ b/docs/sources/setup-grafana/image-rendering/monitoring/index.md @@ -8,6 +8,10 @@ keywords: - rendering - plugin - monitoring +labels: + products: + - enterprise + - oss title: Monitor the image renderer weight: 100 --- diff --git a/docs/sources/setup-grafana/image-rendering/troubleshooting/index.md b/docs/sources/setup-grafana/image-rendering/troubleshooting/index.md index d777f4676da..34d220c51b2 100644 --- a/docs/sources/setup-grafana/image-rendering/troubleshooting/index.md +++ b/docs/sources/setup-grafana/image-rendering/troubleshooting/index.md @@ -8,6 +8,10 @@ keywords: - rendering - plugin - troubleshooting +labels: + products: + - enterprise + - oss menuTitle: Troubleshooting title: Troubleshoot image rendering weight: 200 diff --git a/docs/sources/setup-grafana/installation/_index.md b/docs/sources/setup-grafana/installation/_index.md index 478b8ae22e7..8b226a1dded 100644 --- a/docs/sources/setup-grafana/installation/_index.md +++ b/docs/sources/setup-grafana/installation/_index.md @@ -7,6 +7,10 @@ aliases: - /docs/grafana/v2.1/installation/install/ - ./installation/rpm/ description: Installation guide for Grafana +labels: + products: + - enterprise + - oss title: Install Grafana weight: 100 --- diff --git a/docs/sources/setup-grafana/installation/debian/index.md b/docs/sources/setup-grafana/installation/debian/index.md index 331791be2a3..093c58218a7 100644 --- a/docs/sources/setup-grafana/installation/debian/index.md +++ b/docs/sources/setup-grafana/installation/debian/index.md @@ -3,8 +3,12 @@ aliases: - ../../installation/debian/ - ../../installation/installation/debian/ description: Install guide for Grafana on Debian or Ubuntu -title: Install Grafana on Debian or Ubuntu +labels: + products: + - enterprise + - oss menuTitle: Debian or Ubuntu +title: Install Grafana on Debian or Ubuntu weight: 100 --- diff --git a/docs/sources/setup-grafana/installation/docker/index.md b/docs/sources/setup-grafana/installation/docker/index.md index f0f58ceee74..a2232db1277 100644 --- a/docs/sources/setup-grafana/installation/docker/index.md +++ b/docs/sources/setup-grafana/installation/docker/index.md @@ -2,6 +2,10 @@ aliases: - ../../installation/docker/ description: Guide for running Grafana using Docker +labels: + products: + - enterprise + - oss menuTitle: Grafana Docker image title: Run Grafana Docker image weight: 400 diff --git a/docs/sources/setup-grafana/installation/kubernetes/index.md b/docs/sources/setup-grafana/installation/kubernetes/index.md index a3e4938134c..77168857ad0 100644 --- a/docs/sources/setup-grafana/installation/kubernetes/index.md +++ b/docs/sources/setup-grafana/installation/kubernetes/index.md @@ -2,6 +2,10 @@ aliases: - ../../installation/kubernetes/ description: Guide for deploying Grafana on Kubernetes +labels: + products: + - enterprise + - oss menuTitle: Grafana on Kubernetes title: Deploy Grafana on Kubernetes weight: 500 diff --git a/docs/sources/setup-grafana/installation/mac/index.md b/docs/sources/setup-grafana/installation/mac/index.md index 117ef983f92..dbb775f2a79 100644 --- a/docs/sources/setup-grafana/installation/mac/index.md +++ b/docs/sources/setup-grafana/installation/mac/index.md @@ -2,8 +2,12 @@ aliases: - ../../installation/mac/ description: How to install Grafana OSS or Enterprise on macOS -title: Install Grafana on macOS +labels: + products: + - enterprise + - oss menuTitle: macOS +title: Install Grafana on macOS weight: 600 --- diff --git a/docs/sources/setup-grafana/installation/redhat-rhel-fedora/index.md b/docs/sources/setup-grafana/installation/redhat-rhel-fedora/index.md index d9d01ded536..a88f5f18d62 100644 --- a/docs/sources/setup-grafana/installation/redhat-rhel-fedora/index.md +++ b/docs/sources/setup-grafana/installation/redhat-rhel-fedora/index.md @@ -1,7 +1,11 @@ --- description: Install guide for Grafana on RHEL and Fedora. -title: Install Grafana on RHEL or Fedora +labels: + products: + - enterprise + - oss menuTitle: RHEL or Fedora +title: Install Grafana on RHEL or Fedora weight: 200 --- diff --git a/docs/sources/setup-grafana/installation/suse-opensuse/index.md b/docs/sources/setup-grafana/installation/suse-opensuse/index.md index b3faffd7c79..8452b569bc9 100644 --- a/docs/sources/setup-grafana/installation/suse-opensuse/index.md +++ b/docs/sources/setup-grafana/installation/suse-opensuse/index.md @@ -1,7 +1,11 @@ --- description: Install guide for Grafana on SUSE or openSUSE. -title: Install Grafana on SUSE or openSUSE +labels: + products: + - enterprise + - oss menuTitle: SUSE or openSUSE +title: Install Grafana on SUSE or openSUSE weight: 300 --- diff --git a/docs/sources/setup-grafana/installation/windows/index.md b/docs/sources/setup-grafana/installation/windows/index.md index 64e4ba71210..d65bfc8f58d 100644 --- a/docs/sources/setup-grafana/installation/windows/index.md +++ b/docs/sources/setup-grafana/installation/windows/index.md @@ -2,8 +2,12 @@ aliases: - ../../installation/windows/ description: How to install Grafana OSS or Enterprise on Windows -title: Install Grafana on Windows +labels: + products: + - enterprise + - oss menuTitle: Windows +title: Install Grafana on Windows weight: 700 --- diff --git a/docs/sources/setup-grafana/set-up-for-high-availability.md b/docs/sources/setup-grafana/set-up-for-high-availability.md index 1c52bea5eba..ddcb7b46238 100644 --- a/docs/sources/setup-grafana/set-up-for-high-availability.md +++ b/docs/sources/setup-grafana/set-up-for-high-availability.md @@ -2,14 +2,18 @@ aliases: - ../administration/set-up-for-high-availability/ - ../tutorials/ha_setup/ +description: Learn how to set up Grafana to be highly available. keywords: - grafana - tutorials - HA - high availability -title: Set up Grafana for high availability +labels: + products: + - enterprise + - oss menuTitle: Set up HA -description: Learn how to set up Grafana to be highly available. +title: Set up Grafana for high availability weight: 900 --- diff --git a/docs/sources/setup-grafana/set-up-grafana-live.md b/docs/sources/setup-grafana/set-up-grafana-live.md index fe87b81caf8..75404000271 100644 --- a/docs/sources/setup-grafana/set-up-grafana-live.md +++ b/docs/sources/setup-grafana/set-up-grafana-live.md @@ -8,6 +8,10 @@ aliases: - ../live/set-up-grafana-live/ description: Grafana Live is a real-time messaging engine that pushes event data to a frontend when an event occurs. +labels: + products: + - enterprise + - oss menuTitle: Set up Grafana Live title: Set up Grafana Live weight: 1100 diff --git a/docs/sources/setup-grafana/set-up-grafana-monitoring.md b/docs/sources/setup-grafana/set-up-grafana-monitoring.md index 690c3db996e..9ba87522a5e 100644 --- a/docs/sources/setup-grafana/set-up-grafana-monitoring.md +++ b/docs/sources/setup-grafana/set-up-grafana-monitoring.md @@ -8,6 +8,10 @@ keywords: - grafana - jaeger - tracing +labels: + products: + - enterprise + - oss title: Set up Grafana monitoring weight: 800 --- diff --git a/docs/sources/setup-grafana/set-up-https.md b/docs/sources/setup-grafana/set-up-https.md index 1575e4ec600..8de9c663618 100644 --- a/docs/sources/setup-grafana/set-up-https.md +++ b/docs/sources/setup-grafana/set-up-https.md @@ -1,12 +1,16 @@ --- +description: Learn how to set up Grafana HTTPS for secure web traffic. keywords: - grafana - https - ssl - certificates -title: Set up Grafana HTTPS for secure web traffic -description: Learn how to set up Grafana HTTPS for secure web traffic. +labels: + products: + - enterprise + - oss menuTitle: Set up HTTPS +title: Set up Grafana HTTPS for secure web traffic weight: 900 --- diff --git a/docs/sources/setup-grafana/sign-in-to-grafana.md b/docs/sources/setup-grafana/sign-in-to-grafana.md index b6ddc563588..5825db0dacd 100644 --- a/docs/sources/setup-grafana/sign-in-to-grafana.md +++ b/docs/sources/setup-grafana/sign-in-to-grafana.md @@ -1,5 +1,9 @@ --- description: Learn how to sign in to Grafana +labels: + products: + - enterprise + - oss title: Sign in to Grafana weight: 400 --- diff --git a/docs/sources/setup-grafana/start-restart-grafana.md b/docs/sources/setup-grafana/start-restart-grafana.md index 5d32ee1939f..e171041c1c3 100644 --- a/docs/sources/setup-grafana/start-restart-grafana.md +++ b/docs/sources/setup-grafana/start-restart-grafana.md @@ -3,8 +3,12 @@ aliases: - ../installation/restart-grafana/ - ./restart-grafana/ description: How to start the Grafana server -title: Start the Grafana server +labels: + products: + - enterprise + - oss menuTitle: Start Grafana +title: Start the Grafana server weight: 300 --- diff --git a/docs/sources/shared/alerts/first-step.md b/docs/sources/shared/alerts/first-step.md index a910eabde49..8aa44edf357 100644 --- a/docs/sources/shared/alerts/first-step.md +++ b/docs/sources/shared/alerts/first-step.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: TBD --- diff --git a/docs/sources/shared/alerts/grafana-managed-alerts.md b/docs/sources/shared/alerts/grafana-managed-alerts.md index a1b06e7dc3c..269fe53f5fe 100644 --- a/docs/sources/shared/alerts/grafana-managed-alerts.md +++ b/docs/sources/shared/alerts/grafana-managed-alerts.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Grafana managed alerts --- diff --git a/docs/sources/shared/auth/intro.md b/docs/sources/shared/auth/intro.md index 1e1764ec6de..92c1e0da425 100644 --- a/docs/sources/shared/auth/intro.md +++ b/docs/sources/shared/auth/intro.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Intro paragraph --- diff --git a/docs/sources/shared/basics/grafana-cloud.md b/docs/sources/shared/basics/grafana-cloud.md index 6cb56e15865..5d30214e310 100644 --- a/docs/sources/shared/basics/grafana-cloud.md +++ b/docs/sources/shared/basics/grafana-cloud.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Grafana Cloud --- diff --git a/docs/sources/shared/basics/grafana-enterprise.md b/docs/sources/shared/basics/grafana-enterprise.md index f14f2a6a26a..59be3d70fcd 100644 --- a/docs/sources/shared/basics/grafana-enterprise.md +++ b/docs/sources/shared/basics/grafana-enterprise.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Grafana Enterprise --- diff --git a/docs/sources/shared/basics/what-is-grafana.md b/docs/sources/shared/basics/what-is-grafana.md index ea5bdaf3eef..e33866f7fb6 100644 --- a/docs/sources/shared/basics/what-is-grafana.md +++ b/docs/sources/shared/basics/what-is-grafana.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Grafana Open Source --- diff --git a/docs/sources/shared/datasources/tempo-search-traceql.md b/docs/sources/shared/datasources/tempo-search-traceql.md index 7ec0fd12f7f..7b3d8197908 100644 --- a/docs/sources/shared/datasources/tempo-search-traceql.md +++ b/docs/sources/shared/datasources/tempo-search-traceql.md @@ -1,5 +1,9 @@ --- headless: true +labels: + products: + - enterprise + - oss --- [//]: # 'This file documents the Search query type for the Tempo data source.' diff --git a/docs/sources/shared/example.md b/docs/sources/shared/example.md index 5dda3b32502..ca9424eafb6 100644 --- a/docs/sources/shared/example.md +++ b/docs/sources/shared/example.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Shared Content --- diff --git a/docs/sources/shared/index.md b/docs/sources/shared/index.md index ca03031f1ee..c1f3280f0c0 100644 --- a/docs/sources/shared/index.md +++ b/docs/sources/shared/index.md @@ -1,3 +1,7 @@ --- headless: true +labels: + products: + - enterprise + - oss --- diff --git a/docs/sources/shared/influxdb/intro.md b/docs/sources/shared/influxdb/intro.md index 8fb436af32e..caf2bdee028 100644 --- a/docs/sources/shared/influxdb/intro.md +++ b/docs/sources/shared/influxdb/intro.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Intro paragraph --- diff --git a/docs/sources/shared/manage-users/view-server-org-list-and-edit.md b/docs/sources/shared/manage-users/view-server-org-list-and-edit.md index 1539302f7b9..6e0d10fdc4a 100644 --- a/docs/sources/shared/manage-users/view-server-org-list-and-edit.md +++ b/docs/sources/shared/manage-users/view-server-org-list-and-edit.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: View org list as server admin --- diff --git a/docs/sources/shared/manage-users/view-server-org-list.md b/docs/sources/shared/manage-users/view-server-org-list.md index 30dbb16efc6..58d791e4326 100644 --- a/docs/sources/shared/manage-users/view-server-org-list.md +++ b/docs/sources/shared/manage-users/view-server-org-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: View org list as server admin --- diff --git a/docs/sources/shared/manage-users/view-server-user-list-search.md b/docs/sources/shared/manage-users/view-server-user-list-search.md index 211caa5e788..b74a3cfb1ed 100644 --- a/docs/sources/shared/manage-users/view-server-user-list-search.md +++ b/docs/sources/shared/manage-users/view-server-user-list-search.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: View user list and search - list format --- diff --git a/docs/sources/shared/manage-users/view-server-user-list.md b/docs/sources/shared/manage-users/view-server-user-list.md index ae4f37bdcb7..82d969fac73 100644 --- a/docs/sources/shared/manage-users/view-server-user-list.md +++ b/docs/sources/shared/manage-users/view-server-user-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: View user list as server admin --- diff --git a/docs/sources/shared/manage-users/view-team-list.md b/docs/sources/shared/manage-users/view-team-list.md index 9c3afac80d4..e0f1602f265 100644 --- a/docs/sources/shared/manage-users/view-team-list.md +++ b/docs/sources/shared/manage-users/view-team-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: View team list --- diff --git a/docs/sources/shared/panels/panel-links-intro.md b/docs/sources/shared/panels/panel-links-intro.md index e00517c4dfc..d4562372604 100644 --- a/docs/sources/shared/panels/panel-links-intro.md +++ b/docs/sources/shared/panels/panel-links-intro.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Panel links intro --- diff --git a/docs/sources/shared/panels/repeat-panel-intro.md b/docs/sources/shared/panels/repeat-panel-intro.md index dfe630adcb6..50dde40f3c3 100644 --- a/docs/sources/shared/panels/repeat-panel-intro.md +++ b/docs/sources/shared/panels/repeat-panel-intro.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Repeat panel intro --- diff --git a/docs/sources/shared/preferences/navigate-to-the-dashboard-list.md b/docs/sources/shared/preferences/navigate-to-the-dashboard-list.md index e175cf837ca..f7d687bfada 100644 --- a/docs/sources/shared/preferences/navigate-to-the-dashboard-list.md +++ b/docs/sources/shared/preferences/navigate-to-the-dashboard-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Navigate to the dashboard list --- diff --git a/docs/sources/shared/preferences/navigate-user-preferences-list.md b/docs/sources/shared/preferences/navigate-user-preferences-list.md index e41a1cd396d..1402aa6e472 100644 --- a/docs/sources/shared/preferences/navigate-user-preferences-list.md +++ b/docs/sources/shared/preferences/navigate-user-preferences-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Navigate to user preferences list --- diff --git a/docs/sources/shared/preferences/org-preferences-list.md b/docs/sources/shared/preferences/org-preferences-list.md index 9762fa05a8f..e77e508718c 100644 --- a/docs/sources/shared/preferences/org-preferences-list.md +++ b/docs/sources/shared/preferences/org-preferences-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Click Org preferences --- diff --git a/docs/sources/shared/preferences/select-home-dashboard-list.md b/docs/sources/shared/preferences/select-home-dashboard-list.md index 133373aa690..5ba02077dc1 100644 --- a/docs/sources/shared/preferences/select-home-dashboard-list.md +++ b/docs/sources/shared/preferences/select-home-dashboard-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Select home dashboard list --- diff --git a/docs/sources/shared/preferences/select-timezone-list.md b/docs/sources/shared/preferences/select-timezone-list.md index 44615cf7dcd..b65d6904378 100644 --- a/docs/sources/shared/preferences/select-timezone-list.md +++ b/docs/sources/shared/preferences/select-timezone-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Select home dashboard list --- diff --git a/docs/sources/shared/preferences/select-ui-theme-list.md b/docs/sources/shared/preferences/select-ui-theme-list.md index 445f58f42c5..58eae98f6d7 100644 --- a/docs/sources/shared/preferences/select-ui-theme-list.md +++ b/docs/sources/shared/preferences/select-ui-theme-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Select the UI theme --- diff --git a/docs/sources/shared/preferences/some-tasks-require-permissions.md b/docs/sources/shared/preferences/some-tasks-require-permissions.md index da78645cb6e..aee8a2c4072 100644 --- a/docs/sources/shared/preferences/some-tasks-require-permissions.md +++ b/docs/sources/shared/preferences/some-tasks-require-permissions.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Some tasks require permissions --- diff --git a/docs/sources/shared/systemd/bind-net-capabilities.md b/docs/sources/shared/systemd/bind-net-capabilities.md index 2b5b2f4d2f6..c63d332a220 100644 --- a/docs/sources/shared/systemd/bind-net-capabilities.md +++ b/docs/sources/shared/systemd/bind-net-capabilities.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Serving Grafana on a port < 1024 --- diff --git a/docs/sources/shared/test.md b/docs/sources/shared/test.md index 8c9ac7055f7..12857518d3c 100644 --- a/docs/sources/shared/test.md +++ b/docs/sources/shared/test.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Shared Content --- diff --git a/docs/sources/shared/tutorials/create-plugin.md b/docs/sources/shared/tutorials/create-plugin.md index 4feda888c0a..799f9afa0d3 100755 --- a/docs/sources/shared/tutorials/create-plugin.md +++ b/docs/sources/shared/tutorials/create-plugin.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Create Plugin --- diff --git a/docs/sources/shared/tutorials/plugin-anatomy.md b/docs/sources/shared/tutorials/plugin-anatomy.md index 18f148d4696..67f04f76bc3 100644 --- a/docs/sources/shared/tutorials/plugin-anatomy.md +++ b/docs/sources/shared/tutorials/plugin-anatomy.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Plugin Anatomy --- diff --git a/docs/sources/shared/tutorials/publish-your-plugin.md b/docs/sources/shared/tutorials/publish-your-plugin.md index 097f2417608..303f5b93e89 100644 --- a/docs/sources/shared/tutorials/publish-your-plugin.md +++ b/docs/sources/shared/tutorials/publish-your-plugin.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Package your plugin --- diff --git a/docs/sources/shared/tutorials/set-up-environment.md b/docs/sources/shared/tutorials/set-up-environment.md index 07eb372727a..7f1a413bb52 100644 --- a/docs/sources/shared/tutorials/set-up-environment.md +++ b/docs/sources/shared/tutorials/set-up-environment.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Set up Environment --- diff --git a/docs/sources/shared/upgrade/upgrade-common-tasks.md b/docs/sources/shared/upgrade/upgrade-common-tasks.md index 3c2402003c9..7c46a9c9756 100644 --- a/docs/sources/shared/upgrade/upgrade-common-tasks.md +++ b/docs/sources/shared/upgrade/upgrade-common-tasks.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Upgrade guide common tasks --- diff --git a/docs/sources/shared/view-server-org-list.md b/docs/sources/shared/view-server-org-list.md index 96adfdad87b..662d3c61c7c 100644 --- a/docs/sources/shared/view-server-org-list.md +++ b/docs/sources/shared/view-server-org-list.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: View user list --- diff --git a/docs/sources/shared/view-server-user-list-search.md b/docs/sources/shared/view-server-user-list-search.md index 9deed8f6be9..313acd99634 100644 --- a/docs/sources/shared/view-server-user-list-search.md +++ b/docs/sources/shared/view-server-user-list-search.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: View user list --- diff --git a/docs/sources/shared/visualizations/change-axis-link.md b/docs/sources/shared/visualizations/change-axis-link.md index 22023736e4d..b3147c9e31c 100644 --- a/docs/sources/shared/visualizations/change-axis-link.md +++ b/docs/sources/shared/visualizations/change-axis-link.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Stack series link --- diff --git a/docs/sources/shared/visualizations/legend-mode.md b/docs/sources/shared/visualizations/legend-mode.md index c8a127d5bee..3ab9670674f 100644 --- a/docs/sources/shared/visualizations/legend-mode.md +++ b/docs/sources/shared/visualizations/legend-mode.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Legend mode and legend placement --- diff --git a/docs/sources/shared/visualizations/stack-series-link.md b/docs/sources/shared/visualizations/stack-series-link.md index 328f3293109..830a68e9f21 100644 --- a/docs/sources/shared/visualizations/stack-series-link.md +++ b/docs/sources/shared/visualizations/stack-series-link.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Stack series link --- diff --git a/docs/sources/shared/visualizations/tooltip-mode.md b/docs/sources/shared/visualizations/tooltip-mode.md index 75c2c4d2358..0206397d6bb 100644 --- a/docs/sources/shared/visualizations/tooltip-mode.md +++ b/docs/sources/shared/visualizations/tooltip-mode.md @@ -1,4 +1,8 @@ --- +labels: + products: + - enterprise + - oss title: Tooltip mode --- diff --git a/docs/sources/troubleshooting/_index.md b/docs/sources/troubleshooting/_index.md index 9be38be4b03..df54aed9882 100644 --- a/docs/sources/troubleshooting/_index.md +++ b/docs/sources/troubleshooting/_index.md @@ -7,6 +7,11 @@ keywords: - troubleshooting - documentation - guide +labels: + products: + - cloud + - enterprise + - oss title: Troubleshooting weight: 180 --- diff --git a/docs/sources/troubleshooting/send-panel-to-grafana-support/index.md b/docs/sources/troubleshooting/send-panel-to-grafana-support/index.md index 5d1da957114..83ac76457c8 100644 --- a/docs/sources/troubleshooting/send-panel-to-grafana-support/index.md +++ b/docs/sources/troubleshooting/send-panel-to-grafana-support/index.md @@ -5,8 +5,13 @@ keywords: - troubleshooting - support - dashboards -title: Send a panel to Grafana Labs support +labels: + products: + - cloud + - enterprise + - oss menutitle: Send panel to support +title: Send a panel to Grafana Labs support weight: 100 --- diff --git a/docs/sources/troubleshooting/support-bundles/index.md b/docs/sources/troubleshooting/support-bundles/index.md index 26c672409c5..e77a87ec1ef 100644 --- a/docs/sources/troubleshooting/support-bundles/index.md +++ b/docs/sources/troubleshooting/support-bundles/index.md @@ -5,8 +5,13 @@ keywords: - troubleshooting - support - bundles -title: Send a support bundle to Grafana Labs support +labels: + products: + - cloud + - enterprise + - oss menutitle: Send a support bundle to support +title: Send a support bundle to Grafana Labs support weight: 200 --- diff --git a/docs/sources/tutorials/_index.md b/docs/sources/tutorials/_index.md index cfe6c7633df..ddd3f79a7fe 100644 --- a/docs/sources/tutorials/_index.md +++ b/docs/sources/tutorials/_index.md @@ -1,7 +1,11 @@ --- -title: 'Tutorials' -menuTitle: 'Tutorials' -description: 'Grafana tutorials' +description: Grafana tutorials +labels: + products: + - enterprise + - oss +menuTitle: Tutorials +title: Tutorials --- # Tutorials diff --git a/docs/sources/tutorials/create-alerts-from-flux-queries/index.md b/docs/sources/tutorials/create-alerts-from-flux-queries/index.md index a039afbf5dc..ff67f50b266 100644 --- a/docs/sources/tutorials/create-alerts-from-flux-queries/index.md +++ b/docs/sources/tutorials/create-alerts-from-flux-queries/index.md @@ -1,13 +1,20 @@ --- -title: How to create Grafana alerts with InfluxDB and the Flux query language -summary: Create complex alerts from Flux queries in the new Grafana Alerting +Feedback Link: https://github.com/grafana/tutorials/issues/new +authors: + - grant_pinkos +categories: + - alerting description: Create complex alerts from Flux queries in the new Grafana Alerting id: grafana-alerts-flux-queries -categories: ['alerting'] -tags: ['advanced'] +labels: + products: + - enterprise + - oss status: published -authors: ['grant_pinkos'] -Feedback Link: https://github.com/grafana/tutorials/issues/new +summary: Create complex alerts from Flux queries in the new Grafana Alerting +tags: + - advanced +title: How to create Grafana alerts with InfluxDB and the Flux query language weight: 70 --- diff --git a/docs/sources/tutorials/create-users-and-teams/index.md b/docs/sources/tutorials/create-users-and-teams/index.md index 85ffb7f1c2b..614a60b2cee 100644 --- a/docs/sources/tutorials/create-users-and-teams/index.md +++ b/docs/sources/tutorials/create-users-and-teams/index.md @@ -1,13 +1,20 @@ --- -title: Create users and teams -summary: Learn how to set up teams and users. +Feedback Link: https://github.com/grafana/tutorials/issues/new +authors: + - grafana_labs +categories: + - administration description: Learn how to set up teams and users. id: create-users-and-teams -categories: ['administration'] -tags: ['beginner'] +labels: + products: + - enterprise + - oss status: Published -authors: ['grafana_labs'] -Feedback Link: https://github.com/grafana/tutorials/issues/new +summary: Learn how to set up teams and users. +tags: + - beginner +title: Create users and teams weight: 20 --- diff --git a/docs/sources/tutorials/grafana-fundamentals/index.md b/docs/sources/tutorials/grafana-fundamentals/index.md index 903af2c7134..a2223ecf90d 100644 --- a/docs/sources/tutorials/grafana-fundamentals/index.md +++ b/docs/sources/tutorials/grafana-fundamentals/index.md @@ -1,13 +1,20 @@ --- -title: Grafana fundamentals -summary: Get familiar with Grafana +Feedback Link: https://github.com/grafana/tutorials/issues/new +authors: + - grafana_labs +categories: + - fundamentals description: Get familiar with Grafana id: grafana-fundamentals -categories: ['fundamentals'] -tags: ['beginner'] +labels: + products: + - enterprise + - oss status: Published -authors: ['grafana_labs'] -Feedback Link: https://github.com/grafana/tutorials/issues/new +summary: Get familiar with Grafana +tags: + - beginner +title: Grafana fundamentals weight: 10 --- diff --git a/docs/sources/tutorials/iis/index.md b/docs/sources/tutorials/iis/index.md index ec4a190a128..20c52aaee37 100644 --- a/docs/sources/tutorials/iis/index.md +++ b/docs/sources/tutorials/iis/index.md @@ -1,14 +1,22 @@ --- -title: Use IIS with URL Rewrite as a reverse proxy -summary: Learn how to set up Grafana behind IIS with URL Rewrite. +Feedback Link: https://github.com/grafana/tutorials/issues/new +aliases: + - /docs/grafana/latest/tutorials/iis/ +authors: + - grafana_labs +categories: + - administration description: Learn how to set up Grafana behind IIS with URL Rewrite. id: iis -categories: ['administration'] -tags: ['advanced'] +labels: + products: + - enterprise + - oss status: Published -authors: ['grafana_labs'] -Feedback Link: https://github.com/grafana/tutorials/issues/new -aliases: ['/docs/grafana/latest/tutorials/iis/'] +summary: Learn how to set up Grafana behind IIS with URL Rewrite. +tags: + - advanced +title: Use IIS with URL Rewrite as a reverse proxy --- # Use IIS with URL Rewrite as a reverse proxy diff --git a/docs/sources/tutorials/install-grafana-on-raspberry-pi/index.md b/docs/sources/tutorials/install-grafana-on-raspberry-pi/index.md index 16870ac0f92..2bc96509a64 100644 --- a/docs/sources/tutorials/install-grafana-on-raspberry-pi/index.md +++ b/docs/sources/tutorials/install-grafana-on-raspberry-pi/index.md @@ -1,12 +1,19 @@ --- -title: Install Grafana on Raspberry Pi -summary: Get Grafana set up on your Raspberry Pi. +Feedback Link: https://github.com/grafana/tutorials/issues/new +authors: + - grafana_labs +categories: + - administration description: Get Grafana set up on your Raspberry Pi. id: install-grafana-on-raspberry-pi -categories: ['administration'] -tags: ['beginner'] -authors: ['grafana_labs'] -Feedback Link: https://github.com/grafana/tutorials/issues/new +labels: + products: + - enterprise + - oss +summary: Get Grafana set up on your Raspberry Pi. +tags: + - beginner +title: Install Grafana on Raspberry Pi --- ## Introduction diff --git a/docs/sources/tutorials/integrate-hubot/index.md b/docs/sources/tutorials/integrate-hubot/index.md index 0d0af2f3821..d6b769987f1 100644 --- a/docs/sources/tutorials/integrate-hubot/index.md +++ b/docs/sources/tutorials/integrate-hubot/index.md @@ -1,14 +1,22 @@ --- -title: Integrate Hubot with Grafana -summary: Learn how to integrate Hubot with Grafana +Feedback Link: https://github.com/grafana/tutorials/issues/new +aliases: + - /docs/grafana/latest/tutorials/hubot_howto/ +authors: + - grafana_labs +categories: + - administration description: Learn how to integrate Hubot with Grafana id: integrate-hubot -categories: ['administration'] -tags: ['advanced'] +labels: + products: + - enterprise + - oss status: Published -authors: ['grafana_labs'] -Feedback Link: https://github.com/grafana/tutorials/issues/new -aliases: ['/docs/grafana/latest/tutorials/hubot_howto/'] +summary: Learn how to integrate Hubot with Grafana +tags: + - advanced +title: Integrate Hubot with Grafana --- # Integrate Hubot with Grafana diff --git a/docs/sources/tutorials/provision-dashboards-and-data-sources/index.md b/docs/sources/tutorials/provision-dashboards-and-data-sources/index.md index df4aeaec2e3..0cd2a1cbfd6 100644 --- a/docs/sources/tutorials/provision-dashboards-and-data-sources/index.md +++ b/docs/sources/tutorials/provision-dashboards-and-data-sources/index.md @@ -1,12 +1,19 @@ --- -title: Provision dashboards and data sources -summary: Treat your configuration as code. +Feedback Link: https://github.com/grafana/tutorials/issues/new +authors: + - grafana_labs +categories: + - administration description: Treat your configuration as code. id: provision-dashboards-and-data-sources -categories: ['administration'] -tags: ['intermediate'] -authors: ['grafana_labs'] -Feedback Link: https://github.com/grafana/tutorials/issues/new +labels: + products: + - enterprise + - oss +summary: Treat your configuration as code. +tags: + - intermediate +title: Provision dashboards and data sources weight: 40 --- diff --git a/docs/sources/tutorials/run-grafana-behind-a-proxy/index.md b/docs/sources/tutorials/run-grafana-behind-a-proxy/index.md index 3597bc39dd2..1c91e80579a 100644 --- a/docs/sources/tutorials/run-grafana-behind-a-proxy/index.md +++ b/docs/sources/tutorials/run-grafana-behind-a-proxy/index.md @@ -1,14 +1,22 @@ --- -title: Run Grafana behind a reverse proxy -summary: Learn how to run Grafana behind a reverse proxy +Feedback Link: https://github.com/grafana/tutorials/issues/new +aliases: + - /docs/grafana/latest/installation/behind_proxy/ +authors: + - grafana_labs +categories: + - administration description: Learn how to run Grafana behind a reverse proxy id: run-grafana-behind-a-proxy -categories: ['administration'] -tags: ['advanced'] +labels: + products: + - enterprise + - oss status: Published -authors: ['grafana_labs'] -Feedback Link: https://github.com/grafana/tutorials/issues/new -aliases: ['/docs/grafana/latest/installation/behind_proxy/'] +summary: Learn how to run Grafana behind a reverse proxy +tags: + - advanced +title: Run Grafana behind a reverse proxy --- ## Introduction diff --git a/docs/sources/tutorials/stream-metrics-from-telegraf-to-grafana/index.md b/docs/sources/tutorials/stream-metrics-from-telegraf-to-grafana/index.md index 5699d3d26f4..450f2d28e73 100644 --- a/docs/sources/tutorials/stream-metrics-from-telegraf-to-grafana/index.md +++ b/docs/sources/tutorials/stream-metrics-from-telegraf-to-grafana/index.md @@ -1,13 +1,20 @@ --- -title: Stream metrics from Telegraf to Grafana -summary: Use Telegraf to stream live metrics to Grafana. +Feedback Link: https://github.com/grafana/tutorials/issues/new +authors: + - grafana_labs +categories: + - administration description: Use Telegraf to stream live metrics to Grafana. id: stream-metrics-from-telegraf-to-grafana -categories: ['administration'] -tags: ['beginner'] +labels: + products: + - enterprise + - oss status: Published -authors: ['grafana_labs'] -Feedback Link: https://github.com/grafana/tutorials/issues/new +summary: Use Telegraf to stream live metrics to Grafana. +tags: + - beginner +title: Stream metrics from Telegraf to Grafana weight: 75 --- diff --git a/docs/sources/upgrade-guide/_index.md b/docs/sources/upgrade-guide/_index.md index 05f61c78764..7bd55a4f9bb 100644 --- a/docs/sources/upgrade-guide/_index.md +++ b/docs/sources/upgrade-guide/_index.md @@ -8,6 +8,10 @@ keywords: - configuration - documentation - upgrade +labels: + products: + - enterprise + - oss title: Upgrade Grafana weight: 3 --- diff --git a/docs/sources/upgrade-guide/upgrade-v10.0/index.md b/docs/sources/upgrade-guide/upgrade-v10.0/index.md index bdd7f6ee644..f11f3dba8c0 100644 --- a/docs/sources/upgrade-guide/upgrade-v10.0/index.md +++ b/docs/sources/upgrade-guide/upgrade-v10.0/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v10.0 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v10.0 +title: Upgrade to Grafana v10.0 weight: 1700 --- diff --git a/docs/sources/upgrade-guide/upgrade-v8.0/index.md b/docs/sources/upgrade-guide/upgrade-v8.0/index.md index 3dba540e715..82bf0885f56 100644 --- a/docs/sources/upgrade-guide/upgrade-v8.0/index.md +++ b/docs/sources/upgrade-guide/upgrade-v8.0/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v8.0 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v8.0 +title: Upgrade to Grafana v8.0 weight: 2900 --- diff --git a/docs/sources/upgrade-guide/upgrade-v8.1/index.md b/docs/sources/upgrade-guide/upgrade-v8.1/index.md index b7be24fd682..0a1c820db62 100644 --- a/docs/sources/upgrade-guide/upgrade-v8.1/index.md +++ b/docs/sources/upgrade-guide/upgrade-v8.1/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v8.1 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v8.1 +title: Upgrade to Grafana v8.1 weight: 2800 --- diff --git a/docs/sources/upgrade-guide/upgrade-v8.2/index.md b/docs/sources/upgrade-guide/upgrade-v8.2/index.md index 9dade2c4934..e785b9d1534 100644 --- a/docs/sources/upgrade-guide/upgrade-v8.2/index.md +++ b/docs/sources/upgrade-guide/upgrade-v8.2/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v8.2 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v8.2 +title: Upgrade to Grafana v8.2 weight: 2700 --- diff --git a/docs/sources/upgrade-guide/upgrade-v8.3/index.md b/docs/sources/upgrade-guide/upgrade-v8.3/index.md index eee581bcb51..6e105d6139e 100644 --- a/docs/sources/upgrade-guide/upgrade-v8.3/index.md +++ b/docs/sources/upgrade-guide/upgrade-v8.3/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v8.3 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v8.3 +title: Upgrade to Grafana v8.3 weight: 2600 --- diff --git a/docs/sources/upgrade-guide/upgrade-v8.4/index.md b/docs/sources/upgrade-guide/upgrade-v8.4/index.md index 30e0bf54af7..1d57cacf344 100644 --- a/docs/sources/upgrade-guide/upgrade-v8.4/index.md +++ b/docs/sources/upgrade-guide/upgrade-v8.4/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v8.4 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v8.4 +title: Upgrade to Grafana v8.4 weight: 2500 --- diff --git a/docs/sources/upgrade-guide/upgrade-v8.5/index.md b/docs/sources/upgrade-guide/upgrade-v8.5/index.md index 5f0f06a64f8..08753eff541 100644 --- a/docs/sources/upgrade-guide/upgrade-v8.5/index.md +++ b/docs/sources/upgrade-guide/upgrade-v8.5/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v8.5 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v8.5 +title: Upgrade to Grafana v8.5 weight: 2400 --- diff --git a/docs/sources/upgrade-guide/upgrade-v9.0/index.md b/docs/sources/upgrade-guide/upgrade-v9.0/index.md index 4bf6fc33eed..da8364410ae 100644 --- a/docs/sources/upgrade-guide/upgrade-v9.0/index.md +++ b/docs/sources/upgrade-guide/upgrade-v9.0/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v9.0 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v9.0 +title: Upgrade to Grafana v9.0 weight: 2300 --- diff --git a/docs/sources/upgrade-guide/upgrade-v9.1/index.md b/docs/sources/upgrade-guide/upgrade-v9.1/index.md index 900b121c3a8..ba5b879fb9c 100644 --- a/docs/sources/upgrade-guide/upgrade-v9.1/index.md +++ b/docs/sources/upgrade-guide/upgrade-v9.1/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v9.1 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v9.1 +title: Upgrade to Grafana v9.1 weight: 2200 --- diff --git a/docs/sources/upgrade-guide/upgrade-v9.2/index.md b/docs/sources/upgrade-guide/upgrade-v9.2/index.md index d4380fecd27..cf5a6f906b4 100644 --- a/docs/sources/upgrade-guide/upgrade-v9.2/index.md +++ b/docs/sources/upgrade-guide/upgrade-v9.2/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v9.2 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v9.2 +title: Upgrade to Grafana v9.2 weight: 2100 --- diff --git a/docs/sources/upgrade-guide/upgrade-v9.3/index.md b/docs/sources/upgrade-guide/upgrade-v9.3/index.md index 6d74bbbacfa..04021267e46 100644 --- a/docs/sources/upgrade-guide/upgrade-v9.3/index.md +++ b/docs/sources/upgrade-guide/upgrade-v9.3/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v9.3 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v9.3 +title: Upgrade to Grafana v9.3 weight: 2000 --- diff --git a/docs/sources/upgrade-guide/upgrade-v9.4/index.md b/docs/sources/upgrade-guide/upgrade-v9.4/index.md index 4025d8d2ff9..bd074a0a2c1 100644 --- a/docs/sources/upgrade-guide/upgrade-v9.4/index.md +++ b/docs/sources/upgrade-guide/upgrade-v9.4/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v9.4 +labels: + products: + - enterprise + - oss menutitle: Upgrade to v9.4 +title: Upgrade to Grafana v9.4 weight: 1995 --- diff --git a/docs/sources/upgrade-guide/upgrade-v9.5/index.md b/docs/sources/upgrade-guide/upgrade-v9.5/index.md index bfad71787bc..16cb4b174a2 100644 --- a/docs/sources/upgrade-guide/upgrade-v9.5/index.md +++ b/docs/sources/upgrade-guide/upgrade-v9.5/index.md @@ -5,8 +5,12 @@ keywords: - configuration - documentation - upgrade -title: Upgrade to Grafana v9.5 +labels: + products: + - enterprise + - oss menuTitle: Upgrade to v9.5 +title: Upgrade to Grafana v9.5 weight: 1800 --- diff --git a/docs/sources/whatsnew/_index.md b/docs/sources/whatsnew/_index.md index 3e49383dac3..24753fe5600 100644 --- a/docs/sources/whatsnew/_index.md +++ b/docs/sources/whatsnew/_index.md @@ -53,10 +53,15 @@ aliases: - whats-new-in-v6-5/ - whats-new-in-v6-6/ - whats-new-in-v6-7/ +description: Learn about new and changed features in Grafana. +labels: + products: + - cloud + - enterprise + - oss menuTitle: What's new title: What's new in Grafana weight: 1 -description: Learn about new and changed features in Grafana. --- # What's new in Grafana diff --git a/docs/sources/whatsnew/whats-new-in-v10-0.md b/docs/sources/whatsnew/whats-new-in-v10-0.md index d6f4d2db67d..e7e749522cf 100644 --- a/docs/sources/whatsnew/whats-new-in-v10-0.md +++ b/docs/sources/whatsnew/whats-new-in-v10-0.md @@ -6,6 +6,11 @@ keywords: - documentation - '10.0' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v10.0 weight: -37 --- diff --git a/docs/sources/whatsnew/whats-new-in-v7-0.md b/docs/sources/whatsnew/whats-new-in-v7-0.md index 40e44864cd8..0f3050baa0c 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-0.md +++ b/docs/sources/whatsnew/whats-new-in-v7-0.md @@ -10,6 +10,11 @@ keywords: - documentation - '7.0' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v7.0 weight: -27 --- diff --git a/docs/sources/whatsnew/whats-new-in-v7-1.md b/docs/sources/whatsnew/whats-new-in-v7-1.md index 718b76e3fe4..bf270db5555 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-1.md +++ b/docs/sources/whatsnew/whats-new-in-v7-1.md @@ -10,6 +10,11 @@ keywords: - documentation - '7.1' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v7.1 weight: -28 --- diff --git a/docs/sources/whatsnew/whats-new-in-v7-2.md b/docs/sources/whatsnew/whats-new-in-v7-2.md index c559b45e294..06182f95b68 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-2.md +++ b/docs/sources/whatsnew/whats-new-in-v7-2.md @@ -10,6 +10,11 @@ keywords: - documentation - '7.2' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v7.2 weight: -29 --- diff --git a/docs/sources/whatsnew/whats-new-in-v7-3.md b/docs/sources/whatsnew/whats-new-in-v7-3.md index 5cb69bb8de8..528cd612879 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-3.md +++ b/docs/sources/whatsnew/whats-new-in-v7-3.md @@ -10,6 +10,11 @@ keywords: - documentation - '7.3' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v7.3 weight: -30 --- diff --git a/docs/sources/whatsnew/whats-new-in-v7-4.md b/docs/sources/whatsnew/whats-new-in-v7-4.md index 35eefb4a08a..2632c63d7ad 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-4.md +++ b/docs/sources/whatsnew/whats-new-in-v7-4.md @@ -10,6 +10,11 @@ keywords: - documentation - '7.4' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v7.4 weight: -31 --- diff --git a/docs/sources/whatsnew/whats-new-in-v7-5.md b/docs/sources/whatsnew/whats-new-in-v7-5.md index c771bbf6a06..cd03cde17c2 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-5.md +++ b/docs/sources/whatsnew/whats-new-in-v7-5.md @@ -10,6 +10,11 @@ keywords: - documentation - '7.5' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v7.5 weight: -32 --- diff --git a/docs/sources/whatsnew/whats-new-in-v8-0.md b/docs/sources/whatsnew/whats-new-in-v8-0.md index 4bce259f839..a1a56c3897d 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-0.md +++ b/docs/sources/whatsnew/whats-new-in-v8-0.md @@ -10,6 +10,11 @@ keywords: - documentation - '8.0' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v8.0 weight: -33 --- diff --git a/docs/sources/whatsnew/whats-new-in-v8-1.md b/docs/sources/whatsnew/whats-new-in-v8-1.md index 5c892c763ae..d9ddde497c6 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-1.md +++ b/docs/sources/whatsnew/whats-new-in-v8-1.md @@ -10,6 +10,11 @@ keywords: - documentation - '8.1' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v8.1 weight: -33 --- diff --git a/docs/sources/whatsnew/whats-new-in-v8-2.md b/docs/sources/whatsnew/whats-new-in-v8-2.md index 7dab4b3a623..7a7a179e8e4 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-2.md +++ b/docs/sources/whatsnew/whats-new-in-v8-2.md @@ -10,6 +10,11 @@ keywords: - documentation - '8.2' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v8.2 weight: -33 --- diff --git a/docs/sources/whatsnew/whats-new-in-v8-3.md b/docs/sources/whatsnew/whats-new-in-v8-3.md index f93c7e16abf..7bab288184d 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-3.md +++ b/docs/sources/whatsnew/whats-new-in-v8-3.md @@ -10,6 +10,11 @@ keywords: - documentation - '8.3' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v8.3 weight: -33 --- diff --git a/docs/sources/whatsnew/whats-new-in-v8-4.md b/docs/sources/whatsnew/whats-new-in-v8-4.md index 1dbc2d63037..6abb46bd91e 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-4.md +++ b/docs/sources/whatsnew/whats-new-in-v8-4.md @@ -10,6 +10,11 @@ keywords: - documentation - '8.4' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v8.4 weight: -33 --- diff --git a/docs/sources/whatsnew/whats-new-in-v8-5.md b/docs/sources/whatsnew/whats-new-in-v8-5.md index 06b864bee65..5216527e714 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-5.md +++ b/docs/sources/whatsnew/whats-new-in-v8-5.md @@ -10,6 +10,11 @@ keywords: - documentation - '8.5' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v8.5 weight: -33 --- diff --git a/docs/sources/whatsnew/whats-new-in-v9-0.md b/docs/sources/whatsnew/whats-new-in-v9-0.md index e222f2086a9..2f925f7bfa2 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-0.md +++ b/docs/sources/whatsnew/whats-new-in-v9-0.md @@ -10,6 +10,11 @@ keywords: - documentation - '9.0' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v9.0 weight: -33 --- diff --git a/docs/sources/whatsnew/whats-new-in-v9-1.md b/docs/sources/whatsnew/whats-new-in-v9-1.md index d390ab639e0..b3d08e910be 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-1.md +++ b/docs/sources/whatsnew/whats-new-in-v9-1.md @@ -10,6 +10,11 @@ keywords: - documentation - '9.1' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v9.1 weight: -33 --- diff --git a/docs/sources/whatsnew/whats-new-in-v9-2.md b/docs/sources/whatsnew/whats-new-in-v9-2.md index 88f117a711f..6b43fde4241 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-2.md +++ b/docs/sources/whatsnew/whats-new-in-v9-2.md @@ -8,6 +8,11 @@ keywords: - documentation - '9.2' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v9.2 weight: -33 --- diff --git a/docs/sources/whatsnew/whats-new-in-v9-3.md b/docs/sources/whatsnew/whats-new-in-v9-3.md index 69dd3ce88a9..6be8d82131b 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-3.md +++ b/docs/sources/whatsnew/whats-new-in-v9-3.md @@ -8,6 +8,11 @@ keywords: - documentation - '9.3' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v9.3 weight: -34 --- diff --git a/docs/sources/whatsnew/whats-new-in-v9-4.md b/docs/sources/whatsnew/whats-new-in-v9-4.md index 0f6ccb6cacf..e234db3709a 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-4.md +++ b/docs/sources/whatsnew/whats-new-in-v9-4.md @@ -6,6 +6,11 @@ keywords: - documentation - '9.4' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v9.4 weight: -35 --- diff --git a/docs/sources/whatsnew/whats-new-in-v9-5.md b/docs/sources/whatsnew/whats-new-in-v9-5.md index e73135f794c..8a76dae73ec 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-5.md +++ b/docs/sources/whatsnew/whats-new-in-v9-5.md @@ -6,6 +6,11 @@ keywords: - documentation - '9.5' - release notes +labels: + products: + - cloud + - enterprise + - oss title: What's new in Grafana v9.5 weight: -36 ---