From f86801abc69ddff12eb9ed9739ccbacc35d5395d Mon Sep 17 00:00:00 2001 From: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> Date: Wed, 29 Jan 2025 08:33:36 -0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com> --- .../hcl_templates/blocks/build/hcp_packer_registry.mdx | 2 +- .../templates/hcl_templates/blocks/build/post-processors.mdx | 2 +- website/content/docs/templates/hcl_templates/index.mdx | 2 +- website/content/docs/templates/hcl_templates/syntax.mdx | 2 +- website/content/docs/templates/hcl_templates/variables.mdx | 2 +- website/content/docs/templates/index.mdx | 2 +- website/content/docs/templates/json_to_hcl.mdx | 2 +- .../content/docs/templates/legacy_json_templates/engine.mdx | 4 ++-- .../docs/templates/legacy_json_templates/post-processors.mdx | 2 +- .../docs/templates/legacy_json_templates/provisioners.mdx | 4 ++-- .../docs/templates/legacy_json_templates/user-variables.mdx | 4 ++-- 11 files changed, 14 insertions(+), 14 deletions(-) diff --git a/website/content/docs/templates/hcl_templates/blocks/build/hcp_packer_registry.mdx b/website/content/docs/templates/hcl_templates/blocks/build/hcp_packer_registry.mdx index 7d208ab6b..5b6fac37c 100644 --- a/website/content/docs/templates/hcl_templates/blocks/build/hcp_packer_registry.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/build/hcp_packer_registry.mdx @@ -1,6 +1,6 @@ --- description: > - The `hcp_packer_registry` block configures details new or updated images in the HCP Packer registry. Learn how to configure the `hcp_packer_registry` block. + The `hcp_packer_registry` block specifies details for new or updated images in the HCP Packer registry. Learn how to configure the `hcp_packer_registry` block. page_title: hcp_packer_registry block reference --- diff --git a/website/content/docs/templates/hcl_templates/blocks/build/post-processors.mdx b/website/content/docs/templates/hcl_templates/blocks/build/post-processors.mdx index 9ec491b3b..23b4f7fc8 100644 --- a/website/content/docs/templates/hcl_templates/blocks/build/post-processors.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/build/post-processors.mdx @@ -10,7 +10,7 @@ This topic provides reference information about the `post-processors` block. ## Description -Add a `post-processors` block to your `build` block to include a list of [post-processor](/packer/docs/templates/hcl_templates/blocks/build/post-processor) configurations. Packer runs the post-processors for the artifact of each build. +Add a `post-processors` block to your `build` block to include a list of [post-processor](/packer/docs/templates/hcl_templates/blocks/build/post-processor) configurations. Packer runs the post-processors for an artifact after each build. ```hcl # builds.pkr.hcl diff --git a/website/content/docs/templates/hcl_templates/index.mdx b/website/content/docs/templates/hcl_templates/index.mdx index 97f2b164b..0bffa7622 100644 --- a/website/content/docs/templates/hcl_templates/index.mdx +++ b/website/content/docs/templates/hcl_templates/index.mdx @@ -6,7 +6,7 @@ description: |- # HCL templates overview -This topic provides overview information about HashiCorp configuration language (HCL) template for Packer. +This topic provides overview information about HashiCorp configuration language (HCL) templates for Packer. ## Introduction diff --git a/website/content/docs/templates/hcl_templates/syntax.mdx b/website/content/docs/templates/hcl_templates/syntax.mdx index 607910419..3cea5da64 100644 --- a/website/content/docs/templates/hcl_templates/syntax.mdx +++ b/website/content/docs/templates/hcl_templates/syntax.mdx @@ -1,7 +1,7 @@ --- page_title: HCL syntax reference description: |- - The HCL syntax combines declarative structure with expressions into Packer templates. Learn about the HCL syntax for defining infrastructure as code. + HCL syntax combines declarative structure with expressions into Packer templates. Learn how to use HCL syntax to define infrastructure as code. --- # HCL syntax reference diff --git a/website/content/docs/templates/hcl_templates/variables.mdx b/website/content/docs/templates/hcl_templates/variables.mdx index a52388779..169d9ed81 100644 --- a/website/content/docs/templates/hcl_templates/variables.mdx +++ b/website/content/docs/templates/hcl_templates/variables.mdx @@ -11,7 +11,7 @@ This topic provides reference information about input variables in Packer templa ## Introduction -Input variables, sometimes referred to as _variables_ or _Packer variables_, are as parameters for a Packer build. They let you customize aspects of the build without altering the build's own source code. Some input variables have default values that you can override using command line options, environment variables, or variable definitions files. You cannot change the value of an input variable after the initial override. +Input variables, sometimes referred to as variables or Packer variables, are the parameters for a Packer build. Input variables let you customize aspects of a build without altering the build's own source code. Some input variables have default values that you can override using command line options, environment variables, or variable definitions files. You cannot change the value of an input variable after the initial override. Refer to [Input Variables and local variables](/packer/guides/hcl/variables) for additional information. diff --git a/website/content/docs/templates/index.mdx b/website/content/docs/templates/index.mdx index 2f3e23144..1eda88844 100644 --- a/website/content/docs/templates/index.mdx +++ b/website/content/docs/templates/index.mdx @@ -23,4 +23,4 @@ functions to help you customize your builds. Packer supports templates written in [HCL2](/packer/docs/templates/hcl_templates) or [JSON](/packer/docs/templates/legacy_json_templates). Since v1.7.0, HCL2 is the official format for Packer configurations. -HCL2 is also the configuration language used in configurations for Terraform other HashiCorp products. It is more flexible, modular, and concise than the JSON template format. Refer to [Upgrade Packer JSON template to HCL2](/packer/tutorials/configuration-language/hcl2-upgrade) for a tutorial on upgrading JSON templates to HCL templates. +HCL2 is also the configuration language used in configurations for other HashiCorp products, such as Terraform. HCL is more flexible, modular, and concise than the JSON template format. Refer to [Upgrade Packer JSON template to HCL2](/packer/tutorials/configuration-language/hcl2-upgrade) for a tutorial on upgrading JSON templates to HCL templates. diff --git a/website/content/docs/templates/json_to_hcl.mdx b/website/content/docs/templates/json_to_hcl.mdx index 77feb1986..f6ff56531 100644 --- a/website/content/docs/templates/json_to_hcl.mdx +++ b/website/content/docs/templates/json_to_hcl.mdx @@ -12,7 +12,7 @@ This document explains the differences between JSON to HCL2 templates, including Packer uses JSON or HCL2 templates to orchestrate builds for one or more artifacts. -In [legacy JSON templates](/packer/docs/templates/legacy_json_templates), declare a series of builders, provisioners and post-processors to build images. +In [legacy JSON templates](/packer/docs/templates/legacy_json_templates), declare a series of builders, provisioners, and post-processors to build images. In [HCL2 templates](/packer/docs/templates/hcl_templates), you can specify builders through sources and collect them into build blocks. diff --git a/website/content/docs/templates/legacy_json_templates/engine.mdx b/website/content/docs/templates/legacy_json_templates/engine.mdx index 20c16ea67..90c31813a 100644 --- a/website/content/docs/templates/legacy_json_templates/engine.mdx +++ b/website/content/docs/templates/legacy_json_templates/engine.mdx @@ -1,12 +1,12 @@ --- description: | - The JSON template engine procsses strings in JSON templates. Learn how to use JSON template engine functions and variables. + The JSON template engine processes strings in JSON templates. Learn how to use JSON template engine functions and variables. page_title: JSON template engine reference --- # JSON template engine reference -This topic describe the Packer engine that processes JSON templates. +This topic describes the Packer engine that processes JSON templates. `@include 'from-1.5/legacy-json-warning.mdx'` diff --git a/website/content/docs/templates/legacy_json_templates/post-processors.mdx b/website/content/docs/templates/legacy_json_templates/post-processors.mdx index 72c5e1a31..42645e4a4 100644 --- a/website/content/docs/templates/legacy_json_templates/post-processors.mdx +++ b/website/content/docs/templates/legacy_json_templates/post-processors.mdx @@ -1,6 +1,6 @@ --- description: | - The `post-processor` block defines actions to perform on the images after they are built. Learn how to configure the `post-processor` block in JSON templates. + The `post-processor` block defines actions to perform on images after Packer builds them. Learn how to configure the `post-processor` block in JSON templates. page_title: post-processors reference for JSON templates --- diff --git a/website/content/docs/templates/legacy_json_templates/provisioners.mdx b/website/content/docs/templates/legacy_json_templates/provisioners.mdx index 207790dd9..4374e5288 100644 --- a/website/content/docs/templates/legacy_json_templates/provisioners.mdx +++ b/website/content/docs/templates/legacy_json_templates/provisioners.mdx @@ -1,6 +1,6 @@ --- description: | - The `provisioners` block contains provisioners that Packer should use to install and configure software on machines. Learn how to configure provisioners in JSON templates. + The `provisioners` block contains provisioners that Packer uses to install and configure software on machines. Learn how to configure provisioners in JSON templates. page_title: provisioners reference for JSON templates --- @@ -12,7 +12,7 @@ This topic provides reference information about the `provisioners` block in JSON ## Description -The `provisioners` block contains provisioners that Packer should use to install and configure software within running machines prior to turning them into machine images. +The `provisioners` block contains provisioners that Packer uses to install and configure software within running machines prior to turning them into machine images. Provisioners are optional. When you omit the `provisioners` block, Packer installs only the default software within the resulting machine images. diff --git a/website/content/docs/templates/legacy_json_templates/user-variables.mdx b/website/content/docs/templates/legacy_json_templates/user-variables.mdx index 9f0396c1d..bb809bb20 100644 --- a/website/content/docs/templates/legacy_json_templates/user-variables.mdx +++ b/website/content/docs/templates/legacy_json_templates/user-variables.mdx @@ -1,6 +1,6 @@ --- description: | - The `variables` block contains parameterizd values for your templates. Learn how configure `variables` to improve security, portability, and shareability of the template. +The `variables` block contains parameterized values for your templates. Learn how to configure `variables` to improve a template's security, portability, and shareability. page_title: variables reference for JSON templates --- @@ -12,7 +12,7 @@ This topic describes how to use user variables in Packer templates written in JS ## Description -The `variables` block ets your templates to be further configured with variables +The `variables` block lets you further configure a template with variables from the command-line, environment variables, Vault, or files. This lets you parameterize your templates so that you can keep secret tokens, environment-specific data, and other types of information out of your