mirror of
https://github.com/grafana/grafana.git
synced 2025-02-16 18:34:52 -06:00
Plugins: Add notices to docs to prevent NPX commands from hanging (#44043)
* docs(plugins): add notice about npm 7 flag to prevent commands from hanging * Apply suggestions from code review Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
This commit is contained in:
parent
5ae5a2e0d0
commit
e888a40531
@ -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 <command to run>`.
|
||||
|
||||
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" >}})
|
||||
|
@ -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 <command to run>`.
|
||||
|
||||
## 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.
|
||||
|
@ -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 <command to run>`.
|
||||
|
||||
## Update your plugin to use grafana-toolkit
|
||||
|
||||
Follow the steps below to start using grafana-toolkit in your existing plugin.
|
||||
|
Loading…
Reference in New Issue
Block a user