-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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
Update tutorial one to reference gatsby astronaut image #9698
Update tutorial one to reference gatsby astronaut image #9698
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I took another look at my PR this morning and realised the most appropriate place to add the astronaut image is in the static
folder.
When a user then runs npm start
, this will be copied to the public
folder and available to link in the src attribute as simply ./images/gatsby-astronaut.png
.
I believe importing the image here as you have (I understand you took this approach based on my previous proposal) is the wrong approach to suggest to new users as they may then try to scale this approach up for every image they want to add to a page.
Would you mind updating the code snippet and screenshot to reflect my updated changes?
docs/tutorial/part-one/index.md
Outdated
|
||
```jsx{7}:title=src/pages/index.js | ||
```jsx{2,8}:title=src/pages/index.js |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you explain to me what this change is please? I haven't seen it before...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is code snippet line highlighting. It specifies that line 2 and 8 should be highlighted to denote the changes made.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TIL - thank you.
Not a problem, this is even easier which is the spirit of the tutorial. Just pushed. |
@ebello Looks good to me - once my PR to add the image to the starter lands, this can land too 👌🏻 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just two pieces of feedback here:
-
Where would the image be getting pulled from? I looked in https://github.com/gatsbyjs/gatsby-starter-hello-world and can't find it.
-
I love this image and think it'd be fun to introduce it at some point. However, if tutorial users don't know how to replicate this step of adding an image, I wonder if it's really worth introducing this step, since the purpose of the tutorial is to teach people how to build a site. I think adding an image tutorial that teaches people how to use
gatsby-image
would be the most valuable thing to do, and it could use this image.
Hi @shannonbux, we have an outstanding PR from @barrymcgee to add the image to the starter here: I like your idea of using the image with |
Hello everyone! Thanks for your hard work here and apologies for the time it took to reach a decision on this PR and the connected one. For now, I'm going to close this in favor of #9374 since a adding a page to the tutorial specifically on |
It will be valuable to get your input on that new Here's the issue for cleaning those up! |
Hi @shannonbux - thanks for bringing this to a conclusion. Just so I know for future, what's the process around approving issues so we know that when we start an issue, it's a valid/approved issue? I, and I'm sure @ebello, would like to avoid this situation in future where we spent time working on an issue that it seems no-one agreed it should have been worked on at all. If I get some time this week, I'll have a look at the |
Hi!
Thanks for responding and asking questions! In this case, it was totally
legitimate for you to propose the issue and then it was the core team’s
responsibility to evaluate the issue and it took us some time to
deliberate; we are also committed on reducing that amount of time in the
future. This is part of the beauty of open source projects—there are
creative ideas from the community that inspire valuable discussions! So
imho this issue has been super valuable for Gatsby community because it
spurred discussions on:
- what the purpose of the tutorial is
- how to encourage best practices in general
- how to make it easier for people to learn and use gatsby-image
- how to streamline decision-making about edits to the tutorial in the
future
In other words, I’m really glad you opened the issue and worked on the PR
because it made a big difference.
To address your question on how to avoid creating this same situation in
the future (and thanks for asking and holding us accountable! It’s awesome
to know that you want to make sure we optimize our open source process over
time), here is the text I drafted yesterday to save as a GitHub saved reply
and also I just submitted a PR to put this in the “How to Contribute”
documentation. This will hopefully help clarify the process. Would be
valuable to get feedback on this too!
“Hello! The Gatsby open source community is committed to increasing the
quality of Gatsby documentation, and this contribution needs to match our
contribution criteria. We kindly ask that you make sure this contribution
meets the standards outlined in the [Gatsby Style Guide](
https://www.gatsbyjs.org/docs/gatsby-style-guide/). Also, if this PR did
not come from an issue written by the core team, please add a comment to
this PR that explains why this should be included in the docs, according to
the [Docs Decision Tree](
https://www.gatsbyjs.org/blog/2018-10-12-uptick-docs-contributions-hacktoberfest/#docs-decision-tree-and-examples
).
If, after two weeks the two requirements above haven't been met, this issue
and/or PR will be closed, which helps us triage issues and PRs efficiently.
You can request that it be reopened when and if you are ready to make the
updates required.
Thank you in advance and cheers for contributing to Gatsby! It's people
like you that make this community great! :smiling_face:”
Thanks again for responding and asking questions!
…On Tue, Nov 13, 2018 at 4:08 AM Barry McGee ***@***.***> wrote:
Hi @shannonbux <https://github.com/shannonbux> - thanks for bringing this
to a conclusion. Just so I know for future, what's the process around
approving issues so we know that when we start an issue, it's a
valid/approved issue?
I, and I'm sure @ebello <https://github.com/ebello>, would like to avoid
this situation in future where we spent time working on an issue that it
seems no-one agreed it should have been worked on at all.
If I get some time this week, I'll have a look at the gatsy-image tasks.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#9698 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/Ae9o2mdDdzCh-AXDniOuO7CvgpggKmIaks5uuqgtgaJpZM4YNi_z>
.
|
This will close #9655 but should not be merged until
gatsby-starter-hello-world
adds the referenced image, which @barrymcgee did in gatsbyjs/gatsby-starter-hello-world#27.