public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

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>
(cherry picked from commit e888a40531)

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
This commit is contained in:
Grot (@grafanabot)
2022-01-17 15:47:27 +00:00
committed by GitHub
co-authored by Jack Westbrook
parent cbede52ef6
commit 5681f348c4
3 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/plugins/_index.md
+2
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" >}})
docs/sources/developers/plugins/sign-a-plugin.md
+2
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.