From 41ee96e9d199e64bf766c6677b25700ef9887972 Mon Sep 17 00:00:00 2001 From: Wilken Rivera Date: Tue, 5 Dec 2023 20:31:03 +0000 Subject: [PATCH] backport of commit cae2c5eb621ed341e93b8672b6455daa3b43d239 --- .../content/docs/plugins/creation/index.mdx | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/website/content/docs/plugins/creation/index.mdx b/website/content/docs/plugins/creation/index.mdx index 7d7939f4683..cb6d7d70682 100644 --- a/website/content/docs/plugins/creation/index.mdx +++ b/website/content/docs/plugins/creation/index.mdx @@ -171,25 +171,25 @@ Here's what you need to create releases using GitHub Actions: ## Registering Plugins -~> Note: Registering a plugin as an integration requires the use of [Packer's Incofiguration configuration](https://github.com/hashicorp/packer-plugin-scaffolding/tree/main/docs). +~> 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) 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. +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. 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 may have the necessary structure in place. If so you can jump to step 3. +1. Update your plugin documentation structure to match the [Scaffolding example layout](https://github.com/hashicorp/packer-plugin-scaffolding/tree/main/.web-docs). +New plugins generated from this 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 plugins existing documentation will need to migrate to a top-level README. +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 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. 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. +1. Open a request for integration issue with the Packer team - [Open Request](https://github.com/hashicorp/packer/issues/new?labels=new-plugin-contribution&template=plugin_integration.md). +Provide all the requested information to help expedite the integration request. #### [Example] Add integration files to existing plugin repository @@ -199,7 +199,7 @@ cd packer-plugin-name mkdir -p .web-docs/scripts # Download packer-plugin-scaffolding repo copy files -curl -L -O https://github.com/hashicorp/packer-plugin-scaffolding/archive/refs/heads/main.zip +wget https://github.com/hashicorp/packer-plugin-scaffolding/archive/refs/heads/main.zip unzip main.zip cp packer-plugin-scaffolding-main/.web-docs/metadata.hcl .web-docs/ cp -r packer-plugin-scaffolding-main/.web-docs/scripts/ .web-docs/scripts/