Skip to content
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

[docs] link to plugin README template in Creating a Plugin guide #14774

Closed
gillkyle opened this issue Jun 13, 2019 · 8 comments
Closed

[docs] link to plugin README template in Creating a Plugin guide #14774

gillkyle opened this issue Jun 13, 2019 · 8 comments
Labels
good first issue Issue that doesn't require previous experience with Gatsby help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@gillkyle
Copy link
Contributor

gillkyle commented Jun 13, 2019

Summary

An important hurdle users trying to leverage plugins encounter is not enough documentation, or difficult to understand documentation on plugins. In the Creating Plugins guide there currently isn't much information (only a few sentences at the end of the Submit to Plugin Library section) guiding a plugin author on what should be included in their README.

There is already a template for plugin READMEs thanks to #4284 that exists but it is not linked to or mentioned in that guide.

What to Do

Some helpful things that could be added:

  • linking to the plugin README template from the page Submit to Plugin Library with a note about the template
  • (maybe?) adding a page to the Creating Plugins guide that briefly explains the README template and links to it, perhaps also explaining how good documentation can help new users get started with the plugin
@gillkyle gillkyle added help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation good first issue Issue that doesn't require previous experience with Gatsby topic: plugins labels Jun 13, 2019
@k-conway
Copy link
Contributor

I would like to take this one!

@k-conway
Copy link
Contributor

I have a change ready to go out for PR, but need repo access. Is that something I have to request somewhere other than here?

@gillkyle
Copy link
Contributor Author

gillkyle commented Jun 13, 2019

Thanks @k-conway! It looks like you forked the repository (which basically created your own version of Gatsby on your GitHub profile), sounds like you'll need to do a couple things if you haven't already:

  1. set your fork to track this repository (run this in your folder with your Gatsby fork):
git remote add upstream https://github.com/gatsbyjs/gatsby.git
  1. then you'll need to create your own branch and push your changes to it

  2. then you should see the option to create a PR in the GitHub UI with the changes you've made

Let me know if you need any help!

@gillkyle
Copy link
Contributor Author

gillkyle commented Jun 17, 2019

Hey @k-conway have you been able to get to this, or need any help? 🙂

@k-conway
Copy link
Contributor

k-conway commented Jun 17, 2019 via email

@gillkyle
Copy link
Contributor Author

@k-conway no worries, feel free to get to it when you have time, just want to make sure you don't get stuck and/or frustrated 👍

@k-conway
Copy link
Contributor

k-conway commented Jun 18, 2019 via email

@gillkyle
Copy link
Contributor Author

Thanks @k-conway, merged in #14856

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issue that doesn't require previous experience with Gatsby help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

2 participants