diff --git a/website/content/docs/plugins/creation/index.mdx b/website/content/docs/plugins/creation/index.mdx index c30e937699b..5bb9d6a6e02 100644 --- a/website/content/docs/plugins/creation/index.mdx +++ b/website/content/docs/plugins/creation/index.mdx @@ -214,22 +214,22 @@ Here's what you need to create releases using GitHub Actions: to install a plugin using `packer init`, see the [init docs](/packer/docs/commands/init). -## Plugin Integration Registration +## Registering Plugins ~> Note: Registering a remote as an integration requires the use of [Packer's plugin docs configuration](https://github.com/hashicorp/packer-plugin-scaffolding/tree/main/docs). -`packer init` allows users to require and install remote Packer plugins published to GitHub, those not bundled with Packer core, automatically. +`packer init` allows users to require and install remote Packer plugins published to GitHub. To help with the discovery of remote Packer plugins, plugins maintainers can choose to register their plugin as a [Packer Integration](/packer/integrations). The registration process requires changes to your plugin repository for configuring the Packer integration pipeline and plugin documentation for rendering on the [Packer Integrations](/packer/integrations) portal. -Once in place an integration request can be made on Packer GitHub repository. By opening an integration request you are asking a member of the to Packer +Once in place, an integration request can be made on Packer GitHub repository. By opening an integration request, you are asking a member of the to Packer team to review your plugin integration configuration, plugin documentation, and, finally, to open an internal pull-request to finalize the integration setup. Once completed your the plugin integration will be listed as a [Packer Integration](/packer/integrations), with details on how to install and usage your the plugin. -Plugin integration, once deployed, can be updated manually, or automatically upon a new release, by the plugin authors. Changes to the defined documentation structure +Plugin integrations, once deployed, can be updated manually, or automatically upon a new release, by the plugin authors. Changes to the defined documentation structure or parent repository should be communicated to the Packer team to ensure a working integration pipeline. The following steps are required for registering your plugin as an integration @@ -243,7 +243,6 @@ within a plugins existing documentation will need to migrate to a top-level READ 1. Update your top-level integration README to include a description, plugin installation steps, available components section, and, any, additional sections needed to inform users on how to work with your integration. Refer to [Packer scaffolding plugin](https://github.com/hashicorp/packer-plugin-scaffolding/blob/main/docs/README.md) for an example. 1. Update the top-level README for each of the components within your integration to follow the structure defined in the scaffolding template. -1. ### Testing Plugin Documentation