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 image docs recipes #14542

Closed
marcysutton opened this issue Jun 4, 2019 · 1 comment
Closed

[docs] add image docs recipes #14542

marcysutton opened this issue Jun 4, 2019 · 1 comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@marcysutton
Copy link
Contributor

As part of #14529 and following #14251, we are making updates to the Docs Recipes. Because images are part of a key workflow, it makes sense to add an image section to the recipes.

This issue is meant to capture that work and assure it is completed with the new recipe format:

  • Recipes will be grouped into key workflow categories
  • List any requirements or prerequisites
  • Step-by-step instructions (kept short by listing prereq's)
  • Optional live example
  • Links to other resources

For images, concise and digestible recipes would make it clear at a glance that there are multiple techniques. Here are some suggestions:

  • Import into a component with Webpack
  • Reference from static folder
  • Query with GraphQL
    • by relativePath
    • from a directory
    • from post frontmatter
    • fixed width and height
    • fixed maxWidth
    • fluid maxWidth and quality
    • with inline styles applied
    • with fragments (all of them? just a few?)
@gatsbot gatsbot bot added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jun 4, 2019
@marcysutton
Copy link
Contributor Author

marcysutton commented Jun 20, 2019

This work is being broken up into individual issues, so I'm going to close this one. See referenced issues for more!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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