From 2550c1618a40be13d4c6bde5f2489c4e5098e052 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Wed, 27 Sep 2023 18:25:51 +0100 Subject: [PATCH] [v8.5.x] Remove plugins (#75577) * Fix all links to "Sign a plugin" pages Signed-off-by: Jack Baldry * [publish_dashboards] * Fix metadata links Signed-off-by: Jack Baldry * [publish-technical-documentation-next] Publish from grafana/agent:main/docs/sources * Fix data-frames redirect Signed-off-by: Jack Baldry * add collapse shortcode (#15422) * Add note about missing rewrites Signed-off-by: Jack Baldry * Fix all data-frames links Signed-off-by: Jack Baldry * Fix links to "plugins" Signed-off-by: Jack Baldry * Fix "plugin-sdk-go" links Signed-off-by: Jack Baldry * Fix backend links Signed-off-by: Jack Baldry * Fix "Add query editor help" links Signed-off-by: Jack Baldry * Fix value mappings links Signed-off-by: Jack Baldry * Fix some stray links Signed-off-by: Jack Baldry * [publish_plugins] * Add missing redirects and fix a couple more links Signed-off-by: Jack Baldry --------- Signed-off-by: Jack Baldry --- .../administration/view-server/internal-metrics.md | 2 +- .../fundamentals/evaluate-grafana-alerts.md | 2 +- docs/sources/basics/timeseries-dimensions.md | 2 +- docs/sources/datasources/mssql.md | 2 +- docs/sources/datasources/mysql.md | 2 +- docs/sources/datasources/postgres.md | 2 +- docs/sources/developers/_index.md | 2 +- docs/sources/installation/upgrading.md | 2 +- .../panels/transform-data/transformation-functions.md | 2 +- .../working-with-panels/format-standard-fields.md | 2 +- docs/sources/plugins/_index.md | 2 +- docs/sources/plugins/plugin-signatures.md | 2 +- docs/sources/shared/alerts/grafana-managed-alerts.md | 2 +- docs/sources/visualizations/status-history.md | 2 +- docs/sources/whatsnew/whats-new-in-v7-0.md | 10 +++++----- docs/sources/whatsnew/whats-new-in-v7-4.md | 2 +- 16 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/sources/administration/view-server/internal-metrics.md b/docs/sources/administration/view-server/internal-metrics.md index 65c6d6610e6..97ffa3d08d1 100644 --- a/docs/sources/administration/view-server/internal-metrics.md +++ b/docs/sources/administration/view-server/internal-metrics.md @@ -99,7 +99,7 @@ These instructions assume you have already added Graphite as a data source in Gr ## Pull metrics from Grafana backend plugin into Prometheus -Any installed [backend plugin]({{< relref "../../developers/plugins/backend/_index.md" >}}) exposes a metrics endpoint through Grafana that you can configure Prometheus to scrape. +Any installed [backend plugin](https://grafana.com/developers/plugin-tools/introduction/backend-plugins) exposes a metrics endpoint through Grafana that you can configure Prometheus to scrape. These instructions assume you have already added Prometheus as a data source in Grafana. diff --git a/docs/sources/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts.md b/docs/sources/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts.md index eb0ffee8ed9..59dc68589fc 100644 --- a/docs/sources/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts.md +++ b/docs/sources/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts.md @@ -18,7 +18,7 @@ Grafana managed alerts query the following backend data sources that have alerti - built-in data sources or those developed and maintained by Grafana: `Graphite`, `Prometheus`, `Loki`, `InfluxDB`, `Elasticsearch`, `Google Cloud Monitoring`, `Cloudwatch`, `Azure Monitor`, `MySQL`, `PostgreSQL`, `MSSQL`, `OpenTSDB`, `Oracle`, and `Azure Monitor` -- community developed backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json]({{< relref "../../../developers/plugins/metadata.md" >}})) +- community developed backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json](https://grafana.com/developers/plugin-tools/reference-plugin-json)) ### Metrics from the alerting engine diff --git a/docs/sources/basics/timeseries-dimensions.md b/docs/sources/basics/timeseries-dimensions.md index 5d96c3dfa66..aaef8515e18 100644 --- a/docs/sources/basics/timeseries-dimensions.md +++ b/docs/sources/basics/timeseries-dimensions.md @@ -90,4 +90,4 @@ In this case the labels that represent the dimensions will have two keys based o In the case of SQL-like data sources, more than one numeric column can be selected, with or without additional string columns to be used as dimensions. For example, `AVG(Temperature) AS AvgTemp, MAX(Temperature) AS MaxTemp`. This, if combined with multiple dimensions, can result in a lot of series. Selecting multiple values is currently only designed to be used with visualization. -Additional technical information on tabular time series formats and how dimensions are extracted can be found in [the developer documentation on data frames as time series]({{< relref "../developers/plugins/data-frames.md#data-frames-as-time-series" >}}). +Additional technical information on tabular time series formats and how dimensions are extracted can be found in [the developer documentation on data frames as time series](https://grafana.com/developers/plugin-tools/introduction/data-frames#data-frames-as-time-series). diff --git a/docs/sources/datasources/mssql.md b/docs/sources/datasources/mssql.md index 5f327f351bd..d00862d6ba8 100644 --- a/docs/sources/datasources/mssql.md +++ b/docs/sources/datasources/mssql.md @@ -177,7 +177,7 @@ The resulting table panel: If you set Format as to _Time series_, then the query must have a column named time that returns either a SQL datetime or any numeric datatype representing Unix epoch in seconds. In addition, result sets of time series queries must be sorted by time for panels to properly visualize the result. -A time series query result is returned in a [wide data frame format]({{< relref "../developers/plugins/data-frames.md#wide-format" >}}). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. +A time series query result is returned in a [wide data frame format](https://grafana.com/developers/plugin-tools/introduction/data-frames#wide-format). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. > For backward compatibility, there's an exception to the above rule for queries that return three columns including a string column named metric. Instead of transforming the metric column into field labels, it becomes the field name, and then the series name is formatted as the value of the metric column. See the example with the metric column below. diff --git a/docs/sources/datasources/mysql.md b/docs/sources/datasources/mysql.md index efcd31b8e39..4458d65e525 100644 --- a/docs/sources/datasources/mysql.md +++ b/docs/sources/datasources/mysql.md @@ -186,7 +186,7 @@ The resulting table panel: If you set Format as to _Time series_, then the query must have a column named time that returns either a SQL datetime or any numeric datatype representing Unix epoch in seconds. In addition, result sets of time series queries must be sorted by time for panels to properly visualize the result. -A time series query result is returned in a [wide data frame format]({{< relref "../developers/plugins/data-frames.md#wide-format" >}}). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. +A time series query result is returned in a [wide data frame format](https://grafana.com/developers/plugin-tools/introduction/data-frames#wide-format). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. > For backward compatibility, there's an exception to the above rule for queries that return three columns including a string column named metric. Instead of transforming the metric column into field labels, it becomes the field name, and then the series name is formatted as the value of the metric column. See the example with the metric column below. diff --git a/docs/sources/datasources/postgres.md b/docs/sources/datasources/postgres.md index 6f89572a35b..b5f00730549 100644 --- a/docs/sources/datasources/postgres.md +++ b/docs/sources/datasources/postgres.md @@ -191,7 +191,7 @@ The resulting table panel: If you set Format as to _Time series_, then the query must have a column named time that returns either a SQL datetime or any numeric datatype representing Unix epoch in seconds. In addition, result sets of time series queries must be sorted by time for panels to properly visualize the result. -A time series query result is returned in a [wide data frame format]({{< relref "../developers/plugins/data-frames.md#wide-format" >}}). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. +A time series query result is returned in a [wide data frame format](https://grafana.com/developers/plugin-tools/introduction/data-frames#wide-format). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. > For backward compatibility, there's an exception to the above rule for queries that return three columns including a string column named metric. Instead of transforming the metric column into field labels, it becomes the field name, and then the series name is formatted as the value of the metric column. See the example with the metric column below. diff --git a/docs/sources/developers/_index.md b/docs/sources/developers/_index.md index 0d2673c8a41..a0c0b2e989a 100644 --- a/docs/sources/developers/_index.md +++ b/docs/sources/developers/_index.md @@ -10,7 +10,7 @@ weight: 190 This section of the documentation contains pages with resources for Grafana developers: - [Grafana Contribution Guide - learn how you can contribute your skills to make Grafana even better.]({{< relref "contribute.md" >}}) -- [How to build a plugin]({{< relref "plugins" >}}) +- [How to build a plugin](https://grafana.com/developers/plugin-tools) - [Grafana Tutorials - step-by-step guides that help you make the most of Grafana](/tutorials/) - [Grafana Community Forums - get technical support for open source Grafana, Loki, and Tempo.](https://community.grafana.com) - [Grafana design system - library of reusable Grafana components and guidelines that help you with contribution and plugin development](https://developers.grafana.com) diff --git a/docs/sources/installation/upgrading.md b/docs/sources/installation/upgrading.md index b36ddea547b..d7766de3674 100755 --- a/docs/sources/installation/upgrading.md +++ b/docs/sources/installation/upgrading.md @@ -346,7 +346,7 @@ Refer to [Grafana Live configuration]({{< relref "../live/configure-grafana-live ### Postgres, MySQL, Microsoft SQL Server data sources -Grafana v8.0 changes the underlying data structure to [data frames]({{< relref "../developers/plugins/data-frames.md" >}}) for the Postgres, MySQL, Microsoft SQL Server data sources. As a result, a _Time series_ query result gets returned in a [wide format]({{< relref "../developers/plugins/data-frames.md#wide-format" >}}). To make the visualizations work as they did before, you might have to do some manual migrations. +Grafana v8.0 changes the underlying data structure to [data frames](https://grafana.com/developers/plugin-tools/introduction/data-frames) for the Postgres, MySQL, Microsoft SQL Server data sources. As a result, a _Time series_ query result gets returned in a [wide format](https://grafana.com/developers/plugin-tools/introduction/data-frames#wide-format). To make the visualizations work as they did before, you might have to do some manual migrations. For any existing panels/visualizations using a _Time series_ query, where the time column is only needed for filtering the time range, for example, using the bar gauge or pie chart panel, we recommend that you use a _Table query_ instead and exclude the time column as a field in the response. Refer to this [issue comment](https://github.com/grafana/grafana/issues/35534#issuecomment-861519658) for detailed instructions and workarounds. diff --git a/docs/sources/panels/transform-data/transformation-functions.md b/docs/sources/panels/transform-data/transformation-functions.md index 5963d9cde39..65b6207f0c2 100644 --- a/docs/sources/panels/transform-data/transformation-functions.md +++ b/docs/sources/panels/transform-data/transformation-functions.md @@ -496,7 +496,7 @@ As you can see each row in the source data becomes a separate field. Each field > **Note:** This transformation is available in Grafana 7.5.10+ and Grafana 8.0.6+. -Prepare time series transformation is useful when a data source returns time series data in a format that isn't supported by the panel you want to use. For more information about data frame formats, refer to [Data frames]({{< relref "../../developers/plugins/data-frames.md" >}}). +Prepare time series transformation is useful when a data source returns time series data in a format that isn't supported by the panel you want to use. For more information about data frame formats, refer to [Data frames](https://grafana.com/developers/plugin-tools/introduction/data-frames). This transformation helps you resolve this issue by converting the time series data from either the wide format to the long format or the other way around. diff --git a/docs/sources/panels/working-with-panels/format-standard-fields.md b/docs/sources/panels/working-with-panels/format-standard-fields.md index 970bc6c7e23..fe4aaa0d2e7 100644 --- a/docs/sources/panels/working-with-panels/format-standard-fields.md +++ b/docs/sources/panels/working-with-panels/format-standard-fields.md @@ -7,7 +7,7 @@ weight: 40 # Format a standard field -The data model used in Grafana, namely the [data frame]({{< relref "../../developers/plugins/data-frames.md" >}}), 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. +The data model used in Grafana, namely the [data frame](https://grafana.com/developers/plugin-tools/introduction/data-frames), 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 and overrides that you apply do not change the data, they change how Grafana displays the data. When you change an option, it is applied to all fields, meaning all series or columns. For example, if you change the unit to percentage, then all fields with numeric values are displayed in percentages. diff --git a/docs/sources/plugins/_index.md b/docs/sources/plugins/_index.md index b0b17ca1ff6..bd02669103a 100644 --- a/docs/sources/plugins/_index.md +++ b/docs/sources/plugins/_index.md @@ -7,7 +7,7 @@ weight: 160 Besides the wide range of visualizations and data sources that are available immediately after you install Grafana, you can extend your Grafana experience with _plugins_. -You can [install]({{< relref "installation.md" >}}) one of the plugins built by the Grafana community, or [build one yourself]({{< relref "../developers/plugins/_index.md" >}}). +You can [install]({{< relref "installation.md" >}}) one of the plugins built by the Grafana community, or [build one yourself](https://grafana.com/developers/plugin-tools). Grafana supports three types of plugins: [panels](https://grafana.com/grafana/plugins?type=panel), [data sources](https://grafana.com/grafana/plugins?type=datasource), and [apps](https://grafana.com/grafana/plugins?type=app). diff --git a/docs/sources/plugins/plugin-signatures.md b/docs/sources/plugins/plugin-signatures.md index 5cbf4849ff6..39a9a809c5c 100644 --- a/docs/sources/plugins/plugin-signatures.md +++ b/docs/sources/plugins/plugin-signatures.md @@ -17,7 +17,7 @@ Grafana also writes an error message to the server log: WARN[05-26|12:00:00] Some plugin scanning errors were found errors="plugin '' is unsigned, plugin '' has an invalid signature" ``` -If you are a plugin developer and want to know how to sign your plugin, refer to [Sign a plugin]({{< relref "../developers/plugins/sign-a-plugin.md" >}}). +If you are a plugin developer and want to know how to sign your plugin, refer to [Sign a plugin](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin). | Signature status | Description | | ------------------ | ------------------------------------------------------------------------------- | diff --git a/docs/sources/shared/alerts/grafana-managed-alerts.md b/docs/sources/shared/alerts/grafana-managed-alerts.md index 3df2ec2a06b..aa4f689dd46 100644 --- a/docs/sources/shared/alerts/grafana-managed-alerts.md +++ b/docs/sources/shared/alerts/grafana-managed-alerts.md @@ -14,7 +14,7 @@ Alerting rules can only query backend data sources with alerting enabled: - builtin or developed and maintained by grafana: `Graphite`, `Prometheus`, `Loki`, `InfluxDB`, `Elasticsearch`, `Google Cloud Monitoring`, `Cloudwatch`, `Azure Monitor`, `MySQL`, `PostgreSQL`, `MSSQL`, `OpenTSDB`, `Oracle`, and `Azure Data Explorer` -- any community backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json]({{< relref "../../developers/plugins/metadata.md" >}})) +- any community backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json](https://grafana.com/developers/plugin-tools/reference-plugin-json)) ## Metrics from the alerting engine diff --git a/docs/sources/visualizations/status-history.md b/docs/sources/visualizations/status-history.md index 310e18c303c..ea3dc3dfe90 100644 --- a/docs/sources/visualizations/status-history.md +++ b/docs/sources/visualizations/status-history.md @@ -43,7 +43,7 @@ Controls the opacity of state regions. ## Value mappings -To assign colors to boolean or string values, use the [Value mappings]({{< relref "../value-mappings" >}}). +To assign colors to boolean or string values, use the Value mappings. {{< figure src="/static/img/docs/v8/value_mappings_side_editor.png" max-width="300px" caption="Value mappings side editor" >}} diff --git a/docs/sources/whatsnew/whats-new-in-v7-0.md b/docs/sources/whatsnew/whats-new-in-v7-0.md index 19edd88b25c..f685bdcb64e 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-0.md +++ b/docs/sources/whatsnew/whats-new-in-v7-0.md @@ -72,7 +72,7 @@ For users with large dashboards or with heavy queries, being able to reuse the q The [Google Sheets data source](https://grafana.com/grafana/plugins/grafana-googlesheets-datasource) that was published a few weeks ago works really well together with the transformations feature. -We are also introducing a new shared data model for both time series and table data that we call [DataFrame]({{< relref "../developers/plugins/data-frames/#data-frames" >}}). A DataFrame is like a table with columns but we refer to columns as fields. A time series is a DataFrame with two fields (time & value). +We are also introducing a new shared data model for both time series and table data that we call [DataFrame](https://grafana.com/developers/plugin-tools/introduction/data-frames). A DataFrame is like a table with columns but we refer to columns as fields. A time series is a DataFrame with two fields (time & value). **Transformations shipping in 7.0** @@ -126,9 +126,9 @@ Grafana 7.0 adds logging support to one of our most popular cloud provider data ## Plugins platform -The [platform for plugins]({{< relref "../developers/plugins/" >}}) has been completely re-imagined and provides ready-made components and tooling to help both inexperienced and experienced developers get up and running more quickly. The tooling, documentation, and new components will improve plugin quality and reduce long-term maintenance. We are already seeing that a high quality plugin with the Grafana look and feel can be written in much fewer lines of code than previously. +The [platform for plugins](https://grafana.com/developers/plugin-tools) has been completely re-imagined and provides ready-made components and tooling to help both inexperienced and experienced developers get up and running more quickly. The tooling, documentation, and new components will improve plugin quality and reduce long-term maintenance. We are already seeing that a high quality plugin with the Grafana look and feel can be written in much fewer lines of code than previously. -Learn more about developing plugins in the new framework in [Build a plugin]({{< relref "../developers/plugins/_index.md" >}}). +Learn more about developing plugins in the new framework in [Build a plugin](https://grafana.com/developers/plugin-tools). ### Front end plugins platform @@ -142,13 +142,13 @@ With [@grafana/toolkit](https://www.npmjs.com/package/@grafana/toolkit) we are d ### Support for backend plugins -Grafana now officially supports [backend plugins]({{< relref "../developers/plugins/backend/_index.md" >}}) and the first type of plugin to be introduced is a backend component for data source plugins. You can optionally add a backend component to your data source plugin and implement the query logic there to automatically enable alerting in Grafana for your plugin. In the 7.0 release, we introduce the [Grafana Plugin SDK for Go]({{< relref "../developers/plugins/backend/grafana-plugin-sdk-for-go.md" >}}) that enables and simplifies building a backend plugin in [Go](https://golang.org/). +Grafana now officially supports [backend plugins](https://grafana.com/developers/plugin-tools/introduction/backend-plugins) and the first type of plugin to be introduced is a backend component for data source plugins. You can optionally add a backend component to your data source plugin and implement the query logic there to automatically enable alerting in Grafana for your plugin. In the 7.0 release, we introduce the [Grafana Plugin SDK for Go](https://grafana.com/developers/plugin-tools/introduction/grafana-plugin-sdk-for-go) that enables and simplifies building a backend plugin in [Go](https://golang.org/). Plugins can be monitored with the new metrics and health check capabilities. The new Resources capability means backend components can return non-time series data like JSON or static resources like images and opens up Grafana for new use cases. With this release, we are deprecating the unofficial first version of backend plugins which will be removed in a future release. -To learn more, start with the [overview]({{< relref "../developers/plugins/backend/_index.md" >}}). Next, in this [tutorial](https://grafana.com/tutorials/build-a-data-source-backend-plugin/) you'll learn how to build a backend for a data source plugin and enable it for use with [Grafana Alerting]({{< relref "../alerting/_index.md" >}}). Make sure to keep an eye out for additional documentation and tutorials that will be published after the Grafana v7.0 release. +To learn more, start with the [overview](https://grafana.com/developers/plugin-tools/introduction/backend-plugins). Next, in this [tutorial](https://grafana.com/tutorials/build-a-data-source-backend-plugin/) you'll learn how to build a backend for a data source plugin and enable it for use with [Grafana Alerting]({{< relref "../alerting/_index.md" >}}). Make sure to keep an eye out for additional documentation and tutorials that will be published after the Grafana v7.0 release. ## New tutorials diff --git a/docs/sources/whatsnew/whats-new-in-v7-4.md b/docs/sources/whatsnew/whats-new-in-v7-4.md index 0327490ca92..7e7b2053b51 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-4.md +++ b/docs/sources/whatsnew/whats-new-in-v7-4.md @@ -178,7 +178,7 @@ The feature previously referred to as DataSource Start Pages or Cheat Sheets has [Queries]({{< relref "../panels/query-a-data-source/manage-queries.md" >}}) was updated as a result of this feature. -For more information on adding a query editor help component to your plugin, refer to [Add a query editor help component]({{< relref "../developers/plugins/add-query-editor-help.md" >}}). +For more information on adding a query editor help component to your plugin, refer to [Add a query editor help component](https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/add-query-editor-help). ### Variable inspector