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][guides] Conceptual guide on Reusable Code Patterns #21282

Closed
3 tasks
marcysutton opened this issue Feb 7, 2020 · 2 comments
Closed
3 tasks

[docs][guides] Conceptual guide on Reusable Code Patterns #21282

marcysutton opened this issue Feb 7, 2020 · 2 comments
Labels
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

@marcysutton
Copy link
Contributor

Summary

Gatsby users should be able to find information on how to make reusable components and scalable code patterns. It should help them understand use cases and terminology with a low barrier to entry. A Conceptual Guide covering this topic could include:

  • Component APIs, props, and conventions (making components that are easy to use)
  • Methods for distributing/importing components in projects: relative paths vs. npm installs
  • How Gatsby Themes factor into all of this, including packaging up common GraphQL queries or plugin usage for ease of use and keeping things DRY
  • When a Markdown, YAML, or JSON file might be an easy solution
  • Gatsby Image use cases

This doc should be a complement to the Adding React Components doc and Creating Component Libraries doc. It should provide unique information about how to write reusable code, in more detail than "Creating Component Libraries" which is more of a high-level best practice guide.

Motivation

Gatsby and React development is all about components: layout components, pages, even third-party component usage. To fill in gaps in the docs, there should be coverage of this topic for developers who want to create and distribute their own components with common use cases and gotchas–or those who are simply trying to copy and paste less code.

Related to #21278.

Draft the doc

Open a pull request

  • Open a pull request with your work including the words "closes #[this issue's number]" in the pull request description
@marcysutton marcysutton added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Feb 7, 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 Feb 28, 2020
@github-actions
Copy link

github-actions bot commented Mar 9, 2020

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! 💪💜

@github-actions github-actions bot closed this as completed Mar 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

1 participant