Skip to content

Commit

Permalink
chore(docs): Fix typos throughout docs (#32807)
Browse files Browse the repository at this point in the history
Co-authored-by: mundry <mundry@users.noreply.github.com>
  • Loading branch information
mundry and mundry committed Aug 16, 2021
1 parent 4897465 commit 5c06cd9
Show file tree
Hide file tree
Showing 91 changed files with 121 additions and 122 deletions.
2 changes: 1 addition & 1 deletion docs/contributing/blog-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Things we’d like to avoid on the Gatsby blog:

- **Docs content.** Some content is better found in the Gatsby docs guides and tutorials, as it can be found in a section for related content and not buried under pages of other paginated blog posts.
- **Promotional content.** Please don’t submit content to the Gatsby blog solely for the purpose of promoting a product, yourself, or link-building.
- **Here’s what you can do instead:** If you have a product or project you want to share on the Gatsby blog, focus on practical information, and make sure there’s a clear relationship with Gatsby or Gatsby-adjacent topics. You could write a step by step guide to using your product with Gatsby. You could write a case study highlighting the direct impact Gatsby had on your awesome project and offer helpful tips for others to recreate your success.
- **Here’s what you can do instead:** If you have a product or project you want to share on the Gatsby blog, focus on practical information, and make sure there’s a clear relationship with Gatsby or Gatsby-adjacent topics. You could write a step-by-step guide to using your product with Gatsby. You could write a case study highlighting the direct impact Gatsby had on your awesome project and offer helpful tips for others to recreate your success.
- **Content that doesn’t seem to have a clear benefit for Gatsby users and/or the Gatsby community.** For example, if you’re writing about a use-case or integration that’s extremely niche or unique to specific conditions that are really uncommon outside of your organization, the Gatsby blog might not be the best place for your content. Likewise, if your blog post doesn’t seem to have any direct relationship with Gatsby (or an interesting indirect relationship with Gatsby), then it may be more appropriate for a personal blog or another community blog.

**Please note** that these are guidelines, not rules. If you think your blog post belongs on the Gatsby blog, we absolutely encourage you to submit it. While we reserve the right to decide what is and isn’t appropriate for the Gatsby blog, we also value and encourage your creativity and your contributions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ Because of the open-ended nature of a Conceptual Guide, it's difficult to create
Instead, here's a list of questions to consider as you're writing:

- What is the central, underlying concept for this topic? Why is that something worth learning about?
- What historical background or past decisions would be helpful for newcomers trying to understanding this concept?
- What historical background or past decisions would be helpful for newcomers trying to understand this concept?
- Are there any other solutions or approaches? What are the pros and cons of each approach?
- What other viewpoints should be considered?
2 changes: 1 addition & 1 deletion docs/contributing/docs-contributions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ description: Learn about other events happening around the globe to connect with

## Configuring site navigation

The docs include custom built components to aid with navigation. In order to customize the navigation experience, these components allow some configurations without changing any of the React code.
The docs include custom-built components to aid with navigation. In order to customize the navigation experience, these components allow some configurations without changing any of the React code.

### Adjusting breadcrumb titles

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/gatsby-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ In English, your articles should use the second person ("you") to provide a conv

For other languages, refer to each translation's guidelines (if applicable) for consistent phrasing. When appropriate, we suggest starting with the informal "you" to keep a conversational tone.

Using "you" in English is also more accurate than saying "we," because typically only one person is reading the tutorial or guide at a time and the person who wrote the tutorial is not actually going through it with them, so "we" would be inaccurate. You might notice that some technical documentation uses third person pronouns and nouns like "they" and "the user," which add more distance and feel colder than the conversational and warm "you" and "your."
Using "you" in English is also more accurate than saying "we," because typically only one person is reading the tutorial or guide at a time and the person who wrote the tutorial is not actually going through it with them, so "we" would be inaccurate. You might notice that some technical documentation uses third-person pronouns and nouns like "they" and "the user," which add more distance and feel colder than the conversational and warm "you" and "your."

When updating a doc to adhere to this part of the Gatsby Style Guide, one exception in English is when "we" refers to Gatsby's core processes. The subject is the code in this case, rather than a teacher/reader connotation, and should be rewritten or restructured to not confuse the reader about what they are responsible for doing when something is happening automatically behind the scenes.

Expand Down Expand Up @@ -248,7 +248,7 @@ Use the following as reference when creating and editing docs:
- [adding images to articles](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#images).
If the images aren’t already hosted somewhere else on the web, you’ll need to put them online yourself.
A good way to do this is to commit them to a GitHub repository of your own, then push them to GitHub.
Then you can right click the image and copy its image source. And don't forget image alt text for accessibility!
Then you can right-click the image and copy its image source. And don't forget image alt text for accessibility!
For help with crafting efficient screen reader text, refer to the [W3C's alt decision tree](https://www.w3.org/WAI/tutorials/images/decision-tree/).
- [header formatting](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#headers). Avoid using H1 header; that is reserved for the title of each document.

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/managing-pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ If a PR includes code examples, tutorials, recipes, or actionable guides, the re
For [PRs that add code](/contributing/code-contributions/) (whether a feature or fix), we look for the following:

- Correctness — whether the code does what we think it does
- Tests — when fixing a bug or adding a new feature, it can be very valuable to add tests. While we do merge some small PRs without them, more often than not, it's good to have tests asserting behavior. This can be a combination of unit tests for the specific package, snapshot tests, and end to end tests. The goal here is to ensure that something that is being fixed or added _remains_ fixed or working the way we expect it to. Good tests ensure this.
- Tests — when fixing a bug or adding a new feature, it can be very valuable to add tests. While we do merge some small PRs without them, more often than not, it's good to have tests asserting behavior. This can be a combination of unit tests for the specific package, snapshot tests, and end-to-end tests. The goal here is to ensure that something that is being fixed or added _remains_ fixed or working the way we expect it to. Good tests ensure this.
- Code Quality — focus on reasonable changes that will likely improve code maintenance, comprehension, or correctness. Stylistic changes are typically linted for by Prettier. Don't nitpick.
- Documentation in the package's README if you're adding something

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/translation/new-translations.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ The Gatsby team will choose to approve a translation request based on the follow

## After approval

Once the translation request is approved, a member of the gatsby team will run the an automated script to create your repository and set everything up.
Once the translation request is approved, a member of the gatsby team will run an automated script to create your repository and set everything up.

At this point, you and your co-maintainers should read the rest of the [maintainer guide](/contributing/translation/maintainers/) for more information on how to manage your translation repository. You can also check out the [translation contributor guide](/contributing/translation/translators/) for information on contributing translations to your own repo, and start working on your translation [style guide](/contributing/translation/style-guide/).
6 changes: 3 additions & 3 deletions docs/contributing/triaging-github-issues/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ We do first touch maintenance so that:
Gatsby is unique among most open source projects because:

- Gatsby integrates with many third party tools (WordPress, Drupal, Contentful etc) via source plugins and hence the typical scope of issues is widened significantly
- Gatsby aims to be really beginner friendly (we want to be the new way someone gets started with web development) and this means that we need to accommodate a wide range of skill levels
- Gatsby aims to be really beginner-friendly (we want to be the new way someone gets started with web development) and this means that we need to accommodate a wide range of skill levels

## How do we do first touch maintenance?

Expand All @@ -50,7 +50,7 @@ Gatsby is unique among most open source projects because:
- **Be empathetic.** The author of an issue might be asking something that’s obvious to us but that doesn’t mean it’s obvious to them - it's important to consider the issue from the author’s viewpoint. People often remember how we make them feel, not what we told them.
- **Add context.** When answering an issue, it can be useful to link to existing documentation, issues, PRs, or provide related context. This means the issue can serve as a reference to future readers.
- **Encourage community contributions.** Getting people involved makes a huge impact. We often spend the time to write up a task as a `good first issue` instead of fixing the issue ourselves. This can provide a low friction way for someone to get more involved in open source!
- **Give issue authors time to close their own issues.** Sometimes, it might feel like an issue is resolved but the author could have follow up questions. It's usually best to give them a day or two to close the issue themselves.
- **Give issue authors time to close their own issues.** Sometimes, it might feel like an issue is resolved but the author could have follow-up questions. It's usually best to give them a day or two to close the issue themselves.

### Labeling

Expand Down Expand Up @@ -86,7 +86,7 @@ If the reproduction is successful, label the issue with `status: confirmed` and

#### Feature Request

Feature Requests are issues that request support for additional functionality not currently covered in the existing codebase. The first step in triaging a feature request is to determine if it's a reasonable request; this is a challenge and is usually the responsibility of a Gatsby team member to make. If it's clear that this isn't a feature it makes sense for Gatsby to implement, provide a comment explaining the decision making and close the issue. Review the [saved replies](#saved-replies) to see if there is an appropriate response already available. If you have any doubt about whether a feature request should be incorporated into Gatsby, label it with `status: needs core review` and leave the issue open.
Feature Requests are issues that request support for additional functionality not currently covered in the existing codebase. The first step in triaging a feature request is to determine if it's a reasonable request; this is a challenge and is usually the responsibility of a Gatsby team member to make. If it's clear that this isn't a feature it makes sense for Gatsby to implement, provide a comment explaining the decision-making and close the issue. Review the [saved replies](#saved-replies) to see if there is an appropriate response already available. If you have any doubt about whether a feature request should be incorporated into Gatsby, label it with `status: needs core review` and leave the issue open.

If it's determined to be a worthwhile feature, the next decision point is whether the feature should be added to core or upstream. Upstream issues are those that are outside of Gatsby's control and caused by dependencies. Upstream features should be labeled with `type: upstream` and include comments about the scope.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/adding-search-with-algolia.md
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,7 @@ You can also play around with it at [https://janosh.io/blog](https://janosh.io/b

## Deploying to Netlify

If you try to deploy the project to Netlify, the deployment will fail with the error `AlgoliaSearchError: Please provide an application ID`. This is because Netlify does does not have access to the Algolia configuration. Remember, it is kept in the `.env` file which is not checked in.
If you try to deploy the project to Netlify, the deployment will fail with the error `AlgoliaSearchError: Please provide an application ID`. This is because Netlify does not have access to the Algolia configuration. Remember, it is kept in the `.env` file which is not checked in.

You therefore need to declare the same environment variables you put in `.env` in Netlify. Go to your Netlify site dashboard under **Settings > Build & deploy > Environment > Environment variables** and enter the keys `GATSBY_ALGOLIA_APP_ID`, `GATSBY_ALGOLIA_SEARCH_KEY` and `ALGOLIA_ADMIN_KEY` with the same values as you used in the `.env` file. After a redeploy, the search should now work!

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/building-an-ecommerce-site-with-shopify.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ examples:
href: "https://github.com/gatsbyjs/gatsby-starter-shopify"
---

In this tutorial, you will setup a new Gatsby website that fetches product data from [Shopify](https://www.shopify.com). The site displays a list of all products on a product listing page, and a page for every product in the store.
In this tutorial, you will set up a new Gatsby website that fetches product data from [Shopify](https://www.shopify.com). The site displays a list of all products on a product listing page, and a page for every product in the store.

If you're already comfortable with Gatsby and Shopify, you might want to check out our [Shopify Starter Demo](https://shopify-demo.gatsbyjs.com/), a proof of concept showcasing 10,000 products and 30,000 SKUs (variants).
You can clone the starter, host it on Gatsby and connect it to your own Shopify data to develop your own proof of concept in as little as an hour.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cli-feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Gatsby users will be prompted every 3 months (at the most) to give feedback on G

## How to opt-out

Users may always opt-out from the feedback prompts with `gatsby feedback --disable` or by setting the [environment variable](/docs/how-to/local-development/environment-variables/) `GATSBY_TELEMETRY_DISABLED` to `1`.
Users may always opt out from the feedback prompts with `gatsby feedback --disable` or by setting the [environment variable](/docs/how-to/local-development/environment-variables/) `GATSBY_TELEMETRY_DISABLED` to `1`.
2 changes: 1 addition & 1 deletion docs/docs/conceptual/gatsby-core-philosophy.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Traditional CMS development [presents many challenges](https://www.gatsbyjs.com/

Modern web development [bundles advances](https://www.gatsbyjs.com/blog/2018-10-11-rise-of-modern-web-development/#modern-frameworks-offer-stability-and-faster-development) in **performance** (bundle splitting, asset prefetching, offline support, image optimization, or server side rendering), **developer experience** (componentization via React, transpilation via Babel, webpack, hot reloading), **accessibility**, and **security** together.

Gatsby's goal is to bundle these advances in an easy to use package. We're open to any and all advances being made in the modern JavaScript world and would love to incorporate them into Gatsby!
Gatsby's goal is to bundle these advances in an easy-to-use package. We're open to any and all advances being made in the modern JavaScript world and would love to incorporate them into Gatsby!

For more on this, look at [the features Gatsby bundles together](/features).

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/conceptual/gatsby-for-ecommerce.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The website functions because these front-end capabilities integrate with a wide

### Choosing a main e-commerce platform

Most businesses choose a central e-commerce platform as their source of truth for these functionality. Some businesses choose to run entirely on these platforms, which can be quicker to get started with but lock you in to their choices for website creation (e.g. Liquid Templates for Shopify).
Most businesses choose a central e-commerce platform as their source of truth for these functionalities. Some businesses choose to run entirely on these platforms, which can be quicker to get started with but lock you in to their choices for website creation (e.g. Liquid Templates for Shopify).

If you're using or considering Gatsby, your organization is likely optimizing for specific properties of your website (such as performance, development environment, design, user experience, and security) and are therefore considering a "JAMstack", "decoupled" or "content mesh" architecture.

Expand All @@ -37,7 +37,7 @@ E-commerce tends to have a number of specific requirements. When building a Gats
- **Persisting a cart across site pages and between sessions** (ie, if the user closes their browser and reopens it tomorrow, the items should still be there). This can be handled either through local-storage or through the shopify-buy JS library.
- **Product search** can be done client-side if the SKU count is small enough to store all products in a global state. Alternatively, it can be handled through the e-commerce provider’s search features, or if those aren’t robust enough, a third-party search provider like Algolia.
- **Surfacing price adjustments** like tax, shipping, discounts/promos to the user while browsing the site. Different e-commerce solutions provide different levels of API access to these objects.
- **Handling checkout.** In order to comply with PCI regulations around storing credit card information, e-commerce providers typically exert strong control over the "buy" or "checkout" experience. Shopify requires all checkout flows using their platform to use their hosted checkout pages, though it's common to wrap them in a subdomain of the main site (e.g. the Gatsby/Shopify site [strivectin.com](strivectin.com] wraps a `myshopify.com` URL under a `shop.strivectin.com` URL for checkout).
- **Handling checkout.** In order to comply with PCI regulations around storing credit card information, e-commerce providers typically exert strong control over the "buy" or "checkout" experience. Shopify requires all checkout flows using their platform to use their hosted checkout pages, though it's common to wrap them in a subdomain of the main site (e.g. the Gatsby/Shopify site [strivectin.com](strivectin.com) wraps a `myshopify.com` URL under a `shop.strivectin.com` URL for checkout).
- **Handling account pages.** Again, many sites choose to wrap their e-commerce provider’s account pages under their own domain.

## Additional resources:
Expand Down
Loading

0 comments on commit 5c06cd9

Please sign in to comment.