Hackathon: create-plugin suggestions #198
idastambuk
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
For our hackathon project, we were building a datasource plugin from scratch and decided to do it according to the docs. We did some user testing with someone new to plugin development and found some of the tutorial documentation to be confusing in places.
We decided to open a ticket with suggestions on improvements in the docs in order for new plugin developers to be able to get up and running more easily and with more confidence.
Readmes we read:
Create Plugin Tutorial,
Create-Plugin Tool,
Build A Datasource Plugin Tutorial
Questions we had:
Difference between datasource, panel, and app plugins wasn’t clear so it was hard to tell which one the user wanted to build! We would suggest adding
For more information on the types of plugins you can build, refer to the [Plugin Overview].
line in all of the “Create X plugin” tutorial pages instead of just “Create a plugin” pageRan
npx @grafana/create-plugin
and had a lot of questions that we weren’t sure how to answerSpecifically,
Not clear that these two steps will determine the repo name + “datasource” organizationName-pluginName-plugin
We weren't sure what the consequences of the answers to these three were in the generated repo and app.
Could we add some background information on what the user should expect when running
npx @grafana/create-plugin
and what the steps imply for later development?After create-plugin is done, mage and docker-compose up have to be run, but they aren’t in the “prerequisites” list
While building the plugin, a few questions popped up:
We're getting "Unsigned plugin" label/warning, we should add
GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=nameofyourplugin
or setting grafana to development more somewhere in the docsThe query section in Build a datasource plugin page contains just the frontend steps, so it's unclear what the best practice is for connecting it to the plugin BE (even though the steps of the 'create plugin' imply user can add a BE)
In the How to build a datasource plugin section, one of the steps is
Rebuild the plugin and try it out.
. It's not clear that the user has to first add a datasource, add a dashboard, and how to do it. These things can be found elsewhere in the documentation, so maybe adding some links would be useful.Beta Was this translation helpful? Give feedback.
All reactions