From e3a70e1e5fc70b6e9c5e4a6674317e448228eba2 Mon Sep 17 00:00:00 2001 From: Wilken Rivera Date: Fri, 1 Dec 2023 15:16:52 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Sylvia Moss --- website/content/docs/plugins/creation/index.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/content/docs/plugins/creation/index.mdx b/website/content/docs/plugins/creation/index.mdx index 7d7939f4683..ab517bffeb1 100644 --- a/website/content/docs/plugins/creation/index.mdx +++ b/website/content/docs/plugins/creation/index.mdx @@ -175,12 +175,12 @@ Here's what you need to create releases using GitHub Actions: 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) be added to your plugin repository for configuring the Packer integration pipeline and +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 render 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]. +1. Update your plugin documentation structure according to the template defined with the [Packer Plugin Scaffolding template](https://github.com/hashicorp/packer-plugin-scaffolding/tree/main/docs). New plugins generated from this template may 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 plugins existing documentation will need to migrate to a top-level README. @@ -189,7 +189,7 @@ needed to inform users on how to work with your integration. Refer to [Packer sc 1. Update the top-level README for each of the components within your integration to follow the structure defined in the scaffolding template. 1. Add the integration configuration file [metadata.hcl](https://github.com/hashicorp/packer-plugin-scaffolding/blob/main/.web-docs/metadata.hcl) to the plugins `.web-docs` directory. 1. Open a request for integration issue with the Packer team - [Open Request](https://github.com/hashicorp/packer/issues/new/choose). -Please provide all the requested information to help expedite the integration request. +Provide all the requested information to help expedite the integration request. #### [Example] Add integration files to existing plugin repository