docs: Clarify migration commands for testing plugins #3336
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
This PR clarifies the migration commands in the "Test the Plugin" section of the Vendure documentation. The current instructions are incomplete and could lead to confusion for users trying to test their plugins.
Changes:
Updated the documentation to clearly separate the two steps required for migrations:
Generating the migration file using
npx vendure migrate wishlist-plugin.Running the migration using
npx vendure migrate wishlist-plugin.Why this matters:
The current documentation only mentions the first step (npm run migration:generate), which give error on cmd.
By explicitly stating both steps, users can seamlessly test their plugins without confusion or errors.
Breaking changes
No
Screenshots
You can add screenshots here if applicable.
Checklist
📌 Always:
👍 Most of the time: