From d1af35d1c15a8a5398c40da5e72aae5daa410dc9 Mon Sep 17 00:00:00 2001 From: Gareth Dawson Date: Mon, 26 Feb 2024 11:19:34 +0000 Subject: [PATCH] add notice to readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 492aae1..51d359c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Grafana Experimental +> [!WARNING] +> As part of our ongoing efforts to improve and streamline our UI components, we are gradually deprecating this repository.\ +> Components previously housed here are being migrated to other UI components packages such as [grafana/ui](https://github.com/grafana/grafana/tree/main/packages/grafana-ui) and [grafana/plugin-ui](https://github.com/grafana/plugin-ui).\ +> Please note that future development and improvements should happen in the respective new locations. We recommend developers to start using and referencing the new packages in their projects.\ +> Thank you for your understanding and cooperation during this transition. + The main difference between grafana/experimental and grafana/ui is how the components are versioned. Having a separate "experimental" package allows us to release breaking changes when necessary while the grafana/ui package follows a slower-moving policy. As developers use and test the components and report issues, the maintainers learn more about shortcomings of the components. The older and more used a component is, the less likely it is that new issues will be found and subsequently need to introduce breaking changes.