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

Create gatsby-image-tutorial #15027

Merged
merged 13 commits into from
Jul 15, 2019
Merged

Create gatsby-image-tutorial #15027

merged 13 commits into from
Jul 15, 2019

Conversation

laurieontech
Copy link
Contributor

Description

This is the first draft of a potential tutorial for using gatsby-image in various ways.

Related Issues

Addresses #9374

@laurieontech laurieontech requested a review from a team June 21, 2019 16:04
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.

Thank you so much for putting this together! I made a bunch of suggestions, some are based on the Gatsby Style Guide and some are to enhance the reading experience. Eventually it would be great to have a better story for querying multiple images (say, from a folder) but I think using YAML is a fine solution for now.

I'd love to get some additional feedback from @amberleyromo and @shannonbux. I know Shannon is on vacation until next week so it might take us a little bit, but hopefully not too long.

Thanks again for your work on this @lstar19!

docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
docs/tutorial/gatsby-image-tutorial Outdated Show resolved Hide resolved
@wardpeet wardpeet added type: documentation An issue or pull request for improving or updating Gatsby's documentation status: awaiting author response Additional information has been requested from the author labels Jun 24, 2019
@laurieontech
Copy link
Contributor Author

Thanks Marcy! I'll wait for all the feedback to come in and then incorporate it together. Thanks for taking the time.

@marcysutton
Copy link
Contributor

Here's some feedback from @shannonbux!

I think this has a good tone and fairly good pacing (level of detail seems like just enough to get the tasks done).
The one thing that doesn't quite match the tutorial template is that this isn't really a series of steps. I think in order to be that kind of tutorial, it would need to be a series of steps that you complete. Right now it's more like a conversational guide.
One thing that could be cool is some sort of starter or preset collection of images so the tutorial can show screenshots of what the finished result looks like, and tips on how to test the performance of the images (I always like to slow my browser down to watch them load slower ;)

I think the most actionable thing here is to update the tutorial to match the format outlined in the tutorial template, along with my comments. I love Shannon's suggestion of having a starter project for people to play with–that could be an improvement done later on, as a separate PR.

Thanks again for working on this tutorial, we really appreciate it and you!

@laurieontech
Copy link
Contributor Author

Added all your recommended changes Marcy and tried to do some of the "step" stuff up top. What I'm realizing is there are so many paths to take depending on use case that breaking it down into steps is a bit more challenging past initial set up. Should we break this until multiple tutorials? Or are we ok with this branching?

@marcysutton marcysutton added the topic: media Related to gatsby-plugin-image, or general image/media processing topics label Jul 8, 2019
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.

Thanks so much for this, it's in really good shape! I left a few suggestions that should help with the forking question, @lstar19.

laurieontech and others added 7 commits July 10, 2019 09:24
Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>
Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>
Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>
Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>
Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>
Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>
@laurieontech
Copy link
Contributor Author

Made some edits, looking at it with a narrow view to gatsby-image I'm wondering if I should remove the entire section titled Multiple queries and aliasing. It's helpful in understanding that you can query for multiple images from different places, but it is more about the querying than making use of gatsby-image itself.

@marcysutton
Copy link
Contributor

@lstar19 I think it's useful to include the aliases info. gatsby-image is one of those things where the line of concerns is fuzzy because it requires Gatsby's data layer to operate. So I think it's fine to leave in!

@laurieontech
Copy link
Contributor Author

In that case, I think it might be ready?

@laurieontech laurieontech requested review from a team as code owners July 15, 2019 19:13
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.

Added the tutorial to the sidebar and renamed the Wordpress image tutorial as part of this work! It should be ready to merge now. Thanks for your work on it @lstar19!

@marcysutton marcysutton added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Jul 15, 2019
@marcysutton marcysutton merged commit e2f9d5d into master Jul 15, 2019
@marcysutton marcysutton deleted the docs/gatsby-image-tutorial branch July 15, 2019 20:35
madmonkey pushed a commit to madmonkey/gatsby that referenced this pull request Jul 15, 2019
* Create gatsby-image-tutorial

* gatsby-image rework

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* addressing comments and feedback

* fix image-tutorial URL, add to sidebar

* rename wordpress image tutorial, add redirects
@laurieontech
Copy link
Contributor Author

Thanks Marcy!

johno pushed a commit to johno/gatsby that referenced this pull request Jul 17, 2019
* Create gatsby-image-tutorial

* gatsby-image rework

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/tutorial/gatsby-image-tutorial/gatsby-image-tutorial.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* addressing comments and feedback

* fix image-tutorial URL, add to sidebar

* rename wordpress image tutorial, add redirects
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: merge on green Gatsbot will merge these PRs automatically when all tests passes status: awaiting author response Additional information has been requested from the author topic: media Related to gatsby-plugin-image, or general image/media processing topics 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.

3 participants