opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-31 18:32:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Plugins: Add notices to docs to prevent NPX commands from hanging (#44043)

Browse Source 
* 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:
Jack Westbrook
2022-01-17 15:58:36 +01:00
committed by GitHub
parent 5ae5a2e0d0
commit e888a40531
3 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sources/developers/plugins/_index.md
View File

@ -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" >}})

2
docs/sources/developers/plugins/sign-a-plugin.md
View File

@ -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.