jlengstorf / netlify-plugin-gatsby-cache

185 stars 21 forks source link

Update installation instructions #5

Closed verythorough closed 4 years ago

verythorough commented 4 years ago

For greater simplicity and consistency with Netlify users’ existing configuration files, we’re deprecating experimental support for Netlify config files in YAML or JSON (https://github.com/netlify/build/issues/975).

To get new plugin users started on the right foot, I’m proposing updates for all plugin READMEs to use netlify.toml format in the installation instructions.

This docs-only change should require no updates to your plugin code.

I've also made the following updates to reflect the current plugins API:

I also changed the link to point to a new docs page that will be published tomorrow. I don't know if your utm codes are useful there, but I carried them over into the new link.

jasonLaster commented 4 years ago

very cool. it seems magical that we do not need to do an npm install. Is the install done by netlify if it does not find the plugin?

verythorough commented 4 years ago

@jasonLaster Yes. Eventually, we plan to add the ability to add plugins to a site via the UI, so automatic install that don't require repo code changes to package.json are one part of the effort in that direction.