Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Plugins with required `inputs` cannot be installed via the Netlify UI. Wherever
Every plugin in the Netlify plugins directory includes a link to the plugin README. This file should include:

- A description of what the plugin does and why that might be useful.
- UI-based installation instructions.
- UI-based installation instructions.
> **Note:** You can include UI-based installation instructions in a separate, follow-up pull request. The PR will be merged when your plugin is approved for inclusion in the plugins directory.
- Include a direct installation link using the format `https://app.netlify.com/plugins/{plugin-package-name}/install`.
- Point to the [plugins directory](https://app.netlify.com/plugins) in the Netlify UI.
- Include a direct installation link using the format `https://app.netlify.com/plugins/{plugin-package-name}/install`.
- Point to the [plugins directory](https://app.netlify.com/plugins) in the Netlify UI.
- File-based installation instructions. Visit our [Next.js Build Plugin README](https://github.com/netlify/netlify-plugin-nextjs/blob/main/README.md) for an example.
- Include sample code for declaring the plugin in the `netlify.toml` configuration file.
- Include a step instructing developers to use npm, yarn, or another Node.js package manager to add the plugin to `devDependencies` in the base directory's `package.json`.
- Include sample code for declaring the plugin in the `netlify.toml` configuration file.
- Include a step instructing developers to use npm, yarn, or another Node.js package manager to add the plugin to `devDependencies` in the base directory's `package.json`.
- Any required environment variables.
- Details regarding any optional environment variables or `inputs`.
- Ideally, a link to a demo site with [public deploy logs](https://docs.netlify.com/configure-builds/get-started/#basic-build-settings) and a [Deploy to Netlify button](https://docs.netlify.com/site-deploys/create-deploys/#deploy-to-netlify-button), so users can find out how the plugin works before installing.
Expand Down