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

Update tutorial one to use the cute gatsby illustration #9655

Closed
tanvibhakta opened this issue Nov 2, 2018 · 9 comments
Closed

Update tutorial one to use the cute gatsby illustration #9655

tanvibhakta opened this issue Nov 2, 2018 · 9 comments
Labels
good first issue Issue that doesn't require previous experience with Gatsby type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@tanvibhakta
Copy link
Contributor

#9412 updates the default starter to use a cool illustration of an astronaut holding a tasty treat! Let's update the tutorial one to use the same image, instead of a random image from unsplash.
The tutorial is here:
https://www.gatsbyjs.org/tutorial/part-one/
The file to edit is here:
https://github.com/gatsbyjs/gatsby/blob/master/docs/tutorial/part-one/index.md

You will also need to update the relevant screenshots.

Let's spread the purple love!

@tanvibhakta tanvibhakta added type: documentation An issue or pull request for improving or updating Gatsby's documentation good first issue Issue that doesn't require previous experience with Gatsby labels Nov 2, 2018
@ebello
Copy link

ebello commented Nov 2, 2018

Hi @tanvibhakta I'd be happy to take this one on.

@barrymcgee
Copy link
Contributor

@tanvibhakta Hi 👋🏻 First time contributor to this project and I'm not sure of the etiquette here - as @ebello has commented above saying he would like to take this issue on, does that mean this issue is now assigned to him and no-one else should push a PR against this issue?

@tanvibhakta
Copy link
Contributor Author

Hey @ebello go ahead and create the PR!

Hey @barrymcgee! Welcome to Gatsby! To be honest I'm pretty new here too - how about we wait for a day or two and come back again? Meanwhile, I encourage you to check out more issues labelled 'good-first-issue' and see if there's something you can find to work on? Happy to help either way. :)

@ebello
Copy link

ebello commented Nov 3, 2018

Hi all, I hope I'm not making this more complicated than it should be, but for purposes of the tutorial I think we should use a pre-hosted image to keep things as easy as possible. I'm looking for a URL of where the Gatsby astronaut image would be, and thought to look at the demo site for the default starter, but it looks like it's using an old version. Is it possible to update the Netlify site with the latest default starter? Or is that image hosted elsewhere already?

@barrymcgee
Copy link
Contributor

@ebello The risk with using an image hosted elsewhere is that we can't guarantee it will always be available.

If for some reason, the image was pulled offline, users working through the "Hello World" tutorial would be left wondering why their code is broken already.

The ideal solution is that the image would be available as a relative link in their project folder already as part of the gatsby-starter-hello-world - I've proposed a PR above to (I think) do that.

@lexishanson
Copy link
Contributor

Is this the image you're looking for? https://github.com/gatsbyjs/gatsby-starter-default/blob/master/src/images/gatsby-astronaut.png

pieh pushed a commit that referenced this issue Nov 4, 2018
## Done 🙌🏻

While I was doing some digging for #9655, I noticed the tutorial folders contained redundant image files that were no longer being used anywhere in the codebase. I have removed them.

## Why? 🧐

- This is a huge codebase, cloning it to my machine took ten minutes. Removing any redundant files will help, albeit only a little. But every little helps, right? 👍🏻

- It easier to maintain a site which only contains files that are being used as there is less cognitive overload.

## How to QA this change 🤓

- Grep the codebase for each file I have deleted
- You should return 0 results for each file.
@ebello
Copy link

ebello commented Nov 4, 2018

@barrymcgee Thanks I agree that copying the image over to the starter project and making a relative link is a better solution. Will merge your edit in.

@ebello
Copy link

ebello commented Nov 4, 2018

Ah, @barrymcgee I didn't realize they were separate repos. I made a note that my PR should be contingent upon yours.

@shannonbux
Copy link
Contributor

Closing this now; it ought to have been closed when #9698 was closed.

gpetrioli pushed a commit to gpetrioli/gatsby that referenced this issue Jan 22, 2019
## Done 🙌🏻

While I was doing some digging for gatsbyjs#9655, I noticed the tutorial folders contained redundant image files that were no longer being used anywhere in the codebase. I have removed them.

## Why? 🧐

- This is a huge codebase, cloning it to my machine took ten minutes. Removing any redundant files will help, albeit only a little. But every little helps, right? 👍🏻

- It easier to maintain a site which only contains files that are being used as there is less cognitive overload.

## How to QA this change 🤓

- Grep the codebase for each file I have deleted
- You should return 0 results for each file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issue that doesn't require previous experience with Gatsby type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants