run make fmt-doc

website/source/docs/builders/alicloud-ecs.html.md

@@ -76,26 +76,32 @@ builder.
 -   `image_description` (string) - The description of the image, with a length
     limit of 0 to 256 characters. Leaving it blank means null, which is the
     default value. It cannot begin with `http://` or `https://`.
-    
+
--   `system_disk_mapping` (image disk mapping) - Image disk mapping for system disk.
+-   `system_disk_mapping` (image disk mapping) - Image disk mapping for system
-    -   `disk_category` (string) - Category of the system disk. Optional values are:
+    disk.
+    -   `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.
+        For phased-out instance types and non-I/O optimized instances, the
-        Otherwise, the default value is cloud_efficiency.
+        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 console. It cannot begin with `http://` or `https://`.
+    -   `disk_description` (string) - The value of disk description is blank by
-            
+        default. \[2, 256\] characters. The disk description will appear on the
-    -   `disk_name` (string) - The value of disk name is blank by default. \[2, 128\]
+        console. It cannot begin with `http://` or `https://`.
-            English or Chinese characters, must begin with an uppercase/lowercase letter
+
-            or Chinese character. Can contain numbers, `.`, `_` and `-`. The disk name
+    -   `disk_name` (string) - The value of disk name is blank by default. \[2,
-            will appear on the console. It cannot begin with `http://` or `https://`.
+        128\] English or Chinese characters, must begin with an
-    
+        uppercase/lowercase letter or Chinese character. Can contain numbers,
-    -   `disk_size` (number) - Size of the system disk, measured in GiB. Value range: \[20, 500\]. The specified value 
+        `.`, `_` and `-`. The disk name will appear on the console. It cannot
-        must be equal to or greater than max{20, ImageSize}. Default value: max{40, ImageSize}.
+        begin with `http://` or `https://`.
+
+    -   `disk_size` (number) - Size of the system disk, measured in GiB. Value
+        range: \[20, 500\]. The specified value must be equal to or greater
+        than max{20, ImageSize}. Default value: max{40, ImageSize}.
 
 -   `image_disk_mappings` (array of image disk mappings) - Add one or more data
     disks to the image.
@@ -128,9 +134,9 @@ builder.
         begin with `http://` or `https://`.
 
     -   `disk_size` (number) - Size of the data disk, in GB, values range:
-        -   `cloud` - 5 ~ 2000
+        -   `cloud` - 5 \~ 2000
-        -   `cloud_efficiency` - 20 ~ 2048
+        -   `cloud_efficiency` - 20 \~ 2048
-        -   `cloud_ssd` - 20 ~ 2048
+        -   `cloud_ssd` - 20 \~ 2048
 
         The value should be equal to or greater than the size of the specific
         SnapshotId.
