Create Plugin: Update docs to build backend before running docker #167
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
sarahzinger
requested review from
leventebalogh and
jackw
and removed request for
leventebalogh
jackw
added
create-plugin
jackw
force-pushed
the
reverse-backend-and-frontend-instructions
branch
from
a836a6d
to
f98dad9
Compare
|
@sarahzinger have rebased this with main. Will wait for it to build then merge. Thanks so much for helping out with this project! ⭐ |
jackw
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Ensures instructions guide users towards building their plugin's backend before running docker.
Right now if you build a plugin with a backend with the create-plugin tool and follow the instructions as written you'll get a 503 error message with the message "plugin unavailable". This is because if you follow the instructions as currently written you are building the backend of your plugin (
mage -v) after you've runyarn serverordocker-compose up -buildwhich kicks of a dockerized version of grafana but which does not restart if the new files in your plugin are built. It may not be clear to the user that they need to restart yarn server/docker and/or run these commands in a different order.I think in the future it would be awesome to add some tooling to rebuild/restart the server on backend changes as well, but this feels like a nice small incremental improvement in helping people get started faster.
📦 Published PR as canary version:
Canary Versions✨ Test out this PR locally via:
npm install @grafana/create-plugin@0.8.2-canary.167.f98dad9.0 # or yarn add @grafana/create-plugin@0.8.2-canary.167.f98dad9.0