Docs: Update reference for the extensions

grafana / plugin-tools

Create Grafana plugins with ease.

https://grafana.com/developers/plugin-tools/

Apache License 2.0

55 stars 27 forks source link

Docs: Update reference for the extensions #954

Closed leventebalogh closed 1 week ago

leventebalogh commented 3 weeks ago

What changed?

This PR updates the docs for UI extensions to cover our latest API changes. It removes the current available /ui-extensions page and moves the content to the /tutorials/ui-extensions and /references/ui-extensions sections.

[x] Update the reference for the plugin extensions based on the API changes
[x] Add tutorials (later becoming "How to guides") for plugin extensions
[x] Clean up the current "UI extensions" page
[x] Add redirects

github-actions[bot] commented 3 weeks ago

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.

CLAassistant commented 2 weeks ago

All committers have signed the CLA.

sunker commented 2 weeks ago

Me and @mckn have gone through this PR again and done a bunch of tweaks. Think it would be great if you could take a look to @josmperez. Changes have been deployed to the dev env.

We're currently aiming to merge this PR by the 24th of June, since that's when G11.1 is released and the new extensions APIs become available for plugin developers.

sympatheticmoose commented 2 weeks ago

@josmperez if possible can you use review comments rather than commits?

josmperez commented 2 weeks ago

@josmperez if possible can you use review comments rather than commits?

Sorry, I've already been making edits that I'm almost ready to check in. Nothing that should be controversial. From this point forward, I'll make suggestions though if that helps.

Feel free to revert the commit if you see anything that looks off, and I'll re-do the edits as suggestions.