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 <jack.baldry@grafana.com> * Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/enterprise-licensing pages to have 'Enterprise' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * 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 <jack.baldry@grafana.com> * 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 <jack.baldry@grafana.com> * Fix introduction pages products Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * 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 <jack.baldry@grafana.com> * 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 <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * 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 <jack.baldry@grafana.com> Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
This commit is contained in:
Jack Baldry
GitHub
@@ -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.<br/> - Name - The series or field name.<br/> - Percent - The percentage of the whole.<br/> - Value - The raw numerical value.<br/>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.<br/>Possible values are: `pie`, `donut`. |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>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<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>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))*<br/>TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*<br/>TODO docs<br/>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))_<br/>TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_<br/>TODO docs<br/>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<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>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<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>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 |
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user