grafana / grafana/plugin-tools

Docs: Add docs on how to bundle grafana/ui

Open
#1,491 0 comments 0 reactions 1 assignee Claimed by @urbiz-grafana View on GitHub
enhancement no stalebot type/docs
Dominant language
TypeScript
Stars
89
Forks
57
Avg merge
3d 17h
Merged PRs (30d)
37

Description

### Which areas does this feature request relate to

- [ ] Create Plugin
- [ ] Sign Plugin
- [ ] Plugin E2E
- [ ] Plugin Meta Extractor
- [x] Documentation

### Problem

As discussed in [this doc](https://docs.google.com/document/d/1qRkMXC1Rkp4PKy_o8o_8wfw-lCdIovqj4OhIYH_0Xfs/edit?tab=t.0), bundling `grafana/ui` in the plugin is part of our strategy for mitigating breaking changes. This capability has now been available since G10.4, which is the lowest "officially supported" Grafana version. This means that this feature can now be used more broadly. However, the process for bundling `grafana/ui` is still completely undocumented.

### Solution

We should add a "how-to guide" on how to bundle grafana/ui. The doc should also be referenced from the "Plugin compatibility" section in the best-practices doc.

### Alternatives

_No response_

### Additional context

_No response_

### Are you interested in contributing the solution?

- [ ] Yes
- [ ] No

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.