Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Wilken Rivera <[email protected]>
  • Loading branch information
lbajolet-hashicorp and Wilken Rivera authored Dec 5, 2023
1 parent 9dc7507 commit 5e078a8
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions website/content/docs/plugins/creation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,17 +171,14 @@ Here's what you need to create releases using GitHub Actions:

## Registering Plugins

~> Note: Registering a plugin as an integration requires the documentation to match the [Scaffolding example layout](https://github.com/hashicorp/packer-plugin-scaffolding/tree/main/.web-docs).

To help with the discovery of Packer plugins, plugins maintainers can choose to register their plugin as a [Packer Integration](https://developer.hashicorp.com/packer/integrations).

The registration process requires [metadata configuration](https://github.com/hashicorp/integration-template#metadata-configuration) to be added to your plugin repository for configuring the Packer integration pipeline and
a specific directory structure for plugin documentation to be rendered on the [Packer Integrations](https://developer.hashicorp.com/packer/integrations) portal.
The registration process requires [metadata configuration](https://github.com/hashicorp/integration-template#metadata-configuration) to be added to your plugin repository for configuring the Packer integration pipeline and a [`web-docs`](https://github.com/hashicorp/packer-plugin-scaffolding/tree/main/.web-docs) directory structure for plugin documentation to be rendered on the [Packer Integrations](https://developer.hashicorp.com/packer/integrations) portal.

You can execute the following steps to register your plugin as an integration:

1. Update your plugin documentation structure according to the template defined with the [Packer Plugin Scaffolding template].
New plugins generated from this template have the necessary structure in place. If so you can jump to step 3.
New plugins generated from the scaffolding template have the necessary structure in place. If so you can jump to step 3.
1. For the integrations library, only one top-level README per integration is supported. Any top-level index.mdx files that exist
within a plugin's existing documentation will need to migrate to a top-level README.
1. Update your top-level integration README to include a description, plugin installation steps, available components section, and, any, additional sections
Expand Down

0 comments on commit 5e078a8

Please sign in to comment.