docs: add guidance on extension metadata (#1060)

Co-authored-by: Joseph Perez <[email protected]>
grafana · Aug 20, 2024 · fc147a7 · fc147a7
1 parent 9a22308
commit fc147a7
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 1 deletion.
diff --git a/docusaurus/docs/how-to-guides/ui-extensions/register-an-extension.md b/docusaurus/docs/how-to-guides/ui-extensions/register-an-extension.md
@@ -21,6 +21,12 @@ Read more about extensions under [key concepts](../../key-concepts/ui-extensions
 
 <ExtensionPoints/>
 
+:::warning
+
+You must [update](#updating-pluginjson-metadata) your `plugin.json` metadata to list any registered extensions.
+
+:::
+
 ## Links
 
 ### Register a link
@@ -217,6 +223,25 @@ export const plugin = new AppPlugin().addComponent({
 });
 ```
 
+## Updating plugin.json metadata
+
+Once you have defined a link or component extension to be registered against an extension point, you must update your `plugin.json` metadata.
+
+For example:
+
+```json
+"extensions": [
+    {
+      "extensionPointId": "grafana/dashboard/panel/menu/v1",
+      "type": "link"
+      "title": "My app",
+      "description": "Link to my app"
+    }
+ ]
+```
+
+For more information, see the `plugin.json` [reference](../../reference/metadata.md#extensions).
+
 ## Troubleshooting
 
 ### My link is not appearing

diff --git a/docusaurus/docs/reference/metadata.md b/docusaurus/docs/reference/metadata.md
@@ -311,7 +311,7 @@ Parameters for the token authentication request.
 
 ## extensions
 
-The list of extensions that the plugin registers below other extension points.
+List of link and component extensions which the plugin registers to given extension points.
 
 ### Properties