Circular, empty reference in provisioner documentation

[Jesse Thomas Alford]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Overview of the Issue

The documentation describing provisioners contains a loop of references between two doc locations,
neither of which delivers the information the link to it claims.

The hcl_templates docs claim that the list of available provisioners can be found in the provisioners section.

Following that link, the main provisioners docs do not list available provisioners, instead listing use-cases you may want to use them for. It then links back to the prior page, with the claim The documentation includes details about each type of provisioner.

The only thing on that page I could identify as a "type of provisioner" is On Error Provisioner and it does not appear to be part of a set.

My initial impulse is to remove the claims that the documentation makes about the information that will be found in each article, while maintaining the link itself. But, it would be even better if the promised list of available provisioners and details about each type of provisioner were made clearly available; unfortunately, I don't yet know how to do that.

Do such resources currently exist somewhere in the documentation?
Did they previously?

Should I just excise the falsehoods in a PR?

Reproduction Steps

Go to the Provisioner Block docs and follow the link at the end of the section.

Upon arrival at the main provisioners docs, note the absence of a list of provisioners.

Then, follow the link at the end of those docs back to the first doc, noting the claim about what information you will find there.

Upon arrival at the Provisioner Block docs, note the absence of any clear list of "types of provisioner."

Packer version

1.10.x (latest)

Simplified Packer Template

N/A

Operating system and Environment details

N/A (Well, Firefox on Mac OS, but, probably N/A)

Log Fragments and crash.log files

N/A