Skip to content

Commit b2b1dee

Browse files
ascorbicKyleBlankRollinskodiakhq[bot]
authored
chore: update readme for GA (#239)
* chore: update readme for GA * Apply suggestions from code review Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com> Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
1 parent 9a52e29 commit b2b1dee

File tree

1 file changed

+25
-50
lines changed

1 file changed

+25
-50
lines changed

README.md

Lines changed: 25 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
![Netlify Build plugin Gatsby – Run Gatsby seamlessly on Netlify](netlify-gatsby-plugin.png)
22

3-
# Essential Gatsby Plugin - v2 beta
3+
# Essential Gatsby Plugin - v2
44

5-
This version of the Essential Gatsby build plugin is a beta release, supporting
6-
the new features of Gatsby 4 including the SSR and DSG
7-
[render modes](https://v4.gatsbyjs.com/docs/conceptual/rendering-options/). For
8-
older versions of Gatsby, please use
9-
[version 1.x of the build plugin](https://github.com/netlify/netlify-plugin-gatsby/tree/v1),
10-
which is installed automatically for new Gatsby sites.
5+
The Essential Gatsby build plugin enables caching of builds, SSR and DSG
6+
[render modes](https://v4.gatsbyjs.com/docs/conceptual/rendering-options/) and
7+
Gatsby Functions. It is installed automatically for all new Gatsby sites.
118

129
> **Note:**
1310
>
@@ -20,58 +17,40 @@ which is installed automatically for new Gatsby sites.
2017
> - Essential Gatsby is not compatible with the Gatsby community plugin
2118
> [gatsby-plugin-netlify-cache](https://www.gatsbyjs.com/plugins/gatsby-plugin-netlify-cache/).
2219
23-
## Installation and Configuration
20+
## Installation
2421

25-
<!-- All sites deployed to Netlify with Gatsby will automatically install this plugin
26-
for a seamless experience.
22+
Gatsby sites need two plugins to support all features.
2723

28-
This means that you don't have to do anything — just build and deploy your site
29-
to Netlify as usual and we'll handle the rest.
24+
1. The Netlify build plugin, called "Essential Gatsby" or
25+
`@netlify/plugin-gatsby`. This is installed automatically for all Gatsby
26+
sites deployed to Netlify.
27+
2. The Gatsby plugin `gatsby-plugin-netlify`. This needs to be manually
28+
installed.
3029

31-
You're able to
32-
[remove the plugin](https://docs.netlify.com/configure-builds/build-plugins/#remove-a-plugin)
33-
at any time by visiting the **Plugins** tab for your site in the Netlify UI. -->
30+
### Installing the Netlify build plugin
3431

35-
There are three steps to enable support for Gatsby 4 in your Netlify site. This
36-
includes installing _two_ plugins: a Netlify build plugin called "Essential
37-
Gatsby Plugin", and a Gatsby plugin called "gatsby-plugin-netlify":
32+
New Gatsby sites on Netlify automatically install the Essential Gatsby build plugin. You can confirm this in the build logs. If you need to install it
33+
manually, you have two options:
3834

39-
- [Install version 2 beta of `@netlify/plugin-gatsby`](#install-the-netlify-build-plugin)
40-
(the Netlify build plugin)
41-
- [Install version 4 beta of `gatsby-plugin-netlify`](#install-the-gatsby-plugin)
42-
(the Gatsby plugin)
35+
- [The Netlify UI](https://docs.netlify.com/configure-builds/build-plugins/#ui-installation). Here, you can search for "Essential Gatsby" and install the plugin.
4336

44-
### Install the Netlify build plugin
37+
- [File-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#file-based-installation). You can install the plugin as `@netlify/plugin-gatsby` in your `netlify.toml` file.
38+
4539

46-
1. Create a `netlify.toml` in the root of your project. Your file should include
47-
the plugins section below:
40+
### Install the Gatsby Plugin
4841

49-
```toml
50-
[[plugins]]
51-
package = "@netlify/plugin-gatsby"
52-
```
42+
You should also install the Gatsby plugin
43+
[gatsby-plugin-netlify](https://www.gatsbyjs.org/plugins/gatsby-plugin-netlify/).
44+
This is required for SSR pages, and adds support for Gatsby redirects and asset
45+
caching rules:
5346

54-
2. From your project's base directory, add this plugin to `devDependencies` in
55-
`package.json`.
47+
1. Add the package as a dependency:
5648

5749
```shell
58-
npm install -D @netlify/plugin-gatsby@^2.0.0-beta
50+
npm install -D gatsby-plugin-netlify
5951
```
6052

61-
Read more about
62-
[file-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#file-based-installation)
63-
in our docs.
64-
65-
## Install the Gatsby Plugin
66-
67-
To use SSR pages you must install the beta version of
68-
[gatsby-plugin-netlify](https://www.gatsbyjs.org/plugins/gatsby-plugin-netlify/):
69-
70-
```shell
71-
npm install -D gatsby-plugin-netlify@next
72-
```
73-
74-
Then add the following to your `gatsby-config.js` file:
53+
2. Then add the following to your `gatsby-config.js` file:
7554

7655
```js
7756
module.exports = {
@@ -103,10 +82,6 @@ DSG pages. The best workaround is to use an image CDN such as
10382
or [imgix](https://github.com/imgix/gatsby) to host your images. This will give
10483
you faster builds and rendering too.
10584

106-
### Beta feedback
107-
108-
TODO: forums link
109-
11085
### Local development
11186

11287
When developing Gatsby Functions it is usually easier to use the built-in

0 commit comments

Comments
 (0)