[v9.5.x] Docs: fix broken migration-guide (#69891)

docs: fix broken migration-guide
This commit is contained in:
Jack Westbrook
2023-06-12 11:19:54 +02:00
committed by GitHub
parent 423872780b
commit fc3c608ccd
2 changed files with 0 additions and 67 deletions
@@ -1,41 +0,0 @@
---
aliases:
- ../../plugins/developing/migration-guide
keywords:
- grafana
- plugins
- migration
- plugin
- documentation
title: Migration guides
---
<script>
(function () {
// Previously all the migration docs were on a single page, and the different sections could be linked using URL hashes.
var anchorRedirects = {
"migrate-a-plugin-from-angular-to-react": "./angular-react/",
"from-version-62x-to-740": "./v6.x-v7.x#from-version-62x-to-740",
"from-version-65x-to-730": "./v6.x-v7.x#from-version-65x-to-730",
"from-version-6xx-to-700": "./v6.x-v7.x/",
"migrate-to-data-frames": "./v6.x-v7.x/",
"troubleshoot-plugin-migration": "./v6.x-v7.x/",
"from-version-7xx-to-8xx": "./v7.x-v8.x/",
"from-version-83x-to-84x": "./v8.3.x-8.4.x/",
"from-version-8x-to-9x": "./v8.x-v9.x/",
"from-version-91x-to-92x": "./v9.1.x-v9.2.x/",
"from-version-93x-to-94x": "./v9.3.x-9.4.x/",
};
var hash = window.location.hash.substring(1);
var redirectTo = anchorRedirects[hash];
if (redirectTo) {
window.location.replace(redirectTo);
}
})();
</script>
# Plugin migration guide
The following guides help you identify the steps required to update a plugin following changes between versions of Grafana.
{{< section menuTitle="true">}}
@@ -1,26 +0,0 @@
---
description: Guide for migrating plugins from Grafana v9.x to v10.x
keywords:
- grafana
- plugins
- migration
- plugin
- documentation
title: Migrating plugins from Grafana 9.x to 10.x
menutitle: v9.x to v10.x
weight: 1900
---
# Migrating plugins from Grafana version 9.x to 10.x
## Verifying plugin behaviour with React 18
Grafana 10 includes our upgrade to React 18 and use of the new React client rendering API. These changes were delivered to the core `grafana` repo with [PR 64428](https://github.com/grafana/grafana/pull/64428).
Whilst this brings us many significant benefits, there's a potential for this to impact the way your plugin works. In particular, there could be unintended side effects caused by the changes around improving consistency with `useEffect` timings and automatic batching of state updates.
Recommended actions:
- Review the React 18 [upgrade docs](https://react.dev/blog/2022/03/08/react-18-upgrade-guide)
- Test your plugins against one of the latest [grafana-dev docker images](https://hub.docker.com/r/grafana/grafana-dev/tags?page=1) (for example, [this one](https://hub.docker.com/layers/grafana/grafana-dev/10.0.0-111404pre/images/sha256-ac78acf54b44bd2ce7e68b796b1df47030da7f35e53b02bc3eec3f4de05f780f?context=explore))
- Add a comment to the [forum discussion](https://community.grafana.com/t/grafana-10-is-upgrading-to-react-18/86051) if your plugin is impacted in any way. Either to socialise the changes needed for your plugin or to reach out and ask for help yourself.