From 652d2a4e9ee23aef035cea3e2c4987e13149b98b Mon Sep 17 00:00:00 2001 From: Wilken Rivera Date: Wed, 8 Jul 2020 07:17:13 -0400 Subject: [PATCH] Add note for unmaintained community-supported plugins This change borrowed from Terraform's [archived provider documentation](https://www.terraform.io/docs/internals/archiving.html) adds a documentation partial that can be applied to any provisioner plugin that is not actively maintained by Packer or the community. A call to action for anyone interested in supporting the plugin has been added to the Packer README until a better location is made available. * Mark the salt-masterless plugin as unmaintained --- README.md | 17 +++++++++++++++++ .../pages/docs/provisioners/salt-masterless.mdx | 3 +++ .../provisioners/unmaintained-plugin.mdx | 2 ++ 3 files changed, 22 insertions(+) create mode 100644 website/pages/partials/provisioners/unmaintained-plugin.mdx diff --git a/README.md b/README.md index cd870c790..d309212bb 100644 --- a/README.md +++ b/README.md @@ -95,3 +95,20 @@ See [CONTRIBUTING.md](https://github.com/hashicorp/packer/blob/master/.github/CONTRIBUTING.md) for best practices and instructions on setting up your development environment to work on Packer. + +## Unmaintained Plugins +As contributors' circumstances change, development on a community-maintained +plugins can slow. When this happens, the Packer team may mark a plugin as +unmaintained, to clearly signal the plugin's status to users. + +What does **unmaintained** mean? + +1. The code repository and all commit history will still be available. +1. Documentation will remain on the Packer website. +1. Issues and pull requests are monitored as a best effort. +1. No active development will be performed by the Packer team. + +If anyone from the community or an interested third party is willing to +maintain a community supported plugin, they can fork the repository for +their own uses. If you are interested in maintaining a plugin that has been +marked as unmaintained, please reach out via [Packer's Issue Tracker](https://github.com/hashicorp/packer/issues/) diff --git a/website/pages/docs/provisioners/salt-masterless.mdx b/website/pages/docs/provisioners/salt-masterless.mdx index 89d173741..eff65dcb7 100644 --- a/website/pages/docs/provisioners/salt-masterless.mdx +++ b/website/pages/docs/provisioners/salt-masterless.mdx @@ -9,12 +9,15 @@ sidebar_title: Salt Masterless # Salt Masterless Provisioner +@include 'provisioners/unmaintained-plugin.mdx' + Type: `salt-masterless` The `salt-masterless` Packer provisioner provisions machines built by Packer using [Salt](http://saltstack.com/) states, without connecting to a Salt master. + ## Basic Example The example below is fully functional. diff --git a/website/pages/partials/provisioners/unmaintained-plugin.mdx b/website/pages/partials/provisioners/unmaintained-plugin.mdx new file mode 100644 index 000000000..eff38ab92 --- /dev/null +++ b/website/pages/partials/provisioners/unmaintained-plugin.mdx @@ -0,0 +1,2 @@ + +~> **This community-supported provisioner is unmaintained**, read more details in the [README](https://github.com/hashicorp/packer/blob/master/README.md#unmaintained-plugins)