Skip to content

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

Merged
merged 15 commits into from
Feb 19, 2020

Conversation

Ekwuno
Copy link
Contributor

@Ekwuno Ekwuno commented Feb 5, 2020

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

@Ekwuno Ekwuno requested a review from a team as a code owner February 5, 2020 17:17
Copy link
Contributor

@gillkyle gillkyle left a 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

Copy link
Contributor

@gillkyle gillkyle left a 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

@gillkyle gillkyle added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Feb 10, 2020
@Ekwuno Ekwuno requested a review from a team as a code owner February 11, 2020 11:02
Copy link
Contributor

@laurieontech laurieontech left a 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!

@laurieontech laurieontech added the status: awaiting author response Additional information has been requested from the author label Feb 12, 2020
Copy link
Contributor

@marcysutton marcysutton left a 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!

Copy link
Contributor

@gillkyle gillkyle left a 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!! 🎉

@gillkyle gillkyle merged commit 9b2d51b into gatsbyjs:master Feb 19, 2020
@Ekwuno
Copy link
Contributor Author

Ekwuno commented Feb 20, 2020

Awesome! Thanks @gillkyle 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: awaiting author response Additional information has been requested from the author type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants