Skip to content
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

Update installation instructions #13

Merged
merged 1 commit into from
Apr 4, 2020
Merged

Update installation instructions #13

merged 1 commit into from
Apr 4, 2020

Conversation

verythorough
Copy link
Contributor

For greater simplicity and consistency with Netlify users’ existing configuration files, we’re deprecating experimental support for Netlify config files in YAML or JSON (netlify/build#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:

  • Replaced type with package, and config with inputs.
  • Removed the npm install step. This is no longer necessary.

@verythorough
Copy link
Contributor Author

@Munter 👋 Checking in on the status of this PR.

We're now displaying plugins in the Netlify UI, using the list at https://github.com/netlify/plugins/blob/master/plugins.json. In order to ensure that all plugins in the UI are functional and match the documented configuration methods, I'll be making a PR tomorrow to remove this plugin from the list.

We'll be happy to add it back when this PR is merged and you can confirm that the plugin still works in the Netlify Build Plugins Beta!

@Munter
Copy link
Owner

Munter commented Apr 4, 2020

Thank you for the updates

@Munter Munter merged commit 3adaa06 into Munter:master Apr 4, 2020
@verythorough
Copy link
Contributor Author

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants