-
Notifications
You must be signed in to change notification settings - Fork 10.3k
chore (doc): maintaining a plugin guide. #21221
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is so great @Ekwuno!! 😄 I made a few suggestions, mostly in regards to style guide type things. See what you think of them and let me know
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a few more tweaky changes!
One thing I noticed is that since the stub for this will be removed, you can remove the asterisk from this line in this PR as well: https://github.com/gatsbyjs/gatsby/blob/master/www/src/data/sidebars/doc-links.yaml#L263
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great @Ekwuno! I made some recommendations surrounding phrasing. As a general tip there is a lot of technical detail in our docs, so limiting unnecessary words helps with comprehension. This is gonna be great!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is going to be so awesome, I left a few small suggestions!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making all the updates to this to help it keep improving 😄 I think we ought to get this in since it'll be really helpful and we can always continue making updates down the road as well.
Great work @Ekwuno!! 🎉
Awesome! Thanks @gillkyle 🥳 |
Description
Keeping Plugins up to date becomes really tasking and can sometimes become really complicated since updating dependencies could potentially break your apps. Here's a guide with some of the things you'd have to know and need to ensure that your plugin is updated for your users
Documentation
https://www.gatsbyjs.org/docs/maintaining-a-plugin/
Related Issues
Realated to #21067