Skip to content

Commit

Permalink
updates per PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
aghreed committed Mar 16, 2022
1 parent 74a8872 commit 60e974a
Show file tree
Hide file tree
Showing 30 changed files with 78 additions and 74 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7356,7 +7356,7 @@
{
"commit": {
"authoredDate": "2019-06-03T02:42:32Z",
"message": "Made the doc easier to read\n\n- Moved a lot of sentences into active voice\r\n- Removed unnecessary words and sentences\r\n- Fixed some grammatical errors\r\n- Removed potentially confusing emojis as a literary device\r\n- Split up some long sentences into shorter ones\r\n- Added a link to https://www.gatsbyjs.com/blog/2018-06-08-life-after-layouts/ in the layouts section to help people move from Gatsby's layout behavior in v1\r\n- Capitalized instances of \"Babel\" that were lowercase"
"message": "Made the doc easier to read\n\n- Moved a lot of sentences into active voice\r\n- Removed unnecessary words and sentences\r\n- Fixed some grammatical errors\r\n- Removed potentially confusing emojis as a literary device\r\n- Split up some long sentences into shorter ones\r\n- Added a link to https://www.gatsbyjs.org/blog/2018-06-08-life-after-layouts/ in the layouts section to help people move from Gatsby's layout behavior in v1\r\n- Capitalized instances of \"Babel\" that were lowercase"
}
},
{
Expand Down
2 changes: 1 addition & 1 deletion deprecated-packages/gatsby-image/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ function groupByMedia(imageVariants) {

if (without.length > 1 && process.env.NODE_ENV !== `production`) {
console.warn(
`We've found ${without.length} sources without a media property. They might be ignored by the browser, see: https://www.gatsbyjs.com/packages/gatsby-image/#art-directing-multiple-images`
`We've found ${without.length} sources without a media property. They might be ignored by the browser, see: https://www.gatsbyjs.com/plugins/gatsby-image/#art-directing-multiple-images`
)
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Setup gatsby-plugin-layout

This plugin sets up [gatsby-plugin-layout](https://www.gatsbyjs.com/packages/gatsby-plugin-layout/?=gatsby%20layout), which enables adding components that live above the page components and persist across page changes.
This plugin sets up [gatsby-plugin-layout](https://www.gatsbyjs.com/plugins/gatsby-plugin-layout/?=gatsby%20layout), which enables adding components that live above the page components and persist across page changes.

This can be helpful for:

Expand All @@ -15,24 +15,24 @@ This recipe:

Installs necessary NPM packages

<NPMPackage name="gatsby-plugin-layout"/>
<NPMPackage name="gatsby-plugin-layout" />

---

Installs the Layout plugin in gatsby-config.js

<GatsbyPlugin name="gatsby-plugin-layout"/>
<GatsbyPlugin name="gatsby-plugin-layout" />

---

Writes out a sample layout component to get started with.

<File
path="src/layouts/index.js"
content="https://gist.githubusercontent.com/JeremyTheModernist/be673e8641c61e6a427124acad1e05da/raw/80afecf73eb494dbfa2318ad7a27825edf9ef16c/index.js"
path="src/layouts/index.js"
content="https://gist.githubusercontent.com/JeremyTheModernist/be673e8641c61e6a427124acad1e05da/raw/80afecf73eb494dbfa2318ad7a27825edf9ef16c/index.js"
/>

---

Read more about the documentation for Gatsby Layout Component here:
https://www.gatsbyjs.com/packages/gatsby-plugin-layout/
https://www.gatsbyjs.com/plugins/gatsby-plugin-layout/
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ React Helmet is a reusable React component that manages all of your changes to t

Helmet takes plain HTML tags and outputs plain HTML tags.

[gatsby-plugin-helmet](https://www.gatsbyjs.com/packages/gatsby-plugin-react-helmet/?=react%20helmet) makes it easy to use React Helmet inside Gatsby projects as it automatically adds title and meta tags to the HTML during SSR.
[gatsby-plugin-helmet](https://www.gatsbyjs.com/plugins/gatsby-plugin-react-helmet/?=react%20helmet) makes it easy to use React Helmet inside Gatsby projects as it automatically adds title and meta tags to the HTML during SSR.

This recipe:

Expand Down Expand Up @@ -33,7 +33,7 @@ Writes out an `<SEO>` component which helps ensure pages have the necessary titl
---

Read more about Gatsby React Helmet here:
https://www.gatsbyjs.com/packages/gatsby-plugin-react-helmet
https://www.gatsbyjs.com/plugins/gatsby-plugin-react-helmet

You can also read about the "SEO" component here:
https://www.gatsbyjs.com/docs/add-seo-component/
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gatsby Theme Blog Core Starter Recipe

[Gatsby theme blog core](https://www.gatsbyjs.com/packages/gatsby-theme-blog-core/) is a great theme for adding blog functionality to your site. It's designed to handle sourcing your blog data for you so you can style it however you like.
[Gatsby theme blog core](https://www.gatsbyjs.com/plugins/gatsby-theme-blog-core/) is a great theme for adding blog functionality to your site. It's designed to handle sourcing your blog data for you so you can style it however you like.

This recipe:

Expand All @@ -14,14 +14,20 @@ Installs necessary NPM packages.

Installs the `gatsby-theme-blog-core` plugin in `gatsby-config.js` and makes use of the `basePath` configuration so the blog listing appears at `/blog`.

<GatsbyPlugin name="gatsby-theme-blog-core" options={{basePath: `/blog`}}/>
<GatsbyPlugin name="gatsby-theme-blog-core" options={{ basePath: `/blog` }} />

---

Adds some posts.
Adds some posts.

<File path="content/posts/hello-world.md" content="https://gist.githubusercontent.com/laurieontech/c4729983c08e759cd10bf6a708ee2c0f/raw/ed8e1e5f6542928ac74f5ac3855db246e6980754/hello-world-post.md"/>
<File path="content/posts/second-post.md" content="https://gist.githubusercontent.com/laurieontech/6957cd524dbbf0503682fad759001893/raw/eba38eb3048c190388f5348944d5114930fe4591/second-post.md"/>
<File
path="content/posts/hello-world.md"
content="https://gist.githubusercontent.com/laurieontech/c4729983c08e759cd10bf6a708ee2c0f/raw/ed8e1e5f6542928ac74f5ac3855db246e6980754/hello-world-post.md"
/>
<File
path="content/posts/second-post.md"
content="https://gist.githubusercontent.com/laurieontech/6957cd524dbbf0503682fad759001893/raw/eba38eb3048c190388f5348944d5114930fe4591/second-post.md"
/>

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Setup Gatsby Theme Blog

[Gatsby theme blog](https://www.gatsbyjs.com/packages/gatsby-theme-blog/) is a great theme for adding blog functionality to your site.
[Gatsby theme blog](https://www.gatsbyjs.com/plugins/gatsby-theme-blog/) is a great theme for adding blog functionality to your site.

This recipe:

Expand All @@ -15,13 +15,16 @@ Installs necessary NPM packages.

Installs the `gatsby-theme-blog` plugin in `gatsby-config.js` and makes use of the `basePath` configuration so the blog listing appears at `/blog`.

<GatsbyPlugin name="gatsby-theme-blog" options={{basePath: `/blog`}}/>
<GatsbyPlugin name="gatsby-theme-blog" options={{ basePath: `/blog` }} />

---

Adds a post.

<File path="content/posts/first-blog.md" content="https://gist.githubusercontent.com/laurieontech/dbd124e77f1fe96f18493f2e9c4ea62e/raw/03342f883c2cd1366dee47d257aa0dc598d1274c/hello-world-image.md"/>
<File
path="content/posts/first-blog.md"
content="https://gist.githubusercontent.com/laurieontech/dbd124e77f1fe96f18493f2e9c4ea62e/raw/03342f883c2cd1366dee47d257aa0dc598d1274c/hello-world-image.md"
/>

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gatsby Theme Notes Starter Recipe

[Gatsby theme notes](https://www.gatsbyjs.com/packages/gatsby-theme-notes) is a great theme for adding learning notes to your site.
[Gatsby theme notes](https://www.gatsbyjs.com/plugins/gatsby-theme-notes) is a great theme for adding learning notes to your site.

This recipe:

Expand All @@ -14,13 +14,16 @@ Installs necessary NPM package.

Installs the `gatsby-theme-notes` plugin in `gatsby-config.js`.

<GatsbyPlugin name="gatsby-theme-notes" options={{basePath: `/notes`}}/>
<GatsbyPlugin name="gatsby-theme-notes" options={{ basePath: `/notes` }} />

---

Adds a note.

<File path="content/notes/learning.md" content="https://gist.githubusercontent.com/laurieontech/cf90cbee0bc69b106f2fa5109d055372/raw/58a012c02b6e9fffe3e93bc2a57bd5f01ef281b8/learning.md"/>
<File
path="content/notes/learning.md"
content="https://gist.githubusercontent.com/laurieontech/cf90cbee0bc69b106f2fa5109d055372/raw/58a012c02b6e9fffe3e93bc2a57bd5f01ef281b8/learning.md"
/>

---

Expand All @@ -29,4 +32,3 @@ After installing this recipe, you can use your site for notetaking.
When you've finished installing the recipe, run `gatsby develop` and check out `http://localhost:8000/notes` for the list of notes.

---

4 changes: 2 additions & 2 deletions deprecated-packages/gatsby-recipes/recipes/pwa.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@ After running this recipe, your site will be a PWA.
Refer to the documentation for the manifest & offline plugins if there are any
other edits you'd like to make.

- https://www.gatsbyjs.com/packages/gatsby-plugin-manifest
- https://www.gatsbyjs.com/packages/gatsby-plugin-offline
- https://www.gatsbyjs.com/plugins/gatsby-plugin-manifest
- https://www.gatsbyjs.com/plugins/gatsby-plugin-offline
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Configure your Gatsby site with this file.
*
* See: https://www.gatsbyjs.com/docs/gatsby-config/
* See: https://www.gatsbyjs.org/docs/gatsby-config/
*/
module.exports = {
/* Your site config here */
Expand Down
2 changes: 1 addition & 1 deletion examples/using-gatsby-source-graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Simple gatsby site that displays blog with data inside GraphCMS.

Built using [gatsby-source-graphql](https://www.gatsbyjs.com/packages/gatsby-source-graphql/).
Built using [gatsby-source-graphql](https://www.gatsbyjs.com/plugins/gatsby-source-graphql/).

<!-- [See it here](https://using-gatsby-source-graphql.netlify.app/) -->

Expand Down
10 changes: 5 additions & 5 deletions packages/gatsby-design-tokens/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,8 +343,8 @@ Here's all changes listed by "token group":
- add `colors.whiteFade[5]`
- BREAKING CHANGE: fix `colors.blackFade[80]`, `colors.whiteFade[80]`
- both were set to an opacity of `.85`, adjusted to `.8`
- TODO: Adjust a couple of values for gatsbyjs.com; no clue about where we currently might use this in `gatsby-interface` and related (.com/Cloud dashboard).
- feat: port `colors.code` from the gatsbyjs.com `theme-ui` theme to the `colors` tokens
- TODO: Adjust a couple of values for gatsbyjs.org; no clue about where we currently might use this in `gatsby-interface` and related (.com/Cloud dashboard).
- feat: port `colors.code` from the gatsbyjs.org `theme-ui` theme to the `colors` tokens
- 💚 This improves compliance with WCAG 2.0 AA color contrasts.
- feat: add `colors.code.copyButton`
- feat: add `colors.code.lineHighlightBackground`
Expand Down Expand Up @@ -384,7 +384,7 @@ Here's all changes listed by "token group":
##### `sizes`

- BREAKING CHANGE: removed
- As discussed in https://github.com/gatsby-inc/gatsby-interface/issues/181, this moves the current gatsbyjs.com-centric `sizes` tokens to `theme-gatsbyjs-org` for clarity, until a clear pattern emerges.
- As discussed in https://github.com/gatsby-inc/gatsby-interface/issues/181, this moves the current gatsbyjs.org-centric `sizes` tokens to `theme-gatsbyjs-org` for clarity, until a clear pattern emerges.

##### `space`

Expand All @@ -402,11 +402,11 @@ Here's all changes listed by "token group":
##### `zIndices`

- BREAKING CHANGE: removed
- As discussed in https://github.com/gatsby-inc/gatsby-interface/issues/181, this moves the current gatsbyjs.com-centric `zIndices` tokens to `theme-gatsbyjs-org`for clarity, until a clear pattern emerges.
- As discussed in https://github.com/gatsby-inc/gatsby-interface/issues/181, this moves the current gatsbyjs.org-centric `zIndices` tokens to `theme-gatsbyjs-org`for clarity, until a clear pattern emerges.

#### Themes

- feat: add base `theme-ui` Gatsby theme, gatsbyjs.com `theme-ui` theme
- feat: add base `theme-ui` Gatsby theme, gatsbyjs.org `theme-ui` theme
- Both themes don't tree-shake yet, so no `agadoo` yet in the corresponding `gatsby-design-tokens/package.json` scripts.
- Both export the `theme-ui` theme as `theme` and also provide individual token group exports (because we require them in `www` for usage outside of the `theme-ui` context).
- Example usage:
Expand Down
2 changes: 0 additions & 2 deletions packages/gatsby-design-tokens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,6 @@ import {
- `rem` values are based on a `font-size` of `16px` for the root element.
- All tokens work in the context of [Theme UI's Theme Scales](https://theme-ui.com/theme-spec/#theme-scales), with the exception of `breakpoints`: Use `breakpointsArray` for `theme-ui` and its [responsive styles](https://theme-ui.com/getting-started/#responsive-styles) feature.

Find a work-in-progress list of design tokens in the design tokens documentation at [gatsbyjs.com/guidelines/design-tokens](https://www.gatsbyjs.com/guidelines/design-tokens/).

## `theme-ui` themes 🎨

### `theme`
Expand Down
4 changes: 2 additions & 2 deletions packages/gatsby-plugin-google-gtag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Easily add Google Global Site Tag to your Gatsby site.

> The global site tag (gtag.js) is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, Campaign Manager, Display & Video 360, and Search Ads 360.
Global site tag (gtag.js) is meant to combine multiple Google tagging systems and can replace older ones such as [analytics.js](https://developers.google.com/analytics/devguides/collection/analyticsjs/) ([gatsby-plugin-google-analytics](https://www.gatsbyjs.com/packages/gatsby-plugin-google-analytics/)).
Global site tag (gtag.js) is meant to combine multiple Google tagging systems and can replace older ones such as [analytics.js](https://developers.google.com/analytics/devguides/collection/analyticsjs/) ([gatsby-plugin-google-analytics](https://www.gatsbyjs.com/plugins/gatsby-plugin-google-analytics/)).

For more general information on gtag you can read Google's official documentation on the subject: https://developers.google.com/gtagjs/.

Expand Down Expand Up @@ -89,7 +89,7 @@ import { OutboundLink } from "gatsby-plugin-google-gtag"

export default () => (
<div>
<OutboundLink href="https://www.gatsbyjs.com/packages/gatsby-plugin-google-gtag/">
<OutboundLink href="https://www.gatsbyjs.com/plugins/gatsby-plugin-google-gtag/">
Visit the Google Global Site Tag plugin page!
</OutboundLink>
</div>
Expand Down
4 changes: 2 additions & 2 deletions packages/gatsby-plugin-mdx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,12 +317,12 @@ Here's a YouTube embed
This config option is used for compatibility with a set of plugins many people
[use with remark](https://www.gatsbyjs.com/plugins/?=gatsby-remark-) that require
the gatsby environment to function properly. In some cases, like
[gatsby-remark-prismjs](https://www.gatsbyjs.com/packages/gatsby-remark-prismjs/?=gatsby-remark-),
[gatsby-remark-prismjs](https://www.gatsbyjs.com/plugins/gatsby-remark-prismjs/?=gatsby-remark-),
it makes more sense to use a library like
[prism-react-renderer](https://github.com/FormidableLabs/prism-react-renderer)
to render codeblocks using a [React
component](/api-reference/mdx-provider). In other cases, like
[gatsby-remark-images](https://www.gatsbyjs.com/packages/gatsby-remark-images/?=gatsby-remark-),
[gatsby-remark-images](https://www.gatsbyjs.com/plugins/gatsby-remark-images/?=gatsby-remark-),
the interaction with the Gatsby APIs is well deserved because the
images can be optimized by Gatsby and you should continue using it.

Expand Down
Loading

0 comments on commit 60e974a

Please sign in to comment.