@@ -277,7 +283,7 @@ Here is a basic example for Alicloud.
 }
 ```
 
-~> Note: Images can become deprecated after a while; run
+\~> Note: Images can become deprecated after a while; run
 `aliyun ecs DescribeImages` to find one that exists.
 
 See the

website/source/docs/builders/amazon-ebs.html.md

@@ -198,11 +198,11 @@ builder.
 
 -   `enable_t2_unlimited` (boolean) - Enabling T2 Unlimited allows the source
     instance to burst additional CPU beyond its available \[CPU Credits\]
-    (<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html>)
+    (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html" class="uri">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html</a>)
     for as long as the demand exists. This is in contrast to the standard
     configuration that only allows an instance to consume up to its available
     CPU Credits. See the AWS documentation for \[T2 Unlimited\]
-    (<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html>)
+    (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html" class="uri">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html</a>)
     and the **T2 Unlimited Pricing** section of the [Amazon EC2 On-Demand
     Pricing](https://aws.amazon.com/ec2/pricing/on-demand/) document for more
     information. By default this option is disabled and Packer will set up a
@@ -242,8 +242,8 @@ builder.
     profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html)
     to launch the EC2 instance with.
 
--   `insecure_skip_tls_verify` (boolean) - This allows skipping TLS verification of
+-   `insecure_skip_tls_verify` (boolean) - This allows skipping TLS
-    the AWS EC2 endpoint. The default is `false`.
+    verification of the AWS EC2 endpoint. The default is `false`.
 
 -   `launch_block_device_mappings` (array of block device mappings) - Add one
     or more block devices before the Packer build starts. If you add instance

website/source/docs/builders/amazon-ebssurrogate.html.md

@@ -191,11 +191,11 @@ builder.
 
 -   `enable_t2_unlimited` (boolean) - Enabling T2 Unlimited allows the source
     instance to burst additional CPU beyond its available \[CPU Credits\]
-    (<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html>)
+    (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html" class="uri">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html</a>)
     for as long as the demand exists. This is in contrast to the standard
     configuration that only allows an instance to consume up to its available
     CPU Credits. See the AWS documentation for \[T2 Unlimited\]
-    (<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html>)
+    (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html" class="uri">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html</a>)
     and the **T2 Unlimited Pricing** section of the [Amazon EC2 On-Demand
     Pricing](https://aws.amazon.com/ec2/pricing/on-demand/) document for more
     information. By default this option is disabled and Packer will set up a
@@ -235,8 +235,8 @@ builder.
     profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html)
     to launch the EC2 instance with.
 
--   `insecure_skip_tls_verify` (boolean) - This allows skipping TLS verification of
+-   `insecure_skip_tls_verify` (boolean) - This allows skipping TLS
-    the AWS EC2 endpoint. The default is `false`.
+    verification of the AWS EC2 endpoint. The default is `false`.
 
 -   `launch_block_device_mappings` (array of block device mappings) - Add one
     or more block devices before the Packer build starts. If you add instance

website/source/docs/builders/amazon-ebsvolume.html.md

@@ -164,11 +164,11 @@ builder.
 
 -   `enable_t2_unlimited` (boolean) - Enabling T2 Unlimited allows the source
     instance to burst additional CPU beyond its available \[CPU Credits\]
-    (<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html>)
+    (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html" class="uri">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html</a>)
     for as long as the demand exists. This is in contrast to the standard
     configuration that only allows an instance to consume up to its available
     CPU Credits. See the AWS documentation for \[T2 Unlimited\]
-    (<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html>)
+    (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html" class="uri">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html</a>)
     and the 'T2 Unlimited Pricing' section of the [Amazon EC2 On-Demand
     Pricing](https://aws.amazon.com/ec2/pricing/on-demand/) document for more
     information. By default this option is disabled and Packer will set up a
@@ -189,8 +189,8 @@ builder.
     profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html)
     to launch the EC2 instance with.
 
--   `insecure_skip_tls_verify` (boolean) - This allows skipping TLS verification of
+-   `insecure_skip_tls_verify` (boolean) - This allows skipping TLS
-    the AWS EC2 endpoint. The default is `false`.
+    verification of the AWS EC2 endpoint. The default is `false`.
 
 -   `mfa_code` (string) - The MFA
     [TOTP](https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm)

website/source/docs/builders/amazon-instance.html.md

@@ -38,7 +38,7 @@ Tools](https://aws.amazon.com/developertools/368) are installed onto the
 machine. This can be done within a provisioner, but must be done before the
 builder finishes running.
 
-~> Instance builds are not supported for Windows. Use
+\~> Instance builds are not supported for Windows. Use
 [`amazon-ebs`](amazon-ebs.html) instead.
 
 ## Configuration Reference
@@ -214,11 +214,11 @@ builder.
 
 -   `enable_t2_unlimited` (boolean) - Enabling T2 Unlimited allows the source
     instance to burst additional CPU beyond its available \[CPU Credits\]
-    (<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html>)
+    (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html" class="uri">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html</a>)
     for as long as the demand exists. This is in contrast to the standard
     configuration that only allows an instance to consume up to its available
     CPU Credits. See the AWS documentation for \[T2 Unlimited\]
-    (<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html>)
+    (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html" class="uri">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html</a>)
     and the 'T2 Unlimited Pricing' section of the [Amazon EC2 On-Demand
     Pricing](https://aws.amazon.com/ec2/pricing/on-demand/) document for more
     information. By default this option is disabled and Packer will set up a
@@ -620,8 +620,8 @@ sudo -i -n ec2-bundle-vol \
 The available template variables should be self-explanatory based on the
 parameters they're used to satisfy the `ec2-bundle-vol` command.
 
-~&gt; **Warning!** Some versions of ec2-bundle-vol silently ignore all .pem and
+\~&gt; **Warning!** Some versions of ec2-bundle-vol silently ignore all .pem
-.gpg files during the bundling of the AMI, which can cause problems on some
+and .gpg files during the bundling of the AMI, which can cause problems on some
 systems, such as Ubuntu. You may want to customize the bundle volume command to
 include those files (see the `--no-filter` option of `ec2-bundle-vol`).
 

website/source/docs/builders/azure.html.md

@@ -147,14 +147,19 @@ Providing `temp_resource_group_name` or `location` in combination with
     `USGovernment`. Defaults to `Public`. Long forms such as
     `USGovernmentCloud` and `AzureUSGovernmentCloud` are also supported.
 
--   `custom_data_file` (string) Specify a file containing custom data to inject into the cloud-init process. The contents
+-   `custom_data_file` (string) Specify a file containing custom data to inject
-    of the file are read and injected into the ARM template. The custom data will be passed to
+    into the cloud-init process. The contents of the file are read and injected
-    cloud-init for processing at the time of provisioning. See [documentation](http://cloudinit.readthedocs.io/en/latest/topics/examples.html)
+    into the ARM template. The custom data will be passed to cloud-init for
-    to learn more about custom data, and how it can be used to influence the provisioning process.
+    processing at the time of provisioning. See
+    [documentation](http://cloudinit.readthedocs.io/en/latest/topics/examples.html)
+    to learn more about custom data, and how it can be used to influence the
+    provisioning process.
 
--   `custom_managed_image_name` (string) Specify the source managed image's name to use.  If this value is set, do not set
+-   `custom_managed_image_name` (string) Specify the source managed image's
-    image_publisher, image_offer, image_sku, or image_version. If this value is set, the value
+    name to use. If this value is set, do not set image\_publisher,
-    `custom_managed_image_resource_group_name` must also be set. See [documentation](https://docs.microsoft.com/en-us/azure/storage/storage-managed-disks-overview#images)
+    image\_offer, image\_sku, or image\_version. If this value is set, the
+    value `custom_managed_image_resource_group_name` must also be set. See
+    [documentation](https://docs.microsoft.com/en-us/azure/storage/storage-managed-disks-overview#images)
     to learn more about managed images.
 
 -   `custom_managed_image_resource_group_name` (string) Specify the source
@@ -245,7 +250,6 @@ Providing `temp_resource_group_name` or `location` in combination with
     type* - the target must be a *Managed Image*.
 
 <!-- -->
-
     "shared_image_gallery": {
         "subscription": "00000000-0000-0000-0000-00000000000",
         "resource_group": "ResourceGroup",
@@ -416,8 +420,8 @@ experience. These values can be changed by the user to more suitable values.
 
 ## Implementation
 
-~&gt; **Warning!** This is an advanced topic. You do not need to understand the
+\~&gt; **Warning!** This is an advanced topic. You do not need to understand
-implementation to use the Azure builder.
+the implementation to use the Azure builder.
 
 The Azure builder uses ARM
 [templates](https://azure.microsoft.com/en-us/documentation/articles/resource-group-authoring-templates/)

website/source/docs/builders/cloudstack.html.md

@@ -173,10 +173,10 @@ builder.
     `packer_<UUID>`, where &lt;UUID&gt; is a 36 character unique identifier.
 
 -   `user_data` (string) - User data to launch with the instance. This is a
-    [template engine](/docs/templates/engine.html) see _User Data_ bellow for more
+    [template engine](/docs/templates/engine.html) see *User Data* bellow for
-    details.
+    more details. Packer will not automatically wait for a user script to
-    Packer will not automatically wait for a user script to finish before
+    finish before shutting down the instance this must be handled in a
-    shutting down the instance this must be handled in a provisioner.
+    provisioner.
 
 -   `user_data_file` (string) - Path to a file that will be used for the user
     data when launching the instance. This file will be parsed as a [template

website/source/docs/builders/digitalocean.html.md

@@ -41,18 +41,18 @@ builder.
 
 -   `image` (string) - The name (or slug) of the base image to use. This is the
     image that will be used to launch a new droplet and provision it. See
-    <https://developers.digitalocean.com/documentation/v2/#list-all-images> for
+    <a href="https://developers.digitalocean.com/documentation/v2/#list-all-images" class="uri">https://developers.digitalocean.com/documentation/v2/#list-all-images</a>
-    details on how to get a list of the accepted image names/slugs.
+    for details on how to get a list of the accepted image names/slugs.
 
 -   `region` (string) - The name (or slug) of the region to launch the droplet
     in. Consequently, this is the region where the snapshot will be available.
     See
-    <https://developers.digitalocean.com/documentation/v2/#list-all-regions>
+    <a href="https://developers.digitalocean.com/documentation/v2/#list-all-regions" class="uri">https://developers.digitalocean.com/documentation/v2/#list-all-regions</a>
     for the accepted region names/slugs.
 
 -   `size` (string) - The name (or slug) of the droplet size to use. See
-    <https://developers.digitalocean.com/documentation/v2/#list-all-sizes> for
+    <a href="https://developers.digitalocean.com/documentation/v2/#list-all-sizes" class="uri">https://developers.digitalocean.com/documentation/v2/#list-all-sizes</a>
-    the accepted size names/slugs.
+    for the accepted size names/slugs.
 
 ### Optional:
 
@@ -83,9 +83,9 @@ builder.
     droplet to enter a desired state (such as "active") before timing out. The
     default state timeout is "6m".
 
--   `user_data` (string) - User data to launch with the Droplet.
+-   `user_data` (string) - User data to launch with the Droplet. Packer will
-    Packer will not automatically wait for a user script to finish before
+    not automatically wait for a user script to finish before shutting down the
-    shutting down the instance this must be handled in a provisioner.
+    instance this must be handled in a provisioner.
 
 -   `user_data_file` (string) - Path to a file that will be used for the user
     data when launching the Droplet.

website/source/docs/builders/hetzner-cloud.html.md

@@ -62,9 +62,9 @@ builder.
     polled by the client. Default `500ms`. Increase this interval if you run
     into rate limiting errors.
 
--   `user_data` (string) - User data to launch with the server.
+-   `user_data` (string) - User data to launch with the server. Packer will not
-    Packer will not automatically wait for a user script to finish before
+    automatically wait for a user script to finish before shutting down the
-    shutting down the instance this must be handled in a provisioner.
+    instance this must be handled in a provisioner.
 
 -   `user_data_file` (string) - Path to a file that will be used for the user
     data when launching the server.

website/source/docs/builders/openstack.html.md

@@ -25,10 +25,10 @@ created. This simplifies configuration quite a bit.
 The builder does *not* manage images. Once it creates an image, it is up to you
 to use it or delete it.
 
-~> **Note:** To use OpenStack builder with the OpenStack Newton (Oct 2016)
+\~> **Note:** To use OpenStack builder with the OpenStack Newton (Oct 2016)
 or earlier, we recommend you use Packer v1.1.2 or earlier version.
 
-~> **OpenStack Liberty or later requires OpenSSL!** To use the OpenStack
+\~> **OpenStack Liberty or later requires OpenSSL!** To use the OpenStack
 builder with OpenStack Liberty (Oct 2015) or later you need to have OpenSSL
 installed *if you are using temporary key pairs*, i.e. don't use
 [`ssh_keypair_name`](openstack.html#ssh_keypair_name) nor
@@ -36,8 +36,9 @@ installed *if you are using temporary key pairs*, i.e. don't use
 OS'es have OpenSSL installed by default except Windows. This have been resolved
 in OpenStack Ocata(Feb 2017).
 
-~> **Note:** OpenStack Block Storage volume support is available only for V3
+\~> **Note:** OpenStack Block Storage volume support is available only for
-Block Storage API. It's available in OpenStack since Mitaka release (Apr 2016).
+V3 Block Storage API. It's available in OpenStack since Mitaka release (Apr
+2016).
 
 ## Configuration Reference
 
@@ -406,7 +407,7 @@ variable `OS_REGION_NAME` or `OS_REGION_ID` and
 `export OS_TENANT_NAME=$OS_PROJECT_NAME` or
 `export OS_TENANT_ID=$OS_PROJECT_ID`.
 
-~> `OS_TENANT_NAME` or `OS_TENANT_ID` must be used even with Identity v3,
+\~> `OS_TENANT_NAME` or `OS_TENANT_ID` must be used even with Identity v3,
 `OS_PROJECT_NAME` and `OS_PROJECT_ID` has no effect in Packer.
 
 To troubleshoot authorization issues test you environment variables with the

website/source/docs/builders/oracle-oci.html.md

@@ -133,16 +133,22 @@ builder.
     key/value pairs provided in the configuration. While this can be used to
     set metadata\["user\_data"\] the explicit "user\_data" and
     "user\_data\_file" values will have precedence. An instance's metadata can
-    be obtained from at <http://169.254.169.254> on the launched instance.
+    be obtained from at
+    <a href="http://169.254.169.254" class="uri">http://169.254.169.254</a> on
+    the launched instance.
 
- - `user_data` (string) - User data to be used by cloud-init. See [the Oracle docs](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/LaunchInstanceDetails) for more details. Generally speaking, it is easier to use the `user_data_file`,
+-   `user_data` (string) - User data to be used by cloud-init. See [the Oracle
-   but you can use this option to put either the plaintext data or the base64
+    docs](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/LaunchInstanceDetails)
-   encoded data directly into your Packer config.
+    for more details. Generally speaking, it is easier to use the
-   Packer will not automatically wait for a user script to finish before
+    `user_data_file`, but you can use this option to put either the plaintext
-   shutting down the instance this must be handled in a provisioner.
+    data or the base64 encoded data directly into your Packer config. Packer
+    will not automatically wait for a user script to finish before shutting
+    down the instance this must be handled in a provisioner.
 
- - `user_data_file` (string) - Path to a file to be used as user data by cloud-init. See [the Oracle docs](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/LaunchInstanceDetails) for more details. Example:
+-   `user_data_file` (string) - Path to a file to be used as user data by
-   `"user_data_file": "./boot_config/myscript.sh"`
+    cloud-init. See [the Oracle
+    docs](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/LaunchInstanceDetails)
+    for more details. Example: `"user_data_file": "./boot_config/myscript.sh"`
 
 -   `tags` (map of strings) - Add one or more freeform tags to the resulting
     custom image. See [the Oracle