HCL docs for all plugins

SwampDragons commented 4 years ago

Docs cleanup: make sure that HCL examples are available for all plugins.

Provisioners

[x] ansible
[x] ansible-local
[ ] azure-dtlartifact
[x] breakpoint
[ ] chef-client
[ ] chef-solo
[ ] converge
[x] file
[x] inspec
[x] powershell
[ ] puppet-masterless
[ ] puppet-server
[ ] salt-masterless
[x] shell
[x] shell-local
[ ] sleep
[x] windows-restart
[x] windows-shell

Postprocessors

[ ] alicloud-import
[ ] amazon-import
[ ] artifice
[x] checksum
[ ] compress
[x] digitalocean-import
[ ] docker-import
[ ] docker-push
[ ] docker-save
[ ] docker-tag
[ ] exoscale-import
[x] googlecompute-export
[x] googlecompute-import
[x] manifest
[x] shell-local
[ ] ucloud-import
[ ] vagrant
[ ] vagrant-cloud
[x] vsphere
[ ] vsphere-template
[ ] yandex-export
[ ] yandex-import

Builders

[x] alicloud
[x] amazon
[x] azure
[ ] cloudstack
[ ] digitalocean
[x] docker
[x] file
[x] googlecompute
[ ] hcloud
[ ] hyperone
[ ] hyperv
[ ] jdcloud
[ ] linode
[ ] lxc
[ ] lxd
[ ] ncloud
[x] null
[ ] oneandone
[ ] openstack
[ ] oracle
[ ] osc
[ ] parallels
[ ] profitbricks
[ ] proxmox
[x] qemu
[ ] scaleway
[ ] tencentcloud
[ ] triton
[ ] ucloud
[x] vagrant
[x] virtualbox
[ ] vmware
[x] vsphere
[ ] yandex

adeniyistephen commented 3 years ago

@sylviamoss @SwampDragons @nywilken Hi, is the documentation for this issue completed? if not kindly provide input and pointers to work with, cause i think you people are busy. Thanks :)

sylviamoss commented 3 years ago

Hi @adeniyistephen, thanks for the interest in contributing. The documentation for this issue is not yet complete. I suggest you have a look at our previous PR to get how we add the HCL2 examples. Basically, in mdx files, we use Tab. On partials Tab doesn't work, when we generate the doc from a configuration we can't use it so we simply add as a new example under the JSON existing one. To get the HCL2 version from a JSON template you can use the hcl2_upgrade command. Let me know if you have any questions. Thanks again!

adeniyistephen commented 3 years ago

ok, thanks... lets say i want to generate the doc for openstark, how would the command look like, or where should i go to get the JSON? better still how do i just do one, Thanks... Please kindly get back.

SwampDragons commented 3 years ago

there's a json example in the docs page https://www.packer.io/docs/builders/openstack

adeniyistephen commented 3 years ago

ok, so what do i need to do there? and how do i get started? sorry my question can be too much. but i want to get it right. since there is a doc for openstark, should i pick another one ?

SwampDragons commented 3 years ago

The ticket is to add HCL formatted templates to the docs.

So, take the JSON template, convert it to HCL, and add the HCL to the markdown. The code for that website page is here: https://github.com/hashicorp/packer/blob/master/website/pages/docs/builders/openstack.mdx

You can find the source for pages that have already implemented HCL docs here: https://raw.githubusercontent.com/hashicorp/packer/master/website/pages/docs/builders/amazon/ebs.mdx

adeniyistephen commented 3 years ago

The ticket is to add HCL formatted templates to the docs.

So, take the JSON template, convert it to HCL, and add the HCL to the markdown. The code for that website page is here: https://github.com/hashicorp/packer/blob/master/website/pages/docs/builders/openstack.mdx

You can find the source for pages that have already implemented HCL docs here: https://raw.githubusercontent.com/hashicorp/packer/master/website/pages/docs/builders/amazon/ebs.mdx

Hi, I m sorry. The pages you shared are not found.

deric4 commented 3 years ago

@adeniyistephen I think the following change to the url should work:

- https://github.com/hashicorp/packer/blob/master/website/pages/docs/builders/openstack.mdx
+ https://github.com/hashicorp/packer/blob/master/website/content/docs/builders/openstack.mdx

- https://raw.githubusercontent.com/hashicorp/packer/master/website/pages/docs/builders/amazon/ebs.mdx
+ https://raw.githubusercontent.com/hashicorp/packer/master/website/content/docs/builders/amazon/ebs.mdx

adeniyistephen commented 3 years ago

@adeniyistephen I think the following change to the url should work:

- https://github.com/hashicorp/packer/blob/master/website/pages/docs/builders/openstack.mdx
+ https://github.com/hashicorp/packer/blob/master/website/content/docs/builders/openstack.mdx

- https://raw.githubusercontent.com/hashicorp/packer/master/website/pages/docs/builders/amazon/ebs.mdx
+ https://raw.githubusercontent.com/hashicorp/packer/master/website/content/docs/builders/amazon/ebs.mdx

Thanks. :)

tenthirtyam commented 3 months ago

Post split of the plugins, it seems that this should be dependent on the plugin's provider. Also, it seems that all the out-of-the-box provisioners have HCL docs now.

hashicorp/packer-plugin-scaffolding now leads with HCL.

cc @nywilken

Ryan

hashicorp / packer

HCL docs for all plugins #9668