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 using-gatsby-image.md #8131

Merged
merged 4 commits into from
Sep 19, 2018
Merged

Create using-gatsby-image.md #8131

merged 4 commits into from
Sep 19, 2018

Conversation

injoongy
Copy link
Contributor

Issue #8103: This is for the second task, "using gatsby-image to prevent image bloat". I did my best to make sure the links from the original article were still present.

Not sure how to navigate the fact that in the original article, it's specifically Kyle talking, so right now everything's still in first-person. I also cut the last line, which was leading to the next section of the article so wouldn't be relevant here (unless I should have included that next section as well?).

Let me know if there's anything you'd like me to change - this is my first-ever contribution to an open source project (currently in a web dev bootcamp), so I'm sorry if I screwed anything up!

Issue gatsbyjs#8103: This is for the second task, "using gatsby-image to prevent image bloat". I did my best to make sure the links from the original article were still present.

Not sure how to navigate the fact that in the original article, it's specifically Kyle talking, so right now everything's still in first-person. I also cut the last line, which was leading to the next section of the article so wouldn't be relevant here (unless I should have included that next section as well?).

Let me know if there's anything you'd like me to change - this is my first-ever contribution to an open source project (currently in a web dev bootcamp), so I'm sorry if I screwed anything up!
Copy link
Contributor

@shannonbux shannonbux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @AttilaTheHen! This is looking great! Very nice first contribution. If you'd like to tackle any more of these articles, that would be super helpful!

Using gatsby-image to prevent image bloat
====

I recently introduced a new Gatsby/React component called [gatsby-image](https://www.gatsbyjs.org/packages/gatsby-image/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To avoid saying "I" here, maybe just turn this sentence into an introduction to the article. I just realized you could copy the introduction to the plugin READme file here: You know what I just realized! I ought to also have included the plugin READme file as a suggestion for what to include in this doc. I think the intro and then the "Problem" and "Solution" sections would be great to include in this doc: https://www.gatsbyjs.org/packages/gatsby-image/

Also somehow keeping the link to the plugin READme file would be great :)

docs/docs/using-gatsby-image.md Show resolved Hide resolved

I recently introduced a new Gatsby/React component called [gatsby-image](https://www.gatsbyjs.org/packages/gatsby-image/).

It has some nice tricks that you’d expect from a modern image component. It uses the new [IntersectionObserver API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) to cheaply lazy load images. It holds an image’s position so your page doesn’t jump around as images load. It makes it easy to add a placeholder—either a gray background or a blurry version of the image.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You know what I just realized! I ought to also have included the plugin READme file as a suggestion for what to include in this doc. I think the "Problem" and "Solution" sections of the plugin READme file should follow this paragraph: https://www.gatsbyjs.org/packages/gatsby-image/

@shannonbux shannonbux added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Sep 13, 2018
Updated with suggested changes!
@injoongy
Copy link
Contributor Author

Thanks so much, Shannon! I went through and did my best to incorporate all of the changes you requested - please let me know if I've missed anything or if you'd like anything changed.

I'd love to keep tackling some more articles as well - I'll see about getting some others done as time allows.

@shannonbux
Copy link
Contributor

This looks great, @AttilaTheHen! Thanks!
I'll add this to the docs sidebar navigation after merging :)

@KyleAMathews KyleAMathews merged commit aedf814 into gatsbyjs:master Sep 19, 2018
@KyleAMathews
Copy link
Contributor

Thanks!

@gatsbot
Copy link

gatsbot bot commented Sep 19, 2018

Holy buckets, @AttilaTheHen — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

  1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. (Currently we’ve got a couple t-shirts available, plus some socks that are really razzing our berries right now.)
  2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. You’ll receive an email shortly asking you to confirm. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

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

Successfully merging this pull request may close these issues.

3 participants