-
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
Removes words like 'simple' & 'easy' from docs/www #3523
Changes from 1 commit
0188ea7
b2af0c3
85cedb2
bae5428
839e3b1
a5ea074
ac5b81d
1ea8726
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -116,7 +116,7 @@ enables rich integrations with CMSs like Contentful, Wordpress, and Drupal along | |
with other remote and local sources. | ||
|
||
In Gatsby v0, (like pretty much every static site generator) data was processed | ||
then _pushed_ into templates to be rendered into HTML. This is a simple pattern | ||
then _pushed_ into templates to be rendered into HTML. This is a straight-forward pattern | ||
and works great for many use cases. But when you start working on more complex | ||
sites, you really start to miss the flexibility of a database-driven site. With | ||
a database, all your data is available to query against in any fashion you'd | ||
|
@@ -144,7 +144,7 @@ This pattern of _colocating_ your queries next to your views is copied from the | |
Colocation makes it easy to fully understand your views as everything necessary | ||
for that view is fully defined there. | ||
|
||
A simple example of how this works in practice. | ||
An example of how this works in practice. | ||
|
||
Say we had a markdown file that looked like: | ||
|
||
|
@@ -161,7 +161,7 @@ In our site, we would write a React component which acts as a template for all | |
the blog posts. Included with the component is an exported `pageQuery`. | ||
|
||
```jsx | ||
// A simple React component for rendering a blog page. | ||
// A basic React component for rendering a blog page. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Love the distinction between “simple” and “basic” 🙂 |
||
import React from "react"; | ||
|
||
class BlogPostTemplate extends React.Component { | ||
|
@@ -297,7 +297,7 @@ uses [Redux](http://redux.js.org/) to communicate with their Django API. | |
|
||
The marketing portion of the site loads quickly with minimal JavaScript. When a | ||
potential customer goes to sign-up for the app, there's no _awkward jump from | ||
the marketing website to the web app_—just a simple page change which seamlessly | ||
the marketing website to the web app_—just a page change which seamlessly | ||
loads in the needed JavaScript. The _team is sharing components and styles | ||
across the site_ without stepping on each others shoes as they rapidly iterate | ||
on features. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
title: "Add 404 Page" | ||
--- | ||
|
||
Adding a 404 page is easy. First, create a page whose path matches the regex | ||
Adding a 404 page is simple. First, create a page whose path matches the regex | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need to say it is easy or simple at all? Could be: “To add a 404 page, first create a page whose...” More direct and less words IMO There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
`/404*`. Most often you'll want to create a React component page at | ||
`src/pages/404.js`. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -195,7 +195,7 @@ to read. | |
# Formatting example code | ||
|
||
Readers will likely use Guide articles as a quick reference to look up syntax. | ||
Articles should have simple real-world examples that show common-use cases of | ||
Articles should have a bare-bones, real-world example that show common-use cases of | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is bare-bones understood across cultures? “Basic” might be safer here. |
||
that syntax. | ||
|
||
Here are specific formatting guidelines for any code: | ||
|
@@ -258,7 +258,7 @@ it in a clear, accurate, and objective manner. You'll likely go through several | |
rounds of proofreading and editing before you're happy with your writing. | ||
|
||
Use the [Hemingway App](http://www.hemingwayapp.com/). There’s nothing magical | ||
about this simple tool, but it will automatically detect widely agreed-upon | ||
about this tool, but it will automatically detect widely agreed-upon | ||
style issues: | ||
|
||
* passive voice | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -73,7 +73,7 @@ In Gatsby, GraphQL enables components to declare and receive the data they need. | |
## Our first GraphQL query | ||
|
||
Let's create another new site for this part of the tutorial like in the previous | ||
parts. We're going to build a simple Markdown blog called "Pandas Eating Lots". | ||
parts. We're going to build a Markdown blog called "Pandas Eating Lots". | ||
It's dedicated to showing off the best pictures & videos of Pandas eating lots | ||
of food. Along the way we'll be dipping our toes into GraphQL and Gatsby's | ||
Markdown support. | ||
|
@@ -197,7 +197,7 @@ the following: | |
|
||
![start](start.png) | ||
|
||
We have another simple site with a layout and two pages. | ||
We have another small site with a layout and two pages. | ||
|
||
Now let's start querying 😋 | ||
|
||
|
@@ -211,7 +211,7 @@ error-prone, especially as sites get larger and more complex. It's much better t | |
store the title in one place and then _pull_ that title into components whenever | ||
we need it. | ||
|
||
To solve this, Gatsby supports a simple pattern for adding site "metadata"—like | ||
To solve this, Gatsby supports the following pattern for adding site "metadata"—like | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similar to above, could probably say “to solve this we can add site metadata—like the title— to the Gatsby config file.” And then go on with the example. |
||
the title. | ||
|
||
We add this data to the `gatsby-config.js` file. Let's add our site title to | ||
|
@@ -1078,7 +1078,7 @@ export const query = graphql` | |
` | ||
``` | ||
|
||
And there we go! A working (albeit quite simple still) blog! | ||
And there we go! A working, albeit small, blog! | ||
|
||
Try playing more with the site. Try adding some more Markdown files. Explore | ||
querying other data from the `MarkdownRemark` nodes and adding them to the | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -202,11 +202,11 @@ pages! | |
|
||
## Interactive page | ||
|
||
One nice thing about using Gatsby for building websites vs other tools is it's | ||
so easy to add interactivity to your pages. React.js was designed for | ||
One nice thing about using Gatsby for building websites vs. other tools is itʼs | ||
so easier to add interactivity to your pages. React.js was designed for | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you can remove “so” |
||
Facebook.com and is used on many other world-class web applications. | ||
|
||
Let's see how easy it is to add interactive elements to our pages. | ||
Let's see how much easier it is to add interactive elements to our pages. | ||
|
||
We'll start by creating a new link to a page at `/counter`/ from our original | ||
`index.js` page component `<Link to="/counter/">Counter</Link>`. | ||
|
@@ -339,8 +339,8 @@ changes the count. | |
|
||
## Deploying Gatsby.js websites on the web | ||
|
||
Gatsby.js is a _static site generator_ which makes deploying Gatsby sites to the | ||
web really easy. There are no servers to setup or complicated databases to | ||
Gatsby.js is a _static site generator_, which makes deploying Gatsby sites to the | ||
web really easier. There are no servers to setup or complicated databases to | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you need to remove “really” as well. |
||
deploy. Instead, the Gatsby `build` command produces a directory of static HTML | ||
and JavaScript files which you can deploy to a static site hosting service. | ||
|
||
|
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.
Missing contraction in “you’re”.
I find things can read better with less “you” and “we”s. For example:
Check the type of node. If it’s a type you’re interested in, resolve with some fields.”