Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

Commit

Permalink
Merge pull request #118 from grafana/gareth/deprecation-notice
Browse files Browse the repository at this point in the history
Update README with ongoing deprecation plans.
  • Loading branch information
gwdawson authored Feb 26, 2024
2 parents e3b16e2 + d1af35d commit 4b34ad6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 4b34ad6

Please sign in to comment.