From db48bf7d5879ffa4ffb4c30df8aff613185667c9 Mon Sep 17 00:00:00 2001 From: Jeff Escalante Date: Thu, 26 Mar 2020 20:28:32 -0400 Subject: [PATCH] adjust builder nesting paths --- website/_redirects | 37 ++++++ website/data/docs-navigation.js | 124 +++++++++--------- .../{amazon-chroot.mdx => amazon/chroot.mdx} | 0 .../{amazon-ebs.mdx => amazon/ebs.mdx} | 0 .../ebssurrogate.mdx} | 0 .../ebsvolume.mdx} | 0 .../builders/{amazon.mdx => amazon/index.mdx} | 0 .../instance.mdx} | 0 .../builders/{azure-arm.mdx => azure/arm.mdx} | 0 .../{azure-chroot.mdx => azure/chroot.mdx} | 0 .../builders/{azure.mdx => azure/index.mdx} | 0 website/pages/docs/builders/docker.mdx | 2 +- .../builders/{hyperv.mdx => hyperv/index.mdx} | 0 .../{hyperv-iso.mdx => hyperv/iso.mdx} | 0 .../{hyperv-vmcx.mdx => hyperv/vmcx.mdx} | 0 .../classic.mdx} | 0 .../builders/{oracle.mdx => oracle/index.mdx} | 0 .../{oracle-oci.mdx => oracle/oci.mdx} | 0 .../{osc-bsu.mdx => outscale/bsu.mdx} | 0 .../bsusurrogate.mdx} | 0 .../bsuvolume.mdx} | 0 .../{osc-chroot.mdx => outscale/chroot.mdx} | 0 .../{outscale.mdx => outscale/index.mdx} | 0 .../{parallels.mdx => parallels/index.mdx} | 0 .../{parallels-iso.mdx => parallels/iso.mdx} | 0 .../{parallels-pvm.mdx => parallels/pvm.mdx} | 0 .../{virtualbox.mdx => virtualbox/index.mdx} | 0 .../iso.mdx} | 0 .../ovf.mdx} | 0 .../{virtualbox-vm.mdx => virtualbox/vm.mdx} | 0 .../builders/{vmware.mdx => vmware/index.mdx} | 0 .../{vmware-iso.mdx => vmware/iso.mdx} | 0 .../{vmware-vmx.mdx => vmware/vmx.mdx} | 0 .../builders/{ => vmware}/vsphere-clone.mdx | 0 .../builders/{ => vmware}/vsphere-iso.mdx | 0 website/pages/docs/commands/index.mdx | 46 +++---- .../functions/collection/contains.mdx | 2 +- .../functions/collection/distinct.mdx | 2 +- .../from-1.5/functions/collection/element.mdx | 4 +- .../from-1.5/functions/collection/merge.mdx | 2 +- .../from-1.5/functions/collection/range.mdx | 2 +- .../from-1.5/functions/conversion/can.mdx | 4 +- .../from-1.5/functions/conversion/convert.mdx | 2 +- .../from-1.5/functions/conversion/try.mdx | 4 +- .../docs/from-1.5/functions/crypto/sha1.mdx | 2 +- .../docs/from-1.5/functions/crypto/sha256.mdx | 2 +- .../docs/from-1.5/functions/crypto/sha512.mdx | 2 +- .../functions/datetime/formatdate.mdx | 2 +- .../from-1.5/functions/encoding/csvdecode.mdx | 2 +- .../functions/encoding/yamldecode.mdx | 2 +- .../functions/encoding/yamlencode.mdx | 2 +- .../docs/from-1.5/functions/file/abspath.mdx | 2 +- .../from-1.5/functions/file/pathexpand.mdx | 2 +- .../from-1.5/functions/ipnet/cidrsubnet.mdx | 12 +- .../from-1.5/functions/numeric/parseint.mdx | 2 +- .../docs/from-1.5/functions/uuid/uuidv5.mdx | 6 +- website/pages/docs/from-1.5/variables.mdx | 4 +- .../ecs/AlicloudDiskDevices-not-required.mdx | 6 +- website/scripts/changelog.md | 14 +- 59 files changed, 171 insertions(+), 122 deletions(-) rename website/pages/docs/builders/{amazon-chroot.mdx => amazon/chroot.mdx} (100%) rename website/pages/docs/builders/{amazon-ebs.mdx => amazon/ebs.mdx} (100%) rename website/pages/docs/builders/{amazon-ebssurrogate.mdx => amazon/ebssurrogate.mdx} (100%) rename website/pages/docs/builders/{amazon-ebsvolume.mdx => amazon/ebsvolume.mdx} (100%) rename website/pages/docs/builders/{amazon.mdx => amazon/index.mdx} (100%) rename website/pages/docs/builders/{amazon-instance.mdx => amazon/instance.mdx} (100%) rename website/pages/docs/builders/{azure-arm.mdx => azure/arm.mdx} (100%) rename website/pages/docs/builders/{azure-chroot.mdx => azure/chroot.mdx} (100%) rename website/pages/docs/builders/{azure.mdx => azure/index.mdx} (100%) rename website/pages/docs/builders/{hyperv.mdx => hyperv/index.mdx} (100%) rename website/pages/docs/builders/{hyperv-iso.mdx => hyperv/iso.mdx} (100%) rename website/pages/docs/builders/{hyperv-vmcx.mdx => hyperv/vmcx.mdx} (100%) rename website/pages/docs/builders/{oracle-classic.mdx => oracle/classic.mdx} (100%) rename website/pages/docs/builders/{oracle.mdx => oracle/index.mdx} (100%) rename website/pages/docs/builders/{oracle-oci.mdx => oracle/oci.mdx} (100%) rename website/pages/docs/builders/{osc-bsu.mdx => outscale/bsu.mdx} (100%) rename website/pages/docs/builders/{osc-bsusurrogate.mdx => outscale/bsusurrogate.mdx} (100%) rename website/pages/docs/builders/{osc-bsuvolume.mdx => outscale/bsuvolume.mdx} (100%) rename website/pages/docs/builders/{osc-chroot.mdx => outscale/chroot.mdx} (100%) rename website/pages/docs/builders/{outscale.mdx => outscale/index.mdx} (100%) rename website/pages/docs/builders/{parallels.mdx => parallels/index.mdx} (100%) rename website/pages/docs/builders/{parallels-iso.mdx => parallels/iso.mdx} (100%) rename website/pages/docs/builders/{parallels-pvm.mdx => parallels/pvm.mdx} (100%) rename website/pages/docs/builders/{virtualbox.mdx => virtualbox/index.mdx} (100%) rename website/pages/docs/builders/{virtualbox-iso.mdx => virtualbox/iso.mdx} (100%) rename website/pages/docs/builders/{virtualbox-ovf.mdx => virtualbox/ovf.mdx} (100%) rename website/pages/docs/builders/{virtualbox-vm.mdx => virtualbox/vm.mdx} (100%) rename website/pages/docs/builders/{vmware.mdx => vmware/index.mdx} (100%) rename website/pages/docs/builders/{vmware-iso.mdx => vmware/iso.mdx} (100%) rename website/pages/docs/builders/{vmware-vmx.mdx => vmware/vmx.mdx} (100%) rename website/pages/docs/builders/{ => vmware}/vsphere-clone.mdx (100%) rename website/pages/docs/builders/{ => vmware}/vsphere-iso.mdx (100%) diff --git a/website/_redirects b/website/_redirects index 33b072635..661ee45c5 100644 --- a/website/_redirects +++ b/website/_redirects @@ -24,10 +24,47 @@ /docs/machine-readable/* /docs/commands/index.html 301! /docs/command-line/* /docs/commands/:splat 200 /docs/extend/* /docs/extending/:splat 200 + /intro/getting-started/install /intro/getting-started 301! /intro/getting-started/install.html /intro/getting-started 301! + /docs/basics/terminology /docs/terminology 301! /docs/basics/terminology.html /docs/terminology 301! + /docs/configuration/from-1.5/:path /docs/from-1.5/:path 200 /docs/configuration/from-1.5/:path/overview /docs/from-1.5/:path 200 /docs/configuration/from-1.5/:path/overview.html /docs/from-1.5/:path 200 + +/docs/builders/amazon.html /docs/builders/amazon 301! +/docs/builders/amazon-:path.html /docs/builders/amazon/:path 200 +/docs/builders/amazon-:path /docs/builders/amazon/:path 200 + +/docs/builders/azure.html /docs/builders/azure 301! +/docs/builders/azure-:path.html /docs/builders/azure/:path 200 +/docs/builders/azure-:path /docs/builders/azure/:path 200 + +/docs/builders/hyperv.html /docs/builders/hyperv 301! +/docs/builders/hyperv-:path.html /docs/builders/hyperv/:path 200 +/docs/builders/hyperv-:path /docs/builders/hyperv/:path 200 + +/docs/builders/oracle.html /docs/builders/oracle 301! +/docs/builders/oracle-:path.html /docs/builders/oracle/:path 200 +/docs/builders/oracle-:path /docs/builders/oracle/:path 200 + +/docs/builders/outscale.html /docs/builders/outscale 301! +/docs/builders/osc-:path.html /docs/builders/outscale/:path 200 +/docs/builders/osc-:path /docs/builders/outscale/:path 200 + +/docs/builders/parallels.html /docs/builders/parallels 301! +/docs/builders/parallels-:path.html /docs/builders/parallels/:path 200 +/docs/builders/parallels-:path /docs/builders/parallels/:path 200 + +/docs/builders/virtualbox.html /docs/builders/virtualbox 301! +/docs/builders/virtualbox-:path.html /docs/builders/virtualbox/:path 200 +/docs/builders/virtualbox-:path /docs/builders/virtualbox/:path 200 + +/docs/builders/vmware.html /docs/builders/vmware 301! +/docs/builders/vmware-:path.html /docs/builders/vmware/:path 200 +/docs/builders/vmware-:path /docs/builders/vmware/:path 200 +/docs/builders/vsphere-:path.html /docs/builders/vmware/vsphere-:path 200 +/docs/builders/vsphere-:path /docs/builders/vmware/vsphere-:path 200 diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index 254789779..77c72bb39 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -28,8 +28,8 @@ export default [ 'min', 'parseint', 'pow', - 'signum' - ] + 'signum', + ], }, { category: 'string', @@ -50,8 +50,8 @@ export default [ 'trimprefix', 'trimsuffix', 'trimspace', - 'upper' - ] + 'upper', + ], }, { category: 'collection', @@ -77,8 +77,8 @@ export default [ 'slice', 'sort', 'values', - 'zipmap' - ] + 'zipmap', + ], }, { category: 'encoding', @@ -90,8 +90,8 @@ export default [ 'jsonencode', 'urlencode', 'yamldecode', - 'yamlencode' - ] + 'yamlencode', + ], }, { category: 'file', @@ -102,38 +102,45 @@ export default [ 'file', 'fileexists', 'fileset', - 'pathexpand' - ] + 'pathexpand', + ], }, { category: 'datetime', - content: ['formatdate', 'timeadd', 'timestamp'] + content: ['formatdate', 'timeadd', 'timestamp'], }, { category: 'crypto', - content: ['bcrypt', 'md5', 'rsadecrypt', 'sha1', 'sha256', 'sha512'] + content: [ + 'bcrypt', + 'md5', + 'rsadecrypt', + 'sha1', + 'sha256', + 'sha512', + ], }, { category: 'uuid', - content: ['uuidv4', 'uuidv5'] + content: ['uuidv4', 'uuidv5'], }, { category: 'ipnet', - content: ['cidrhost', 'cidrnetmask', 'cidrsubnet'] + content: ['cidrhost', 'cidrnetmask', 'cidrsubnet'], }, { category: 'conversion', - content: ['can', 'convert', 'try'] - } - ] - } - ] + content: ['can', 'convert', 'try'], + }, + ], + }, + ], }, '--------', 'terminology', { category: 'commands', - content: ['build', 'console', 'fix', 'inspect', 'validate'] + content: ['build', 'console', 'fix', 'inspect', 'validate'], }, { category: 'templates', @@ -143,8 +150,8 @@ export default [ 'engine', 'post-processors', 'provisioners', - 'user-variables' - ] + 'user-variables', + ], }, '----------', { category: 'communicators', content: ['ssh', 'winrm'] }, @@ -152,15 +159,14 @@ export default [ category: 'builders', content: [ 'alicloud-ecs', - 'amazon', - 'amazon-chroot', - 'amazon-ebs', - 'amazon-ebssurrogate', - 'amazon-ebsvolume', - 'amazon-instance', - 'azure', - 'azure-arm', - 'azure-chroot', + { + category: 'amazon', + content: ['chroot', 'ebs', 'ebssurrogate', 'ebsvolume', 'instance'], + }, + { + category: 'azure', + content: ['arm', 'chroot'], + }, 'cloudstack', 'digitalocean', 'docker', @@ -168,9 +174,7 @@ export default [ 'googlecompute', 'hetzner-cloud', 'hyperone', - 'hyperv', - 'hyperv-iso', - 'hyperv-vmcx', + { category: 'hyperv', content: ['iso', 'vmcx'] }, 'linode', 'lxc', 'lxd', @@ -178,17 +182,12 @@ export default [ 'null', 'oneandone', 'openstack', - 'oracle', - 'oracle-classic', - 'oracle-oci', - 'outscale', - 'osc-chroot', - 'osc-bsu', - 'osc-bsusurrogate', - 'osc-bsuvolume', - 'parallels', - 'parallels-iso', - 'parallels-pvm', + { category: 'oracle', content: ['classic', 'oci'] }, + { + category: 'outscale', + content: ['chroot', 'bsu', 'bsusurrogate', 'bsuvolume'], + }, + { category: 'parallels', content: ['iso', 'pvm'] }, 'profitbricks', 'proxmox', 'qemu', @@ -198,19 +197,18 @@ export default [ 'triton', 'ucloud-uhost', 'vagrant', - 'virtualbox', - 'virtualbox-iso', - 'virtualbox-ovf', - 'virtualbox-vm', - 'vmware', - 'vmware-iso', - 'vmware-vmx', - 'vsphere-iso', - 'vsphere-clone', + { + category: 'virtualbox', + content: ['iso', 'ovf', 'vm'], + }, + { + category: 'vmware', + content: ['iso', 'vmx', 'vsphere-iso', 'vsphere-clone'], + }, 'yandex', 'custom', - 'community-supported' - ] + 'community-supported', + ], }, { category: 'provisioners', @@ -232,8 +230,8 @@ export default [ 'windows-shell', 'windows-restart', 'custom', - 'community-supported' - ] + 'community-supported', + ], }, { category: 'post-processors', @@ -257,8 +255,8 @@ export default [ 'vagrant', 'vagrant-cloud', 'vsphere', - 'vsphere-template' - ] + 'vsphere-template', + ], }, '----------', 'install', @@ -269,11 +267,11 @@ export default [ 'plugins', 'custom-builders', 'custom-post-processors', - 'custom-provisioners' - ] + 'custom-provisioners', + ], }, '---------', 'environment-variables', 'core-configuration', - 'debugging' + 'debugging', ] diff --git a/website/pages/docs/builders/amazon-chroot.mdx b/website/pages/docs/builders/amazon/chroot.mdx similarity index 100% rename from website/pages/docs/builders/amazon-chroot.mdx rename to website/pages/docs/builders/amazon/chroot.mdx diff --git a/website/pages/docs/builders/amazon-ebs.mdx b/website/pages/docs/builders/amazon/ebs.mdx similarity index 100% rename from website/pages/docs/builders/amazon-ebs.mdx rename to website/pages/docs/builders/amazon/ebs.mdx diff --git a/website/pages/docs/builders/amazon-ebssurrogate.mdx b/website/pages/docs/builders/amazon/ebssurrogate.mdx similarity index 100% rename from website/pages/docs/builders/amazon-ebssurrogate.mdx rename to website/pages/docs/builders/amazon/ebssurrogate.mdx diff --git a/website/pages/docs/builders/amazon-ebsvolume.mdx b/website/pages/docs/builders/amazon/ebsvolume.mdx similarity index 100% rename from website/pages/docs/builders/amazon-ebsvolume.mdx rename to website/pages/docs/builders/amazon/ebsvolume.mdx diff --git a/website/pages/docs/builders/amazon.mdx b/website/pages/docs/builders/amazon/index.mdx similarity index 100% rename from website/pages/docs/builders/amazon.mdx rename to website/pages/docs/builders/amazon/index.mdx diff --git a/website/pages/docs/builders/amazon-instance.mdx b/website/pages/docs/builders/amazon/instance.mdx similarity index 100% rename from website/pages/docs/builders/amazon-instance.mdx rename to website/pages/docs/builders/amazon/instance.mdx diff --git a/website/pages/docs/builders/azure-arm.mdx b/website/pages/docs/builders/azure/arm.mdx similarity index 100% rename from website/pages/docs/builders/azure-arm.mdx rename to website/pages/docs/builders/azure/arm.mdx diff --git a/website/pages/docs/builders/azure-chroot.mdx b/website/pages/docs/builders/azure/chroot.mdx similarity index 100% rename from website/pages/docs/builders/azure-chroot.mdx rename to website/pages/docs/builders/azure/chroot.mdx diff --git a/website/pages/docs/builders/azure.mdx b/website/pages/docs/builders/azure/index.mdx similarity index 100% rename from website/pages/docs/builders/azure.mdx rename to website/pages/docs/builders/azure/index.mdx diff --git a/website/pages/docs/builders/docker.mdx b/website/pages/docs/builders/docker.mdx index 7b530f4e6..161da6e77 100644 --- a/website/pages/docs/builders/docker.mdx +++ b/website/pages/docs/builders/docker.mdx @@ -35,7 +35,7 @@ Docker supports and how to install onto them](https://docs.docker.com/engine/installation/) in the Docker documentation. - Please note: Packer does not yet have support for Windows containers. +~> **Please note:** Packer does not yet have support for Windows containers. ## Basic Example: Export diff --git a/website/pages/docs/builders/hyperv.mdx b/website/pages/docs/builders/hyperv/index.mdx similarity index 100% rename from website/pages/docs/builders/hyperv.mdx rename to website/pages/docs/builders/hyperv/index.mdx diff --git a/website/pages/docs/builders/hyperv-iso.mdx b/website/pages/docs/builders/hyperv/iso.mdx similarity index 100% rename from website/pages/docs/builders/hyperv-iso.mdx rename to website/pages/docs/builders/hyperv/iso.mdx diff --git a/website/pages/docs/builders/hyperv-vmcx.mdx b/website/pages/docs/builders/hyperv/vmcx.mdx similarity index 100% rename from website/pages/docs/builders/hyperv-vmcx.mdx rename to website/pages/docs/builders/hyperv/vmcx.mdx diff --git a/website/pages/docs/builders/oracle-classic.mdx b/website/pages/docs/builders/oracle/classic.mdx similarity index 100% rename from website/pages/docs/builders/oracle-classic.mdx rename to website/pages/docs/builders/oracle/classic.mdx diff --git a/website/pages/docs/builders/oracle.mdx b/website/pages/docs/builders/oracle/index.mdx similarity index 100% rename from website/pages/docs/builders/oracle.mdx rename to website/pages/docs/builders/oracle/index.mdx diff --git a/website/pages/docs/builders/oracle-oci.mdx b/website/pages/docs/builders/oracle/oci.mdx similarity index 100% rename from website/pages/docs/builders/oracle-oci.mdx rename to website/pages/docs/builders/oracle/oci.mdx diff --git a/website/pages/docs/builders/osc-bsu.mdx b/website/pages/docs/builders/outscale/bsu.mdx similarity index 100% rename from website/pages/docs/builders/osc-bsu.mdx rename to website/pages/docs/builders/outscale/bsu.mdx diff --git a/website/pages/docs/builders/osc-bsusurrogate.mdx b/website/pages/docs/builders/outscale/bsusurrogate.mdx similarity index 100% rename from website/pages/docs/builders/osc-bsusurrogate.mdx rename to website/pages/docs/builders/outscale/bsusurrogate.mdx diff --git a/website/pages/docs/builders/osc-bsuvolume.mdx b/website/pages/docs/builders/outscale/bsuvolume.mdx similarity index 100% rename from website/pages/docs/builders/osc-bsuvolume.mdx rename to website/pages/docs/builders/outscale/bsuvolume.mdx diff --git a/website/pages/docs/builders/osc-chroot.mdx b/website/pages/docs/builders/outscale/chroot.mdx similarity index 100% rename from website/pages/docs/builders/osc-chroot.mdx rename to website/pages/docs/builders/outscale/chroot.mdx diff --git a/website/pages/docs/builders/outscale.mdx b/website/pages/docs/builders/outscale/index.mdx similarity index 100% rename from website/pages/docs/builders/outscale.mdx rename to website/pages/docs/builders/outscale/index.mdx diff --git a/website/pages/docs/builders/parallels.mdx b/website/pages/docs/builders/parallels/index.mdx similarity index 100% rename from website/pages/docs/builders/parallels.mdx rename to website/pages/docs/builders/parallels/index.mdx diff --git a/website/pages/docs/builders/parallels-iso.mdx b/website/pages/docs/builders/parallels/iso.mdx similarity index 100% rename from website/pages/docs/builders/parallels-iso.mdx rename to website/pages/docs/builders/parallels/iso.mdx diff --git a/website/pages/docs/builders/parallels-pvm.mdx b/website/pages/docs/builders/parallels/pvm.mdx similarity index 100% rename from website/pages/docs/builders/parallels-pvm.mdx rename to website/pages/docs/builders/parallels/pvm.mdx diff --git a/website/pages/docs/builders/virtualbox.mdx b/website/pages/docs/builders/virtualbox/index.mdx similarity index 100% rename from website/pages/docs/builders/virtualbox.mdx rename to website/pages/docs/builders/virtualbox/index.mdx diff --git a/website/pages/docs/builders/virtualbox-iso.mdx b/website/pages/docs/builders/virtualbox/iso.mdx similarity index 100% rename from website/pages/docs/builders/virtualbox-iso.mdx rename to website/pages/docs/builders/virtualbox/iso.mdx diff --git a/website/pages/docs/builders/virtualbox-ovf.mdx b/website/pages/docs/builders/virtualbox/ovf.mdx similarity index 100% rename from website/pages/docs/builders/virtualbox-ovf.mdx rename to website/pages/docs/builders/virtualbox/ovf.mdx diff --git a/website/pages/docs/builders/virtualbox-vm.mdx b/website/pages/docs/builders/virtualbox/vm.mdx similarity index 100% rename from website/pages/docs/builders/virtualbox-vm.mdx rename to website/pages/docs/builders/virtualbox/vm.mdx diff --git a/website/pages/docs/builders/vmware.mdx b/website/pages/docs/builders/vmware/index.mdx similarity index 100% rename from website/pages/docs/builders/vmware.mdx rename to website/pages/docs/builders/vmware/index.mdx diff --git a/website/pages/docs/builders/vmware-iso.mdx b/website/pages/docs/builders/vmware/iso.mdx similarity index 100% rename from website/pages/docs/builders/vmware-iso.mdx rename to website/pages/docs/builders/vmware/iso.mdx diff --git a/website/pages/docs/builders/vmware-vmx.mdx b/website/pages/docs/builders/vmware/vmx.mdx similarity index 100% rename from website/pages/docs/builders/vmware-vmx.mdx rename to website/pages/docs/builders/vmware/vmx.mdx diff --git a/website/pages/docs/builders/vsphere-clone.mdx b/website/pages/docs/builders/vmware/vsphere-clone.mdx similarity index 100% rename from website/pages/docs/builders/vsphere-clone.mdx rename to website/pages/docs/builders/vmware/vsphere-clone.mdx diff --git a/website/pages/docs/builders/vsphere-iso.mdx b/website/pages/docs/builders/vmware/vsphere-iso.mdx similarity index 100% rename from website/pages/docs/builders/vsphere-iso.mdx rename to website/pages/docs/builders/vmware/vsphere-iso.mdx diff --git a/website/pages/docs/commands/index.mdx b/website/pages/docs/commands/index.mdx index f1c02d71f..38cfa8afb 100644 --- a/website/pages/docs/commands/index.mdx +++ b/website/pages/docs/commands/index.mdx @@ -126,24 +126,24 @@ You'll see these data types when you run `packer build`: `timestamp, buildname, artifact, artifact_number, key, value` where `key` and `value` contain information about the artifact. - For example: - - ``` - 1539967803,,ui,say,\n==> Builds finished. The artifacts of successful builds are: - 1539967803,amazon-ebs,artifact-count,2 - 1539967803,amazon-ebs,artifact,0,builder-id,mitchellh.amazonebs - 1539967803,amazon-ebs,artifact,0,id,eu-west-1:ami-04d23aca8bdd36e30 - 1539967803,amazon-ebs,artifact,0,string,AMIs were created:\neu-west-1: ami-04d23aca8bdd36e30\n - 1539967803,amazon-ebs,artifact,0,files-count,0 - 1539967803,amazon-ebs,artifact,0,end - 1539967803,,ui,say,--> amazon-ebs: AMIs were created:\neu-west-1: ami-04d23aca8bdd36e30\n - 1539967803,amazon-ebs,artifact,1,builder-id, - 1539967803,amazon-ebs,artifact,1,id, - 1539967803,amazon-ebs,artifact,1,string, - 1539967803,amazon-ebs,artifact,1,files-count,0 - 2018/10/19 09:50:03 waiting for all plugin processes to complete... - 1539967803,amazon-ebs,artifact,1,end - ``` + For example: + + ```shell + 1539967803,,ui,say,\n==> Builds finished. The artifacts of successful builds are: + 1539967803,amazon-ebs,artifact-count,2 + 1539967803,amazon-ebs,artifact,0,builder-id,mitchellh.amazonebs + 1539967803,amazon-ebs,artifact,0,id,eu-west-1:ami-04d23aca8bdd36e30 + 1539967803,amazon-ebs,artifact,0,string,AMIs were created:\neu-west-1: ami-04d23aca8bdd36e30\n + 1539967803,amazon-ebs,artifact,0,files-count,0 + 1539967803,amazon-ebs,artifact,0,end + 1539967803,,ui,say,--> amazon-ebs: AMIs were created:\neu-west-1: ami-04d23aca8bdd36e30\n + 1539967803,amazon-ebs,artifact,1,builder-id, + 1539967803,amazon-ebs,artifact,1,id, + 1539967803,amazon-ebs,artifact,1,string, + 1539967803,amazon-ebs,artifact,1,files-count,0 + 2018/10/19 09:50:03 waiting for all plugin processes to complete... + 1539967803,amazon-ebs,artifact,1,end + ``` You'll see these data types when you run `packer version`: @@ -163,7 +163,9 @@ can invoke a new shell and use the feature. For example, assume a tab is typed at the end of each prompt line: - $ packer p - plugin build - $ packer build - - -color -debug -except -force -machine-readable -on-error -only -parallel -timestamp -var -var-file +```shell +$ packer p +plugin build +$ packer build - +-color -debug -except -force -machine-readable -on-error -only -parallel -timestamp -var -var-file +``` diff --git a/website/pages/docs/from-1.5/functions/collection/contains.mdx b/website/pages/docs/from-1.5/functions/collection/contains.mdx index 8fcc3f980..cb116d8b0 100644 --- a/website/pages/docs/from-1.5/functions/collection/contains.mdx +++ b/website/pages/docs/from-1.5/functions/collection/contains.mdx @@ -17,7 +17,7 @@ contains(list, value) ## Examples -``` +```shell > contains(["a", "b", "c"], "a") true > contains(["a", "b", "c"], "d") diff --git a/website/pages/docs/from-1.5/functions/collection/distinct.mdx b/website/pages/docs/from-1.5/functions/collection/distinct.mdx index 0b15fd010..e4fc52125 100644 --- a/website/pages/docs/from-1.5/functions/collection/distinct.mdx +++ b/website/pages/docs/from-1.5/functions/collection/distinct.mdx @@ -16,7 +16,7 @@ these elements is preserved. ## Examples -``` +```shell > distinct(["a", "b", "a", "c", "d", "b"]) [ "a", diff --git a/website/pages/docs/from-1.5/functions/collection/element.mdx b/website/pages/docs/from-1.5/functions/collection/element.mdx index b9692d9a2..a3d93a099 100644 --- a/website/pages/docs/from-1.5/functions/collection/element.mdx +++ b/website/pages/docs/from-1.5/functions/collection/element.mdx @@ -22,7 +22,7 @@ only for the special additional "wrap-around" behavior described below. ## Examples -``` +```shell > element(["a", "b", "c"], 1) b ``` @@ -30,7 +30,7 @@ b If the given index is greater than the length of the list then the index is "wrapped around" by taking the index modulo the length of the list: -``` +```shell > element(["a", "b", "c"], 3) a ``` diff --git a/website/pages/docs/from-1.5/functions/collection/merge.mdx b/website/pages/docs/from-1.5/functions/collection/merge.mdx index 67321997a..c06fb7c7b 100644 --- a/website/pages/docs/from-1.5/functions/collection/merge.mdx +++ b/website/pages/docs/from-1.5/functions/collection/merge.mdx @@ -18,7 +18,7 @@ in the argument sequence takes precedence. ## Examples -``` +```shell > merge({"a"="b", "c"="d"}, {"e"="f", "c"="z"}) { "a" = "b" diff --git a/website/pages/docs/from-1.5/functions/collection/range.mdx b/website/pages/docs/from-1.5/functions/collection/range.mdx index 7a26edc6d..50a0433d5 100644 --- a/website/pages/docs/from-1.5/functions/collection/range.mdx +++ b/website/pages/docs/from-1.5/functions/collection/range.mdx @@ -30,7 +30,7 @@ to `limit`. For a negative step, it's complete when less than or equal. The sequence-building algorithm follows the following pseudocode: -``` +```text let num = start while num < limit: (or, for negative step, num >= limit) append num to the sequence diff --git a/website/pages/docs/from-1.5/functions/conversion/can.mdx b/website/pages/docs/from-1.5/functions/conversion/can.mdx index d6b667800..9525b3df7 100644 --- a/website/pages/docs/from-1.5/functions/conversion/can.mdx +++ b/website/pages/docs/from-1.5/functions/conversion/can.mdx @@ -31,7 +31,7 @@ prefer to use [`try`](./try.html). ## Examples -``` +```shell > local.foo { "bar" = "baz" @@ -46,7 +46,7 @@ The `can` function will _not_ catch errors relating to constructs that are provably invalid even before dynamic expression evaluation, such as a malformed reference or a reference to a top-level object that has not been declared: -``` +```shell > can(local.nonexist) Error: Reference to undeclared local value diff --git a/website/pages/docs/from-1.5/functions/conversion/convert.mdx b/website/pages/docs/from-1.5/functions/conversion/convert.mdx index 4517b7d3e..aa84bf021 100644 --- a/website/pages/docs/from-1.5/functions/conversion/convert.mdx +++ b/website/pages/docs/from-1.5/functions/conversion/convert.mdx @@ -27,7 +27,7 @@ All other values will produce an error. ## Examples -``` +```shell > convert(3, string) "3" > convert("3", number) diff --git a/website/pages/docs/from-1.5/functions/conversion/try.mdx b/website/pages/docs/from-1.5/functions/conversion/try.mdx index 4592c1c1d..589ff6787 100644 --- a/website/pages/docs/from-1.5/functions/conversion/try.mdx +++ b/website/pages/docs/from-1.5/functions/conversion/try.mdx @@ -85,7 +85,7 @@ to understand and maintain. ## Examples -``` +```shell > local.foo { "bar" = "baz" @@ -100,7 +100,7 @@ The `try` function will _not_ catch errors relating to constructs that are provably invalid even before dynamic expression evaluation, such as a malformed reference or a reference to a top-level object that has not been declared: -``` +```shell > try(local.nonexist, "fallback") Error: Reference to undeclared local value diff --git a/website/pages/docs/from-1.5/functions/crypto/sha1.mdx b/website/pages/docs/from-1.5/functions/crypto/sha1.mdx index f8ba676c0..4405e11cc 100644 --- a/website/pages/docs/from-1.5/functions/crypto/sha1.mdx +++ b/website/pages/docs/from-1.5/functions/crypto/sha1.mdx @@ -23,7 +23,7 @@ relevant literature to understand the security implications. ## Examples -``` +```shell > sha1("hello world") 2aae6c35c94fcfb415dbe95f408b9ce91ee846ed ``` diff --git a/website/pages/docs/from-1.5/functions/crypto/sha256.mdx b/website/pages/docs/from-1.5/functions/crypto/sha256.mdx index 8643e797e..c75d0c5dc 100644 --- a/website/pages/docs/from-1.5/functions/crypto/sha256.mdx +++ b/website/pages/docs/from-1.5/functions/crypto/sha256.mdx @@ -19,7 +19,7 @@ then encoded to lowercase hexadecimal digits before returning. ## Examples -``` +```shell > sha256("hello world") b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9 ``` diff --git a/website/pages/docs/from-1.5/functions/crypto/sha512.mdx b/website/pages/docs/from-1.5/functions/crypto/sha512.mdx index f6d4d6587..f685caf51 100644 --- a/website/pages/docs/from-1.5/functions/crypto/sha512.mdx +++ b/website/pages/docs/from-1.5/functions/crypto/sha512.mdx @@ -19,7 +19,7 @@ then encoded to lowercase hexadecimal digits before returning. ## Examples -``` +```shell > sha512("hello world") 309ecc489c12d6eb4cc40f50c902f2b4d0ed77ee511a7c7a9bcd3ca86d4cd86f989dd35bc5ff499670da34255b45b0cfd830e81f605dcf7dc5542e93ae9cd76f ``` diff --git a/website/pages/docs/from-1.5/functions/datetime/formatdate.mdx b/website/pages/docs/from-1.5/functions/datetime/formatdate.mdx index cd66bb46e..1401a0339 100644 --- a/website/pages/docs/from-1.5/functions/datetime/formatdate.mdx +++ b/website/pages/docs/from-1.5/functions/datetime/formatdate.mdx @@ -21,7 +21,7 @@ this syntax. ## Examples -``` +```shell > formatdate("DD MMM YYYY hh:mm ZZZ", "2018-01-02T23:12:01Z") 02 Jan 2018 23:12 UTC > formatdate("EEEE, DD-MMM-YY hh:mm:ss ZZZ", "2018-01-02T23:12:01Z") diff --git a/website/pages/docs/from-1.5/functions/encoding/csvdecode.mdx b/website/pages/docs/from-1.5/functions/encoding/csvdecode.mdx index 099ce13c6..12b475f45 100644 --- a/website/pages/docs/from-1.5/functions/encoding/csvdecode.mdx +++ b/website/pages/docs/from-1.5/functions/encoding/csvdecode.mdx @@ -23,7 +23,7 @@ number of fields, or this function will produce an error. ## Examples -``` +```shell > csvdecode("a,b,c\n1,2,3\n4,5,6") [ { diff --git a/website/pages/docs/from-1.5/functions/encoding/yamldecode.mdx b/website/pages/docs/from-1.5/functions/encoding/yamldecode.mdx index 041baf676..b8d2a5d1a 100644 --- a/website/pages/docs/from-1.5/functions/encoding/yamldecode.mdx +++ b/website/pages/docs/from-1.5/functions/encoding/yamldecode.mdx @@ -57,7 +57,7 @@ supports only a subset of YAML 1.2, with restrictions including the following: ## Examples -``` +```shell > yamldecode("{\"hello\": \"world\"}") { "hello" = "world" diff --git a/website/pages/docs/from-1.5/functions/encoding/yamlencode.mdx b/website/pages/docs/from-1.5/functions/encoding/yamlencode.mdx index 1e402a6d6..e6e60a1d9 100644 --- a/website/pages/docs/from-1.5/functions/encoding/yamlencode.mdx +++ b/website/pages/docs/from-1.5/functions/encoding/yamlencode.mdx @@ -54,7 +54,7 @@ mean that this is rarely a problem in practice. ## Examples -``` +```shell > yamlencode({"a":"b", "c":"d"}) "a": "b" "c": "d" diff --git a/website/pages/docs/from-1.5/functions/file/abspath.mdx b/website/pages/docs/from-1.5/functions/file/abspath.mdx index e9ad6408b..edf5c72ff 100644 --- a/website/pages/docs/from-1.5/functions/file/abspath.mdx +++ b/website/pages/docs/from-1.5/functions/file/abspath.mdx @@ -20,7 +20,7 @@ only the contents are then stored) or in `connection` and `provisioner` blocks. ## Examples -``` +```shell > abspath(path.root) /home/user/some/packer/root ``` diff --git a/website/pages/docs/from-1.5/functions/file/pathexpand.mdx b/website/pages/docs/from-1.5/functions/file/pathexpand.mdx index 18e8ed993..f28d98ae0 100644 --- a/website/pages/docs/from-1.5/functions/file/pathexpand.mdx +++ b/website/pages/docs/from-1.5/functions/file/pathexpand.mdx @@ -49,7 +49,7 @@ releases of Packer. ## Examples -``` +```shell > pathexpand("~/.ssh/id_rsa") /home/steve/.ssh/id_rsa > pathexpand("/etc/resolv.conf") diff --git a/website/pages/docs/from-1.5/functions/ipnet/cidrsubnet.mdx b/website/pages/docs/from-1.5/functions/ipnet/cidrsubnet.mdx index 524c22407..66362d3ed 100644 --- a/website/pages/docs/from-1.5/functions/ipnet/cidrsubnet.mdx +++ b/website/pages/docs/from-1.5/functions/ipnet/cidrsubnet.mdx @@ -59,7 +59,7 @@ Taking our example above of `cidrsubnet("10.1.2.0/24", 4, 15)`, the function will first convert the given IP address string into an equivalent binary representation: -``` +```text 10 . 1 . 2 . 0 00001010 00000001 00000010 | 00000000 network | host @@ -74,7 +74,7 @@ The CLI tool [`ipcalc`](https://gitlab.com/ipcalc/ipcalc) is useful for visualizing CIDR prefixes as binary numbers. We can confirm the conversion above by providing the same prefix string to `ipcalc`: -``` +```shell $ ipcalc 10.1.2.0/24 Address: 10.1.2.0 00001010.00000001.00000010. 00000000 Netmask: 255.255.255.0 = 24 11111111.11111111.11111111. 00000000 @@ -101,7 +101,7 @@ bits; in our example here we specified `4`, which means that the resulting subnet will have a prefix length of 24 + 4 = 28 bits. We can imagine these bits breaking down as follows: -``` +```text 10 . 1 . 2 . ? 0 00001010 00000001 00000010 | XXXX | 0000 parent network | netnum | host @@ -118,7 +118,7 @@ four new subnet bits. In our current example we passed `15`, which is represented in binary as `1111`, allowing us to fill in the `XXXX` segment in the above: -``` +```text 10 . 1 . 2 . 15 0 00001010 00000001 00000010 | 1111 | 0000 parent network | netnum | host @@ -130,7 +130,7 @@ gives 240, which can then be combined with our new prefix length of 28 to produce the result `10.1.2.240/28`. Again we can pass this prefix string to `ipcalc` to visualize it: -``` +```shell $ ipcalc 10.1.2.240/28 Address: 10.1.2.240 00001010.00000001.00000010.1111 0000 Netmask: 255.255.255.240 = 28 11111111.11111111.11111111.1111 0000 @@ -149,7 +149,7 @@ the network's own address and the broadcast address. You can thus use [`cidrhost`](./cidrhost.html) function to calculate those host addresses by providing it a value between 1 and 14: -``` +```shell > cidrhost("10.1.2.240/28", 1) 10.1.2.241 > cidrhost("10.1.2.240/28", 14) diff --git a/website/pages/docs/from-1.5/functions/numeric/parseint.mdx b/website/pages/docs/from-1.5/functions/numeric/parseint.mdx index 338f70625..bc8ece575 100644 --- a/website/pages/docs/from-1.5/functions/numeric/parseint.mdx +++ b/website/pages/docs/from-1.5/functions/numeric/parseint.mdx @@ -24,7 +24,7 @@ are too large for the given base then `parseint` will produce an error. ## Examples -``` +```shell > parseint("100", 10) 100 diff --git a/website/pages/docs/from-1.5/functions/uuid/uuidv5.mdx b/website/pages/docs/from-1.5/functions/uuid/uuidv5.mdx index 39f0ad04d..cdb18971d 100644 --- a/website/pages/docs/from-1.5/functions/uuid/uuidv5.mdx +++ b/website/pages/docs/from-1.5/functions/uuid/uuidv5.mdx @@ -41,7 +41,7 @@ namespace ID directly in the first argument in the usual UUID string format. Use the namespace keywords where possible, to make the intent more obvious to a future reader: -``` +```shell > uuidv5("dns", "www.packer.io") a5008fae-b28c-5ba5-96cd-82b4c53552d6 @@ -59,7 +59,7 @@ The namespace keywords treated as equivalent to their corresponding namespace UUIDs, and in some special cases it may be more appropriate to use the UUID form: -``` +```shell > uuidv5("6ba7b810-9dad-11d1-80b4-00c04fd430c8", "www.packer.io") a5008fae-b28c-5ba5-96cd-82b4c53552d6 ``` @@ -67,7 +67,7 @@ a5008fae-b28c-5ba5-96cd-82b4c53552d6 If you wish to use a namespace defined outside of RFC 4122, using the namespace UUID is required because no corresponding keyword is available: -``` +```shell > uuidv5("743ac3c0-3bf7-4a5b-9e6c-59360447c757", "LIBS:diskfont.library") ede1a974-df7e-5f17-84b9-76208818b2c8 ``` diff --git a/website/pages/docs/from-1.5/variables.mdx b/website/pages/docs/from-1.5/variables.mdx index b443be475..6c99ad52f 100644 --- a/website/pages/docs/from-1.5/variables.mdx +++ b/website/pages/docs/from-1.5/variables.mdx @@ -280,7 +280,7 @@ precedence over earlier ones: ~> **Important:** Variables with map and object values behave the same way as other variables: the last value found overrides the previous values. -### A variable value must be known : +### A variable value must be known: Take the following variable for example: @@ -315,7 +315,7 @@ source "example" "foo" { In the above case, as long as "arg" is optional for an "example" source, there is no error and arg won’t be set. -### Setting an unknown variable will not always fail : +### Setting an unknown variable will not always fail: | Usage | packer validate | any other packer command | | :----------------------------: | :---------------------: | :-----------------------: | diff --git a/website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevices-not-required.mdx b/website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevices-not-required.mdx index bd94a50a1..5289cba08 100644 --- a/website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevices-not-required.mdx +++ b/website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevices-not-required.mdx @@ -6,9 +6,9 @@ - `disk_category` (string) - Category of the system disk. Optional values are: - `cloud` - general cloud disk - `cloud_efficiency` - efficiency cloud disk - `cloud_ssd` - cloud SSD - For phased-out instance types and non-I/O optimized instances, the - default value is cloud. Otherwise, the default value is - cloud\_efficiency. + For phased-out instance types and non-I/O optimized instances, the + default value is cloud. Otherwise, the default value is + cloud_efficiency. - `disk_description` (string) - The value of disk description is blank by default. \[2, 256\] characters. The disk description will appear on the diff --git a/website/scripts/changelog.md b/website/scripts/changelog.md index 5dbdf33b3..f230cb4cd 100644 --- a/website/scripts/changelog.md +++ b/website/scripts/changelog.md @@ -9,7 +9,19 @@ - `/docs/from-1.5/functions.html` -> `/docs/from-1.5/functions/index.html` - [BREAKING] `/docs/from-1.5/functions/collection/index.html` -> `/docs/from-1.5/functions/collection/index-fn.html` - `/docs/from-1.5/functions/*/overview.html` -> `/docs/from-1.5/functions/*/index.html` +- `/docs/builders/amazon-*` -> `/docs/builders/amazon/*` +- `/docs/builders/azure-*` -> `/docs/builders/azure/*` +- `/docs/builders/hyperv-*` -> `/docs/builders/hyperv/*` +- `/docs/builders/oracle-*` -> `/docs/builders/oracle/*` +- `/docs/builders/osc-*` -> `/docs/builders/outscale/*` +- `/docs/builders/outscale.html` -> `/docs/builders/outscale/index.html` +- `/docs/builders/parallels-*` -> `/docs/builders/parallels/*` +- `/docs/builders/virtualbox-*` -> `/docs/builders/virtualbox/*` +- `/docs/builders/vmware-*` -> `/docs/builders/vmware/*` +- `/docs/builders/vsphere-*` -> `/docs/builders/vmware/vsphere-*` -# problems: +# notes: - empty index files on all `from-1.5/functions/*` +- how do the generated docs work? can we keep it even with changes? +- should any of the other builders be nested under a subdirectory? like `alicloud-ecs`, `tencent-cvm` or `ucloud-uhost`?