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) Add context to the existing Plugin README template #21599

Closed
2 tasks
JQuinnie opened this issue Feb 20, 2020 · 10 comments
Closed
2 tasks

(docs) Add context to the existing Plugin README template #21599

JQuinnie opened this issue Feb 20, 2020 · 10 comments
Labels
help wanted Issue with a clear description that the community can help with. stale? Issue that may be closed soon due to the original author not responding any more. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@JQuinnie
Copy link
Contributor

JQuinnie commented Feb 20, 2020

Summary

With the refactor of the Plugin README template into its own page (#21574) additional context should be added. This issue covers adding a quick blurb explaining a README and its purpose/goal for Plugin projects.

Motivation

Help people creating Plugins make them more approachable to users!

Draft the doc

  • Update the doc with the above information

Open a pull request

  • Open a pull request with your work including the words "closes #[this issue's number]" in the pull request description
@gatsbot gatsbot bot added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Feb 20, 2020
@github-actions
Copy link

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

@github-actions github-actions bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Mar 11, 2020
@laurieontech
Copy link
Contributor

I'm not sure this is the best approach. We have an issue #20527 for creating a tutorial on writing a plugin. In general, the contributing section focuses on adding content to the monorepo rather than creating resources for Gatsby users. Those are in the main docs.

Based on the slug/title in the other PR it seems like this doc is actually meant to be a template for the README of a plugin? If that's the case, we should update the description of this issue.

@laurieontech laurieontech removed the stale? Issue that may be closed soon due to the original author not responding any more. label Mar 11, 2020
@JQuinnie
Copy link
Contributor Author

JQuinnie commented Mar 11, 2020

Hi @laurieontech ,

This issue and the associated issue #21600 was created in response to comment guidance I received from PR #21574 , I will update the description of the issue per your request. Let me know if I need to change anything in particular as I might not be extremely familiar with the correct terms and nomenclatures. Thank you so much!

@JQuinnie JQuinnie changed the title (docs) Create a doc on 'How to Write a Plugin' for Docs Contributions (docs) Create README for 'How to Write a Plugin' for Docs Contributions Mar 11, 2020
@laurieontech
Copy link
Contributor

laurieontech commented Mar 11, 2020

Ah, I see. So I think the missing context is that this is looking for the README template page to be expanded upon. Rather than creating a README. I can edit the title, but going to think on this a bit more first. Thanks again for your contributions!

@laurieontech laurieontech changed the title (docs) Create README for 'How to Write a Plugin' for Docs Contributions (docs) Add context to the existing Plugin README template Mar 11, 2020
@github-actions
Copy link

github-actions bot commented Apr 1, 2020

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

@github-actions github-actions bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Apr 1, 2020
@github-actions
Copy link

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.
Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community! 💪💜

@wardpeet wardpeet removed the stale? Issue that may be closed soon due to the original author not responding any more. label Apr 14, 2020
@wardpeet
Copy link
Contributor

ping @laurieontech

@wardpeet wardpeet reopened this Apr 14, 2020
@marcysutton marcysutton added the help wanted Issue with a clear description that the community can help with. label Apr 18, 2020
@github-actions
Copy link

github-actions bot commented May 8, 2020

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

@github-actions github-actions bot added the stale? Issue that may be closed soon due to the original author not responding any more. label May 8, 2020
@github-actions
Copy link

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.
Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community! 💪💜

@mohmmad0505
Copy link

EEEERR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issue with a clear description that the community can help with. stale? Issue that may be closed soon due to the original author not responding any more. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

5 participants