-
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
doc/tutorial/part-one fixes #3383
Conversation
@@ -14,7 +14,7 @@ Sit down, buckle up, and let's get going! | |||
|
|||
## Check your development environment | |||
|
|||
Let's check first that you have everything setup to start creating with Gatsby. | |||
Let's check first that you have everything set up to start creating with Gatsby. |
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.
setup
is a noun. set up
is the phrasal verb being used here.
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.
Amazing — never knew the difference 💯
@@ -30,7 +30,7 @@ You should see something like: | |||
|
|||
![Check if node.js/npm is installed](check-versions.png) | |||
|
|||
Gatsby supports versions of Node back to v4 and NPM to v3. | |||
Gatsby supports versions of Node back to v4 and npm to v3. |
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.
I believe the caps are deprecated. :)
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.
No idea but I'll trust you on this 👍
Deploy preview ready! Built with commit 4822aa3 |
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.
Explanations of my minor changes.
@@ -81,18 +81,18 @@ Too cool 😎 | |||
|
|||
Gatsby's development server is a "hot reloading" server, meaning any change you | |||
make to your React.js page components (and later we'll learn, your data files) | |||
will hot reload in the browser. | |||
will be immediately visible and/or loaded in the browser. |
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.
It's better to not use the term your explaining in your explanation.
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.
Haha yes :-)
docs/tutorial/part-one/index.md
Outdated
@@ -187,12 +187,11 @@ Make the second page component look something like: | |||
import React from "react"; | |||
import Link from "gatsby-link"; | |||
|
|||
export default () => ( | |||
export default () => |
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 the reason I started updating this doc. These parentheses seem unnecessary and they are not in the first example. I thought it might confuse someone totally new to React and Gatsby.
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.
We started running Prettier on the markdown code examples recently which perhaps added this? I'll pull your branch locally and run Prettier again and see what happens.
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.
Hmm it did add it back... investigating.
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.
Yeah, it's because the other code blocks earlier have line highlighting e.g. jsx{1-2}
which makes Prettier skip over them. We'll be moving soon-ish to an inlined way to mark lines to be highlighted which will make Prettier work more consistently.
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.
Okay. Thanks for looking into this. I noticed it and really wondered what was up.
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.
Nice! Really appreciate edits!
@@ -14,7 +14,7 @@ Sit down, buckle up, and let's get going! | |||
|
|||
## Check your development environment | |||
|
|||
Let's check first that you have everything setup to start creating with Gatsby. | |||
Let's check first that you have everything set up to start creating with Gatsby. |
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.
Amazing — never knew the difference 💯
@@ -30,7 +30,7 @@ You should see something like: | |||
|
|||
![Check if node.js/npm is installed](check-versions.png) | |||
|
|||
Gatsby supports versions of Node back to v4 and NPM to v3. | |||
Gatsby supports versions of Node back to v4 and npm to v3. |
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.
No idea but I'll trust you on this 👍
@@ -81,18 +81,18 @@ Too cool 😎 | |||
|
|||
Gatsby's development server is a "hot reloading" server, meaning any change you | |||
make to your React.js page components (and later we'll learn, your data files) | |||
will hot reload in the browser. | |||
will be immediately visible and/or loaded in the browser. |
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.
Haha yes :-)
docs/tutorial/part-one/index.md
Outdated
@@ -187,12 +187,11 @@ Make the second page component look something like: | |||
import React from "react"; | |||
import Link from "gatsby-link"; | |||
|
|||
export default () => ( | |||
export default () => |
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.
We started running Prettier on the markdown code examples recently which perhaps added this? I'll pull your branch locally and run Prettier again and see what happens.
Thanks! |
Thanks for your great responses @KyleAMathews. I plan to go through the other tutorials as well and I'll have them open in Vim as I do so and PR any other updates that may help. Cheers and thanks for all the great work you've put into Gatsby! |
Great! Looking forward to your next PRs! |
Hiya @joesepi! 👋 This is definitely late, but on behalf of the entire Gatsby community, I wanted to say thank you for being here. Gatsby is built by awesome people like you. Let us say “thanks” in two ways:
If you have questions, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’. Thanks again! 💪💜 |
I'm familiar with React but new to Gatsby so I was quickly going through the tutorials. I found something confusing (the seemingly unnecessary parentheses as noted in review comments) and figured I would contribute. As a developer advocate, I write a lot of tutorials as well and couldn't resist making some other edits. I hope this small PR is helpful.