diff --git a/docs/sources/developers/plugins/_index.md b/docs/sources/developers/plugins/_index.md index cd20612d542..64a4a13f582 100644 --- a/docs/sources/developers/plugins/_index.md +++ b/docs/sources/developers/plugins/_index.md @@ -17,6 +17,8 @@ Open the terminal, and run the following command in your [plugin directory]({{< npx @grafana/toolkit plugin:create my-grafana-plugin ``` +> **Note:** If running NPM 7+ the `npx` commands mentioned in this article may hang. The workaround is to use `npx --legacy-peer-deps `. + If you want a more guided introduction to plugin development, check out our tutorials: - [Build a panel plugin]({{< relref "/tutorials/build-a-panel-plugin.md" >}}) diff --git a/docs/sources/developers/plugins/sign-a-plugin.md b/docs/sources/developers/plugins/sign-a-plugin.md index 5e0623f0245..9138ae8644e 100644 --- a/docs/sources/developers/plugins/sign-a-plugin.md +++ b/docs/sources/developers/plugins/sign-a-plugin.md @@ -41,6 +41,8 @@ Public plugins need to be reviewed by the Grafana team before you can sign them. npx @grafana/toolkit plugin:sign ``` +> **Note:** If running NPM 7+ the `npx` commands mentioned in this article may hang. The workaround is to use `npx --legacy-peer-deps `. + ## Sign a private plugin 1. In your plugin directory, sign the plugin with the API key you just created. Grafana Toolkit creates a [MANIFEST.txt](#plugin-manifest) file in the `dist` directory of your plugin. diff --git a/packages/grafana-toolkit/README.md b/packages/grafana-toolkit/README.md index bbb06243b36..67f653a11a5 100644 --- a/packages/grafana-toolkit/README.md +++ b/packages/grafana-toolkit/README.md @@ -15,6 +15,8 @@ yarn install yarn dev ``` +> **Note:** If running NPM 7+ the `npx` commands mentioned in this article may hang. The workaround is to use `npx --legacy-peer-deps `. + ## Update your plugin to use grafana-toolkit Follow the steps below to start using grafana-toolkit in your existing plugin.