Skip to content

Docs: Document group property for link extensions#2491

Merged
mckn merged 2 commits intomainfrom
mckn/doc-group-replaces-category
Feb 27, 2026
Merged

Docs: Document group property for link extensions#2491
mckn merged 2 commits intomainfrom
mckn/doc-group-replaces-category

Conversation

@mckn
Copy link
Collaborator

@mckn mckn commented Feb 26, 2026

Summary

Documents the new group property that replaces the deprecated category property on link extensions in Grafana 13. Includes comprehensive migration guidance with code examples and updates the UI extensions reference table.

What this PR does / why we need it

The group property provides improved control over how links are grouped and displayed in the UI, offering optional icon support compared to the string-based category property. This PR documents the migration path for plugin developers.

Related to: grafana/grafana#116481

Which issue(s) this PR fixes

Fixes #

Special notes for your reviewer

  • The category property continues to work (backward compatibility) but will be removed in a future Grafana version
  • Migration examples show usage in both direct config and the configure() callback
  • The reference table has been updated to mark category as deprecated and document the new group property

Updates documentation to introduce the new `group` property that replaces the deprecated `category` property on link extensions in Grafana 13. Includes migration guidance with code examples and updates to the UI extensions reference table.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings February 26, 2026 11:05
@mckn mckn requested review from a team as code owners February 26, 2026 11:05
@mckn mckn requested a review from academo February 26, 2026 11:05
@github-actions
Copy link
Contributor

github-actions bot commented Feb 26, 2026

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

@mckn mckn self-assigned this Feb 26, 2026
@mckn mckn moved this from 📬 Triage to 🔬 In review in Grafana Catalog Team Feb 26, 2026
@mckn mckn added type/docs Changes only affect the documentation no-changelog Don't include in changelog and version calculations labels Feb 26, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents the new group property for link UI extensions in Grafana 13 and provides migration guidance for plugin developers transitioning from the deprecated category property.

Changes:

  • Updates the UI extensions reference to mark category as deprecated and document the new group object shape.
  • Adds a Grafana 12.x → 13.x migration guide section explaining how to migrate from category to group, including examples.
  • Updates the UI extensions how-to guide example comments to include group and flag category as deprecated.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docusaurus/docs/reference/ui-extensions-reference/ui-extensions.md Updates the addLink() config reference table to deprecate category and add group.
docusaurus/docs/migration-guides/update-from-grafana-versions/v12.x-v13.x.md Adds migration guidance and examples for moving from category to group.
docusaurus/docs/how-to-guides/ui-extensions/register-an-extension.md Updates inline guidance/comments to reflect category deprecation and introduce group.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Contributor

@hugohaggmark hugohaggmark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesomeness 🚀

@mckn mckn merged commit 1ea1f50 into main Feb 27, 2026
28 checks passed
@mckn mckn deleted the mckn/doc-group-replaces-category branch February 27, 2026 07:26
@github-project-automation github-project-automation bot moved this from 🔬 In review to 🚀 Shipped in Grafana Catalog Team Feb 27, 2026
tolzhabayev pushed a commit that referenced this pull request Feb 27, 2026
Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation

Projects

Status: 🚀 Shipped

Development

Successfully merging this pull request may close these issues.

3 participants