diff --git a/website/content/docs/builders/amazon/chroot.mdx b/website/content/docs/builders/amazon/chroot.mdx index 36ff56e24..373e9727c 100644 --- a/website/content/docs/builders/amazon/chroot.mdx +++ b/website/content/docs/builders/amazon/chroot.mdx @@ -142,7 +142,7 @@ Here is a basic example. It is completely valid except for the access keys: // set the environment variables to have the same name as the declared // variables, with the prefix PKR_VAR_. -// There are other ways to [set variables](//docs/templates/hcl_templates/variables#assigning-values-to-build-variables), including from a var +// There are other ways to [set variables](/docs/templates/hcl_templates/variables#assigning-values-to-build-variables), including from a var // file or as a command argument. // export PKR_VAR_aws_access_key=$YOURKEY @@ -514,7 +514,7 @@ variables are available: ## Build Shared Information Variables -This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](//docs/templates/hcl_templates/contextual-variables) for HCL2. +This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. The generated variables available for this builder are: diff --git a/website/content/docs/builders/amazon/ebs.mdx b/website/content/docs/builders/amazon/ebs.mdx index 46178f3f3..e54647154 100644 --- a/website/content/docs/builders/amazon/ebs.mdx +++ b/website/content/docs/builders/amazon/ebs.mdx @@ -158,7 +158,7 @@ run: // set the environment variables to have the same name as the declared // variables, with the prefix PKR_VAR_. -// There are other ways to [set variables](//docs/templates/hcl_templates/variables#assigning-values-to-build-variables) +// There are other ways to [set variables](/docs/templates/hcl_templates/variables#assigning-values-to-build-variables) // including from a var file or as a command argument. // export PKR_VAR_aws_access_key=$YOURKEY @@ -323,7 +323,7 @@ variables are available: ## Build Shared Information Variables -This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](//docs/templates/hcl_templates/contextual-variables) for HCL2. +This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. The generated variables available for this builder are: diff --git a/website/content/docs/builders/amazon/ebssurrogate.mdx b/website/content/docs/builders/amazon/ebssurrogate.mdx index e8dd005b6..b17aca88d 100644 --- a/website/content/docs/builders/amazon/ebssurrogate.mdx +++ b/website/content/docs/builders/amazon/ebssurrogate.mdx @@ -227,7 +227,7 @@ variables are available: ## Build Shared Information Variables -This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](//docs/templates/hcl_templates/contextual-variables) for HCL2. +This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. The generated variables available for this builder are: diff --git a/website/content/docs/builders/amazon/ebsvolume.mdx b/website/content/docs/builders/amazon/ebsvolume.mdx index 45ac05dae..6eba6a866 100644 --- a/website/content/docs/builders/amazon/ebsvolume.mdx +++ b/website/content/docs/builders/amazon/ebsvolume.mdx @@ -258,7 +258,7 @@ variables are available: ## Build Shared Information Variables -This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](//docs/templates/hcl_templates/contextual-variables) for HCL2. +This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. The generated variables available for this builder are: @@ -281,7 +281,7 @@ marked for deletion on termination will remain in your account. ## Build Shared Information Variables -This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](//docs/templates/hcl_templates/contextual-variables) for HCL2. +This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. The generated variables available for this builder are: diff --git a/website/content/docs/builders/amazon/instance.mdx b/website/content/docs/builders/amazon/instance.mdx index 65f851b13..876c0cf75 100644 --- a/website/content/docs/builders/amazon/instance.mdx +++ b/website/content/docs/builders/amazon/instance.mdx @@ -220,7 +220,7 @@ variables are available: ## Build Shared Information Variables -This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](//docs/templates/hcl_templates/contextual-variables) for HCL2. +This builder generates data that are shared with provisioner and post-processor via build function of [template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. The generated variables available for this builder are: diff --git a/website/content/docs/builders/docker.mdx b/website/content/docs/builders/docker.mdx index 65a599ada..b29b93c2a 100644 --- a/website/content/docs/builders/docker.mdx +++ b/website/content/docs/builders/docker.mdx @@ -217,7 +217,7 @@ You must specify (only) one of `commit`, `discard`, or `export_path`. ## Build Shared Information Variables This build shares generated data with provisioners and post-processors via [template engines](/docs/templates/engine) -for JSON and [contextual variables](//docs/templates/hcl_templates/contextual-variables) for HCL2. +for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. The generated variable available for this builder is: diff --git a/website/content/docs/builders/yandex.mdx b/website/content/docs/builders/yandex.mdx index cefaee004..ae427de3f 100644 --- a/website/content/docs/builders/yandex.mdx +++ b/website/content/docs/builders/yandex.mdx @@ -132,7 +132,7 @@ In configuration directives the following variables are available: ## Build Shared Information Variables This builder generates data that are shared with provisioner and post-processor via build function of -[template engine](/docs/templates/engine) for JSON and [contextual variables](//docs/templates/hcl_templates/contextual-variables) +[template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. The generated variables available for this builder see above diff --git a/website/content/docs/commands/console.mdx b/website/content/docs/commands/console.mdx index e91ce4d85..779170460 100644 --- a/website/content/docs/commands/console.mdx +++ b/website/content/docs/commands/console.mdx @@ -117,7 +117,7 @@ $ echo {{timestamp}} | packer console templating ( or `{{..}}` calls ) will not work in HCL2 mode. Without a config file, `packer console` can be used to experiment with the -expression syntax and [built-in functions](//docs/templates/hcl_templates/functions). +expression syntax and [built-in functions](/docs/templates/hcl_templates/functions). ### Starting diff --git a/website/content/docs/post-processors/vagrant.mdx b/website/content/docs/post-processors/vagrant.mdx index 375b854e1..7192dafd0 100644 --- a/website/content/docs/post-processors/vagrant.mdx +++ b/website/content/docs/post-processors/vagrant.mdx @@ -102,7 +102,7 @@ more details about certain options in following sections. - `vagrantfile_template` (string) - Path to a template to use for the Vagrantfile that is packaged with the box. This option supports the usage of the [template engine](/docs/templates/engine) - for JSON and the [contextual variables](//docs/templates/hcl_templates/contextual-variables) for HCL2. + for JSON and the [contextual variables](/docs/templates/hcl_templates/contextual-variables) for HCL2. - `vagrantfile_template_generated` (boolean) - By default, Packer will exit with an error if the file specified using the diff --git a/website/content/docs/templates/hcl_templates/blocks/build/index.mdx b/website/content/docs/templates/hcl_templates/blocks/build/index.mdx index 21daf1d46..b6d042320 100644 --- a/website/content/docs/templates/hcl_templates/blocks/build/index.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/build/index.mdx @@ -16,12 +16,12 @@ To use builders in a `build` block you can either: - Set the `sources` array of string with references to pre-defined sources. -- Define [build-level `source` blocks](//docs/templates/hcl_templates/blocks/build/source). +- Define [build-level `source` blocks](/docs/templates/hcl_templates/blocks/build/source). This also allows you to set specific fields. `@include 'from-1.5/builds/example-block.mdx'` -Define [top-level `source` blocks](//docs/templates/hcl_templates/blocks/source) to configure +Define [top-level `source` blocks](/docs/templates/hcl_templates/blocks/source) to configure your builders. The list of available builders can be found in the [builders](/docs/builders) section. diff --git a/website/content/docs/templates/hcl_templates/blocks/build/post-processor.mdx b/website/content/docs/templates/hcl_templates/blocks/build/post-processor.mdx index 78b155ca8..0ac71453e 100644 --- a/website/content/docs/templates/hcl_templates/blocks/build/post-processor.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/build/post-processor.mdx @@ -32,7 +32,7 @@ can be found in the [post-processors](/docs/post-processors) section. A `post-processor` can also take the `Artifact` from another post-processor when it is defined in a [`post-processors` -block](//docs/templates/hcl_templates/blocks/build/post-processor) list, that is a list of +block](/docs/templates/hcl_templates/blocks/build/post-processor) list, that is a list of chained post processors. -> Note: The input 'artifact' received by a post-processor will be automatically @@ -84,11 +84,11 @@ The values within `only` or `except` are _source names_, not builder types. Packer allows to access connection information and basic instance state information from a post-processor. These information are stored in the `build` variable. Check out the [Contextual -Variables](//docs/templates/hcl_templates/contextual-variables) documentation to learn more +Variables](/docs/templates/hcl_templates/contextual-variables) documentation to learn more about and see some examples of how to use them. ### Related -- The [`post-processors` block](//docs/templates/hcl_templates/blocks/build/post-processor) +- The [`post-processors` block](/docs/templates/hcl_templates/blocks/build/post-processor) allows to define one or more chain of `post-processor`s that will take the output from the build and provision steps. 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 a3a9d8e4a..60e3491e4 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 @@ -11,7 +11,7 @@ sidebar_title: post-processors `@include 'from-1.5/beta-hcl2-note.mdx'` The `post-processors` block allows to define lists of -[`post-processor`s](//docs/templates/hcl_templates/blocks/build/post-processor), that will run +[`post-processor`s](/docs/templates/hcl_templates/blocks/build/post-processor), that will run from the artifact of each build. ```hcl @@ -34,7 +34,7 @@ build { } ``` -The [`post-processor` block](//docs/templates/hcl_templates/blocks/build/post-processor) +The [`post-processor` block](/docs/templates/hcl_templates/blocks/build/post-processor) allows to define multiple post-processors that will run from the `Artifact` of each build. Read the `post-processor` documentation to know how to use a post-processor. diff --git a/website/content/docs/templates/hcl_templates/blocks/build/provisioner.mdx b/website/content/docs/templates/hcl_templates/blocks/build/provisioner.mdx index 4e12415dc..89e749b40 100644 --- a/website/content/docs/templates/hcl_templates/blocks/build/provisioner.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/build/provisioner.mdx @@ -161,4 +161,4 @@ Timeout has no effect in debug mode. ## Build Contextual Variables Packer allows to access connection information and basic instance state information from a provisioner. These information are stored in the `build` variable. -Check out the [Contextual Variables](//docs/templates/hcl_templates/contextual-variables) documentation to learn more about and see some examples of how to use them. +Check out the [Contextual Variables](/docs/templates/hcl_templates/contextual-variables) documentation to learn more about and see some examples of how to use them. diff --git a/website/content/docs/templates/hcl_templates/blocks/index.mdx b/website/content/docs/templates/hcl_templates/blocks/index.mdx index 012289118..ddd9bc245 100644 --- a/website/content/docs/templates/hcl_templates/blocks/index.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/index.mdx @@ -44,16 +44,16 @@ list of all of the available built-in HCL2 blocks. `@include 'from-1.5/variables/foo-block.mdx'` -- [Variable block documentation](//docs/templates/hcl_templates/blocks/variable). +- [Variable block documentation](/docs/templates/hcl_templates/blocks/variable). `@include 'from-1.5/locals/example-block.mdx'` -- [Locals block documentation](//docs/templates/hcl_templates/blocks/locals). +- [Locals block documentation](/docs/templates/hcl_templates/blocks/locals). `@include 'from-1.5/sources/example-block.mdx'` -- [source block documentation](//docs/templates/hcl_templates/blocks/source). +- [source block documentation](/docs/templates/hcl_templates/blocks/source). `@include 'from-1.5/builds/example-block.mdx'` -- [build block documentation](//docs/templates/hcl_templates/blocks/build). +- [build block documentation](/docs/templates/hcl_templates/blocks/build). diff --git a/website/content/docs/templates/hcl_templates/blocks/locals.mdx b/website/content/docs/templates/hcl_templates/blocks/locals.mdx index 395654c66..fbe027dec 100644 --- a/website/content/docs/templates/hcl_templates/blocks/locals.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/locals.mdx @@ -17,6 +17,6 @@ your Packer configuration. # More on variables -- Read the [full locals](//docs/templates/hcl_templates/locals) description for a more +- Read the [full locals](/docs/templates/hcl_templates/locals) description for a more thorough read. - Read the [variables guide](/guides/hcl/variables) for more examples. diff --git a/website/content/docs/templates/hcl_templates/blocks/packer.mdx b/website/content/docs/templates/hcl_templates/blocks/packer.mdx index f025a5b53..5dbcdec30 100644 --- a/website/content/docs/templates/hcl_templates/blocks/packer.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/packer.mdx @@ -62,7 +62,7 @@ other dependency management systems like Bundler and NPM. required_version = ">= 1.2.0, < 2.0.0" ``` -A version constraint is a [string literal](//docs/templates/hcl_templates/expressions#string-literals) +A version constraint is a [string literal](/docs/templates/hcl_templates/expressions#string-literals) containing one or more conditions, which are separated by commas. Each condition consists of an operator and a version number. diff --git a/website/content/docs/templates/hcl_templates/blocks/source.mdx b/website/content/docs/templates/hcl_templates/blocks/source.mdx index b5bb4d7d8..1f91da94c 100644 --- a/website/content/docs/templates/hcl_templates/blocks/source.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/source.mdx @@ -14,7 +14,7 @@ The top-level `source` block defines reusable builder configuration blocks: `@include 'from-1.5/sources/example-block.mdx'` You can start builders by refering to those source blocks form a [`build` -block](//docs/templates/hcl_templates/blocks/build), for example : +block](/docs/templates/hcl_templates/blocks/build), for example : ```hcl build { @@ -26,7 +26,7 @@ build { } ``` -The build-level [`source` block](//docs/templates/hcl_templates/blocks/build/source) allows to +The build-level [`source` block](/docs/templates/hcl_templates/blocks/build/source) allows to set specific source fields. ```hcl diff --git a/website/content/docs/templates/hcl_templates/blocks/variable.mdx b/website/content/docs/templates/hcl_templates/blocks/variable.mdx index a53e9aec3..946637c05 100644 --- a/website/content/docs/templates/hcl_templates/blocks/variable.mdx +++ b/website/content/docs/templates/hcl_templates/blocks/variable.mdx @@ -12,7 +12,7 @@ sidebar_title: variable The `variable` block, also called the `input-variable` block, defines variables within your Packer configuration. An input-variable cannot be used in another -input variable: we recommend using [locals](//docs/templates/hcl_templates/blocks/locals) for that instead. +input variable: we recommend using [locals](/docs/templates/hcl_templates/blocks/locals) for that instead. `@include 'from-1.5/variables/foo-block.mdx'` diff --git a/website/content/docs/templates/hcl_templates/contextual-variables.mdx b/website/content/docs/templates/hcl_templates/contextual-variables.mdx index 81053cf11..1bc7152c9 100644 --- a/website/content/docs/templates/hcl_templates/contextual-variables.mdx +++ b/website/content/docs/templates/hcl_templates/contextual-variables.mdx @@ -67,8 +67,8 @@ Here is the list of available build variables: For backwards compatibility, `WinRMPassword` is also available through this engine, though it is no different than using the more general `Password`. -All build variables are valid to use with any of the [HCL2 functions](//docs/templates/hcl_templates/functions). -Example of using [upper](//docs/templates/hcl_templates/functions/string/upper) to upper case the build ID: +All build variables are valid to use with any of the [HCL2 functions](/docs/templates/hcl_templates/functions). +Example of using [upper](/docs/templates/hcl_templates/functions/string/upper) to upper case the build ID: ```hcl post-processor "shell-local" { diff --git a/website/content/docs/templates/hcl_templates/expressions.mdx b/website/content/docs/templates/hcl_templates/expressions.mdx index 3d24442d1..9156397d3 100644 --- a/website/content/docs/templates/hcl_templates/expressions.mdx +++ b/website/content/docs/templates/hcl_templates/expressions.mdx @@ -124,7 +124,7 @@ types described above: Key/value pairs can be separated by either a comma or a line break. Values can be arbitrary expressions. Keys are strings; they can be left unquoted if - they are a valid [identifier](//docs/templates/hcl_templates/syntax#identifiers), but must be quoted + they are a valid [identifier](/docs/templates/hcl_templates/syntax#identifiers), but must be quoted otherwise. You can use a non-literal expression as a key by wrapping it in parentheses, like `(var.business_unit_tag_name) = "SRE"`. @@ -135,7 +135,7 @@ Packer makes one named values available. The following named values are available: - `source..` is an object representing a - [source](//docs/templates/hcl_templates/blocks/source) of the given type + [source](/docs/templates/hcl_templates/blocks/source) of the given type and name. ### Available Functions diff --git a/website/content/docs/templates/hcl_templates/functions/collection/coalesce.mdx b/website/content/docs/templates/hcl_templates/functions/collection/coalesce.mdx index 7f199e7e5..a32c6d62d 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/coalesce.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/coalesce.mdx @@ -32,5 +32,5 @@ b ## Related Functions -- [`coalescelist`](//docs/templates/hcl_templates/functions/collection/coalescelist) performs a similar operation with +- [`coalescelist`](/docs/templates/hcl_templates/functions/collection/coalescelist) performs a similar operation with list arguments rather than individual arguments. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/coalescelist.mdx b/website/content/docs/templates/hcl_templates/functions/collection/coalescelist.mdx index a24e2bd35..d849889e4 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/coalescelist.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/coalescelist.mdx @@ -39,5 +39,5 @@ symbol to expand the outer list as arguments: ## Related Functions -- [`coalesce`](//docs/templates/hcl_templates/functions/collection/coalesce) performs a similar operation with string +- [`coalesce`](/docs/templates/hcl_templates/functions/collection/coalesce) performs a similar operation with string arguments rather than list arguments. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/element.mdx b/website/content/docs/templates/hcl_templates/functions/collection/element.mdx index 5d0e180d5..e9ebe4030 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/element.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/element.mdx @@ -35,5 +35,5 @@ a ## Related Functions -- [`index`](//docs/templates/hcl_templates/functions/collection/index-fn) finds the index for a particular element value. -- [`lookup`](//docs/templates/hcl_templates/functions/collection/lookup) retrieves a value from a _map_ given its _key_. +- [`index`](/docs/templates/hcl_templates/functions/collection/index-fn) finds the index for a particular element value. +- [`lookup`](/docs/templates/hcl_templates/functions/collection/lookup) retrieves a value from a _map_ given its _key_. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/flatten.mdx b/website/content/docs/templates/hcl_templates/functions/collection/flatten.mdx index 19d276f54..4192ee993 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/flatten.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/flatten.mdx @@ -31,7 +31,7 @@ Indirectly-nested lists, such as those in maps, are _not_ flattened. The [resource `for_each`](https://www.terraform.io/docs/configuration/resources.html#for_each-multiple-resource-instances-defined-by-a-map-or-set-of-strings) and -[`dynamic` block](//docs/templates/hcl_templates/expressions#dynamic-blocks) +[`dynamic` block](/docs/templates/hcl_templates/expressions#dynamic-blocks) language features both require a collection value that has one element for each repetition. @@ -104,6 +104,6 @@ the associations between the subnets and their containing networks. ## Related Functions -- [`setproduct`](//docs/templates/hcl_templates/functions/collection/setproduct) finds all of the combinations of multiple +- [`setproduct`](/docs/templates/hcl_templates/functions/collection/setproduct) finds all of the combinations of multiple lists or sets of values, which can also be useful when preparing collections for use with `for_each` constructs. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/index-fn.mdx b/website/content/docs/templates/hcl_templates/functions/collection/index-fn.mdx index 0a924cd9e..4f49f4691 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/index-fn.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/index-fn.mdx @@ -24,5 +24,5 @@ value is not present in the list. ## Related Functions -- [`element`](//docs/templates/hcl_templates/functions/collection/element) retrieves a particular element from a list given +- [`element`](/docs/templates/hcl_templates/functions/collection/element) retrieves a particular element from a list given its index. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/keys.mdx b/website/content/docs/templates/hcl_templates/functions/collection/keys.mdx index 2cc49795d..8130d1473 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/keys.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/keys.mdx @@ -24,4 +24,4 @@ be identical as long as the keys in the map don't change. ## Related Functions -- [`values`](//docs/templates/hcl_templates/functions/collection/values) returns a list of the _values_ from a map. +- [`values`](/docs/templates/hcl_templates/functions/collection/values) returns a list of the _values_ from a map. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/lookup.mdx b/website/content/docs/templates/hcl_templates/functions/collection/lookup.mdx index cbc4c4ec1..d7589523c 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/lookup.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/lookup.mdx @@ -28,4 +28,4 @@ what? ## Related Functions -- [`element`](//docs/templates/hcl_templates/functions/collection/element) retrieves a value from a _list_ given its _index_. +- [`element`](/docs/templates/hcl_templates/functions/collection/element) retrieves a value from a _list_ given its _index_. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/reverse.mdx b/website/content/docs/templates/hcl_templates/functions/collection/reverse.mdx index c80de8abb..9fc6a79a0 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/reverse.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/reverse.mdx @@ -22,4 +22,4 @@ with all of the same elements as the given sequence but in reverse order. ## Related Functions -- [`strrev`](//docs/templates/hcl_templates/functions/string/strrev) reverses a string. +- [`strrev`](/docs/templates/hcl_templates/functions/string/strrev) reverses a string. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/setintersection.mdx b/website/content/docs/templates/hcl_templates/functions/collection/setintersection.mdx index cd518d6ef..f337bc2e5 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/setintersection.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/setintersection.mdx @@ -31,9 +31,9 @@ the ordering of the given elements is not preserved. ## Related Functions -- [`contains`](//docs/templates/hcl_templates/functions/collection/contains) tests whether a given list or set contains +- [`contains`](/docs/templates/hcl_templates/functions/collection/contains) tests whether a given list or set contains a given element value. -- [`setproduct`](//docs/templates/hcl_templates/functions/collection/setproduct) computes the _Cartesian product_ of multiple +- [`setproduct`](/docs/templates/hcl_templates/functions/collection/setproduct) computes the _Cartesian product_ of multiple sets. -- [`setunion`](//docs/templates/hcl_templates/functions/collection/setunion) computes the _union_ of +- [`setunion`](/docs/templates/hcl_templates/functions/collection/setunion) computes the _union_ of multiple sets. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/setproduct.mdx b/website/content/docs/templates/hcl_templates/functions/collection/setproduct.mdx index 2e4e71bbc..f5c7cce92 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/setproduct.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/setproduct.mdx @@ -118,7 +118,7 @@ elements all have a consistent type: The [resource `for_each`](https://www.terraform.io/docs/configuration/resources.html#for_each-multiple-resource-instances-defined-by-a-map-or-set-of-strings) and -[`dynamic` block](//docs/templates/hcl_templates/expressions/#dynamic-blocks) +[`dynamic` block](/docs/templates/hcl_templates/expressions/#dynamic-blocks) language features both require a collection value that has one element for each repetition. @@ -212,12 +212,12 @@ elements in the input variables. ## Related Functions -- [`contains`](//docs/templates/hcl_templates/functions/collection/contains) tests whether a given list or set contains +- [`contains`](/docs/templates/hcl_templates/functions/collection/contains) tests whether a given list or set contains a given element value. -- [`flatten`](//docs/templates/hcl_templates/functions/collection/flatten) is useful for flattening heirarchical data +- [`flatten`](/docs/templates/hcl_templates/functions/collection/flatten) is useful for flattening heirarchical data into a single list, for situations where the relationships between two object types are defined explicitly. -- [`setintersection`](//docs/templates/hcl_templates/functions/collection/setintersection) computes the _intersection_ of +- [`setintersection`](/docs/templates/hcl_templates/functions/collection/setintersection) computes the _intersection_ of multiple sets. -- [`setunion`](//docs/templates/hcl_templates/functions/collection/setunion) computes the _union_ of multiple +- [`setunion`](/docs/templates/hcl_templates/functions/collection/setunion) computes the _union_ of multiple sets. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/setunion.mdx b/website/content/docs/templates/hcl_templates/functions/collection/setunion.mdx index 18ea3f8c5..5b520e60f 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/setunion.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/setunion.mdx @@ -34,9 +34,9 @@ the ordering of the given elements is not preserved. ## Related Functions -- [`contains`](//docs/templates/hcl_templates/functions/collection/contains) tests whether a given list or set contains +- [`contains`](/docs/templates/hcl_templates/functions/collection/contains) tests whether a given list or set contains a given element value. -- [`setintersection`](//docs/templates/hcl_templates/functions/collection/setintersection) computes the _intersection_ of +- [`setintersection`](/docs/templates/hcl_templates/functions/collection/setintersection) computes the _intersection_ of multiple sets. -- [`setproduct`](//docs/templates/hcl_templates/functions/collection/setproduct) computes the _Cartesian product_ of multiple +- [`setproduct`](/docs/templates/hcl_templates/functions/collection/setproduct) computes the _Cartesian product_ of multiple sets. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/slice.mdx b/website/content/docs/templates/hcl_templates/functions/collection/slice.mdx index 58ed4f266..1ac456abd 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/slice.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/slice.mdx @@ -28,5 +28,5 @@ list. ## Related Functions -- [`substr`](//docs/templates/hcl_templates/functions/string/substr) performs a similar function for characters in a +- [`substr`](/docs/templates/hcl_templates/functions/string/substr) performs a similar function for characters in a string, although it uses a length instead of an end index. diff --git a/website/content/docs/templates/hcl_templates/functions/collection/values.mdx b/website/content/docs/templates/hcl_templates/functions/collection/values.mdx index c7a14220e..56ee00264 100644 --- a/website/content/docs/templates/hcl_templates/functions/collection/values.mdx +++ b/website/content/docs/templates/hcl_templates/functions/collection/values.mdx @@ -11,7 +11,7 @@ in that map. The values are returned in lexicographical order by their corresponding _keys_, so the values will be returned in the same order as their keys would be -returned from [`keys`](//docs/templates/hcl_templates/functions/collection/keys). +returned from [`keys`](/docs/templates/hcl_templates/functions/collection/keys). ## Examples @@ -26,4 +26,4 @@ returned from [`keys`](//docs/templates/hcl_templates/functions/collection/keys) ## Related Functions -- [`keys`](//docs/templates/hcl_templates/functions/collection/keys) returns a list of the _keys_ from a map. +- [`keys`](/docs/templates/hcl_templates/functions/collection/keys) returns a list of the _keys_ from a map. diff --git a/website/content/docs/templates/hcl_templates/functions/contextual/env.mdx b/website/content/docs/templates/hcl_templates/functions/contextual/env.mdx index 7e504da85..3f9f447b4 100644 --- a/website/content/docs/templates/hcl_templates/functions/contextual/env.mdx +++ b/website/content/docs/templates/hcl_templates/functions/contextual/env.mdx @@ -19,7 +19,7 @@ other places. In the previous example, the value of `aws_region` will be what's stored in the `AWS_DEFAULT_REGION` env var, unless aws_region is also set in a [manner that takes -precedence](//docs/templates/hcl_templates/variables#variable-definition-precedence). +precedence](/docs/templates/hcl_templates/variables#variable-definition-precedence). -> **Why can't I use environment variables elsewhere?** User variables are the single source of configurable input. We felt that having environment variables @@ -31,7 +31,7 @@ template that a user can easily discover using `packer inspect`. When the environment variable is not set at all -- not even with the empty string -- the value returned by `env` will be an an empty string. It will still be possible to set it using other means but you could use [custom validation -rules](//docs/templates/hcl_templates/variables#custom-validation-rules) to error in that case +rules](/docs/templates/hcl_templates/variables#custom-validation-rules) to error in that case to make sure it is set, for example: ```hcl diff --git a/website/content/docs/templates/hcl_templates/functions/conversion/can.mdx b/website/content/docs/templates/hcl_templates/functions/conversion/can.mdx index 347f2238f..af820b188 100644 --- a/website/content/docs/templates/hcl_templates/functions/conversion/can.mdx +++ b/website/content/docs/templates/hcl_templates/functions/conversion/can.mdx @@ -13,7 +13,7 @@ whether the expression produced a result without any errors. This is a special function that is able to catch errors produced when evaluating its argument. For most situations where you could use `can` it's better to use -[`try`](//docs/templates/hcl_templates/functions/conversion/try) instead, because it allows for more concise definition of +[`try`](/docs/templates/hcl_templates/functions/conversion/try) instead, because it allows for more concise definition of fallback values for failing expressions. The `can` function can only catch and handle _dynamic_ errors resulting from @@ -25,7 +25,7 @@ as a malformed resource reference. variable validation rules. Although it can technically accept any sort of expression and be used elsewhere in the configuration, we recommend against using it in other contexts. For error handling elsewhere in the configuration, -prefer to use [`try`](//docs/templates/hcl_templates/functions/conversion/try). +prefer to use [`try`](/docs/templates/hcl_templates/functions/conversion/try). ## Examples @@ -54,5 +54,5 @@ A local value with the name "nonexist" has not been declared. ## Related Functions -- [`try`](//docs/templates/hcl_templates/functions/conversion/try), which tries evaluating a sequence of expressions and +- [`try`](/docs/templates/hcl_templates/functions/conversion/try), which tries evaluating a sequence of expressions and returns the result of the first one that succeeds. diff --git a/website/content/docs/templates/hcl_templates/functions/conversion/try.mdx b/website/content/docs/templates/hcl_templates/functions/conversion/try.mdx index 89f52b8bc..73ee55086 100644 --- a/website/content/docs/templates/hcl_templates/functions/conversion/try.mdx +++ b/website/content/docs/templates/hcl_templates/functions/conversion/try.mdx @@ -108,5 +108,5 @@ A local value with the name "nonexist" has not been declared. ## Related Functions -- [`can`](//docs/templates/hcl_templates/functions/conversion/can), which tries evaluating an expression and returns a +- [`can`](/docs/templates/hcl_templates/functions/conversion/can), which tries evaluating an expression and returns a boolean value indicating whether it succeeded. diff --git a/website/content/docs/templates/hcl_templates/functions/datetime/formatdate.mdx b/website/content/docs/templates/hcl_templates/functions/datetime/formatdate.mdx index e230d0ba4..43dd61746 100644 --- a/website/content/docs/templates/hcl_templates/functions/datetime/formatdate.mdx +++ b/website/content/docs/templates/hcl_templates/functions/datetime/formatdate.mdx @@ -100,7 +100,7 @@ configuration as needed: ## Related Functions -- [`format`](//docs/templates/hcl_templates/functions/string/format) is a more general formatting function for arbitrary +- [`format`](/docs/templates/hcl_templates/functions/string/format) is a more general formatting function for arbitrary data. -- [`timestamp`](//docs/templates/hcl_templates/functions/datetime/timestamp) returns the current date and time in a format +- [`timestamp`](/docs/templates/hcl_templates/functions/datetime/timestamp) returns the current date and time in a format suitable for input to `formatdate`. diff --git a/website/content/docs/templates/hcl_templates/functions/datetime/timeadd.mdx b/website/content/docs/templates/hcl_templates/functions/datetime/timeadd.mdx index e47bc465e..885a39cc0 100644 --- a/website/content/docs/templates/hcl_templates/functions/datetime/timeadd.mdx +++ b/website/content/docs/templates/hcl_templates/functions/datetime/timeadd.mdx @@ -30,7 +30,7 @@ of adding the given direction to the given timestamp. -> **Breaking change note:** Packer previously let you decide your own "Date and Time format" syntax. With HCL2 and for parity with Terraform, Packer will be using the [RFC 3339](https://tools.ietf.org/html/rfc3339) "Date and Time -format" syntax. As a string. [`formatdate`](//docs/templates/hcl_templates/functions/datetime/formatdate) still allows you +format" syntax. As a string. [`formatdate`](/docs/templates/hcl_templates/functions/datetime/formatdate) still allows you to format a date. ## Examples diff --git a/website/content/docs/templates/hcl_templates/functions/datetime/timestamp.mdx b/website/content/docs/templates/hcl_templates/functions/datetime/timestamp.mdx index e953b778b..935229f86 100644 --- a/website/content/docs/templates/hcl_templates/functions/datetime/timestamp.mdx +++ b/website/content/docs/templates/hcl_templates/functions/datetime/timestamp.mdx @@ -22,7 +22,7 @@ Packer run. -> **Breaking change note:** Packer previously let you decide your own "Date and Time format" syntax. With HCL2 and for parity with Terraform, Packer will be using the [RFC 3339](https://tools.ietf.org/html/rfc3339) "Date and Time -format" syntax. As a string. [`formatdate`](//docs/templates/hcl_templates/functions/datetime/formatdate) still allows you +format" syntax. As a string. [`formatdate`](/docs/templates/hcl_templates/functions/datetime/formatdate) still allows you to format a date. ## Examples @@ -34,5 +34,5 @@ to format a date. ## Related Functions -- [`formatdate`](//docs/templates/hcl_templates/functions/datetime/formatdate) can convert the resulting timestamp to +- [`formatdate`](/docs/templates/hcl_templates/functions/datetime/formatdate) can convert the resulting timestamp to other date and time formats. diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/base64decode.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/base64decode.mdx index 222311ae5..614fbe7ea 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/base64decode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/base64decode.mdx @@ -33,5 +33,5 @@ Hello World ## Related Functions -- [`base64encode`](//docs/templates/hcl_templates/functions/encoding/base64encode) performs the opposite operation, +- [`base64encode`](/docs/templates/hcl_templates/functions/encoding/base64encode) performs the opposite operation, encoding the UTF-8 bytes for a string as Base64. diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/base64encode.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/base64encode.mdx index 5dca818e5..7592924f8 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/base64encode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/base64encode.mdx @@ -34,5 +34,5 @@ SGVsbG8gV29ybGQ= ## Related Functions -- [`base64decode`](//docs/templates/hcl_templates/functions/encoding/base64decode) performs the opposite operation, +- [`base64decode`](/docs/templates/hcl_templates/functions/encoding/base64decode) performs the opposite operation, decoding Base64 data and interpreting it as a UTF-8 string. diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/jsondecode.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/jsondecode.mdx index f3227aa8c..5f80eb349 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/jsondecode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/jsondecode.mdx @@ -14,7 +14,7 @@ of the result of decoding that string. The JSON encoding is defined in [RFC 7159](https://tools.ietf.org/html/rfc7159). This function maps JSON values to -[Packer language values](//docs/templates/hcl_templates/expressions#types-and-values) +[Packer language values](/docs/templates/hcl_templates/expressions#types-and-values) in the following way: | JSON type | Packer type | @@ -43,5 +43,5 @@ true ## Related Functions -- [`jsonencode`](//docs/templates/hcl_templates/functions/encoding/jsonencode) performs the opposite operation, _encoding_ +- [`jsonencode`](/docs/templates/hcl_templates/functions/encoding/jsonencode) performs the opposite operation, _encoding_ a value as JSON. diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/jsonencode.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/jsonencode.mdx index 0819f897a..39e0e066c 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/jsonencode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/jsonencode.mdx @@ -11,7 +11,7 @@ description: The jsonencode function encodes a given value as a JSON string. The JSON encoding is defined in [RFC 7159](https://tools.ietf.org/html/rfc7159). This function maps -[Packer language values](//docs/templates/hcl_templates/expressions#types-and-values) +[Packer language values](/docs/templates/hcl_templates/expressions#types-and-values) to JSON values in the following way: | Packer type | JSON type | @@ -40,5 +40,5 @@ rarely a problem in practice. ## Related Functions -- [`jsondecode`](//docs/templates/hcl_templates/functions/encoding/jsondecode) performs the opposite operation, _decoding_ +- [`jsondecode`](/docs/templates/hcl_templates/functions/encoding/jsondecode) performs the opposite operation, _decoding_ a JSON string to obtain its represented value. diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/yamldecode.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/yamldecode.mdx index d30109321..8d5b1f06a 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/yamldecode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/yamldecode.mdx @@ -15,7 +15,7 @@ This function supports a subset of [YAML 1.2](https://yaml.org/spec/1.2/spec.htm as described below. This function maps YAML values to -[Packer language values](//docs/templates/hcl_templates/expressions#types-and-values) +[Packer language values](/docs/templates/hcl_templates/expressions#types-and-values) in the following way: | YAML type | Packer type | @@ -94,7 +94,7 @@ Call to function "yamldecode" failed: unsupported tag "!not-supported". ## Related Functions -- [`jsondecode`](//docs/templates/hcl_templates/functions/encoding/jsondecode) is a similar operation using JSON instead +- [`jsondecode`](/docs/templates/hcl_templates/functions/encoding/jsondecode) is a similar operation using JSON instead of YAML. -- [`yamlencode`](//docs/templates/hcl_templates/functions/encoding/yamlencode) performs the opposite operation, _encoding_ +- [`yamlencode`](/docs/templates/hcl_templates/functions/encoding/yamlencode) performs the opposite operation, _encoding_ a value as YAML. diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/yamlencode.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/yamlencode.mdx index ef0602a60..378732916 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/yamlencode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/yamlencode.mdx @@ -13,7 +13,7 @@ description: The yamlencode function encodes a given value as a YAML string. result format may change in future versions of Packer, based on feedback. Do not use `yamldecode` to construct a value for any resource argument where changes to the result would be disruptive. To get a consistent string -representation of a value use [`jsonencode`](//docs/templates/hcl_templates/functions/encoding/jsonencode) instead; its +representation of a value use [`jsonencode`](/docs/templates/hcl_templates/functions/encoding/jsonencode) instead; its results are also valid YAML because YAML is a JSON superset. This function maps -[Packer language values](//docs/templates/hcl_templates/expressions#types-and-values) +[Packer language values](/docs/templates/hcl_templates/expressions#types-and-values) to YAML tags in the following way: | Packer type | YAML type | @@ -75,12 +75,12 @@ mean that this is rarely a problem in practice. `yamlencode` always uses YAML's "block style" for mappings and sequences, unless the mapping or sequence is empty. To generate flow-style YAML, use -[`jsonencode`](//docs/templates/hcl_templates/functions/encoding/jsonencode) instead: YAML flow-style is a superset +[`jsonencode`](/docs/templates/hcl_templates/functions/encoding/jsonencode) instead: YAML flow-style is a superset of JSON syntax. ## Related Functions -- [`jsonencode`](//docs/templates/hcl_templates/functions/encoding/jsonencode) is a similar operation using JSON instead +- [`jsonencode`](/docs/templates/hcl_templates/functions/encoding/jsonencode) is a similar operation using JSON instead of YAML. -- [`yamldecode`](//docs/templates/hcl_templates/functions/encoding/yamldecode) performs the opposite operation, _decoding_ +- [`yamldecode`](/docs/templates/hcl_templates/functions/encoding/yamldecode) performs the opposite operation, _decoding_ a YAML string to obtain its represented value. diff --git a/website/content/docs/templates/hcl_templates/functions/file/abspath.mdx b/website/content/docs/templates/hcl_templates/functions/file/abspath.mdx index 5c6322a95..83ef68ae1 100644 --- a/website/content/docs/templates/hcl_templates/functions/file/abspath.mdx +++ b/website/content/docs/templates/hcl_templates/functions/file/abspath.mdx @@ -14,7 +14,7 @@ Referring directly to filesystem paths in resource arguments may cause spurious diffs if the same configuration is applied from multiple systems or on different host operating systems. We recommend using filesystem paths only for transient values, such as the argument to -[`file`](//docs/templates/hcl_templates/functions/file) (where only the contents are then +[`file`](/docs/templates/hcl_templates/functions/file) (where only the contents are then stored). ## Examples diff --git a/website/content/docs/templates/hcl_templates/functions/file/basename.mdx b/website/content/docs/templates/hcl_templates/functions/file/basename.mdx index d39058971..dae3631c4 100644 --- a/website/content/docs/templates/hcl_templates/functions/file/basename.mdx +++ b/website/content/docs/templates/hcl_templates/functions/file/basename.mdx @@ -25,7 +25,7 @@ it uses backslash `\` as the path segment separator. On Unix systems, the slash Referring directly to filesystem paths in resource arguments may cause spurious diffs if the same configuration is applied from multiple systems or on different host operating systems. We recommend using filesystem paths only -for transient values, such as the argument to [`file`](//docs/templates/hcl_templates/functions/file) (where +for transient values, such as the argument to [`file`](/docs/templates/hcl_templates/functions/file) (where only the contents are then stored) or in `connection` and `provisioner` blocks. ## Examples @@ -37,6 +37,6 @@ baz.txt ## Related Functions -- [`dirname`](//docs/templates/hcl_templates/functions/file/dirname) returns all of the segments of a filesystem path +- [`dirname`](/docs/templates/hcl_templates/functions/file/dirname) returns all of the segments of a filesystem path _except_ the last, discarding the portion that would be returned by `basename`. diff --git a/website/content/docs/templates/hcl_templates/functions/file/dirname.mdx b/website/content/docs/templates/hcl_templates/functions/file/dirname.mdx index c5f7c542e..8c0c2b16c 100644 --- a/website/content/docs/templates/hcl_templates/functions/file/dirname.mdx +++ b/website/content/docs/templates/hcl_templates/functions/file/dirname.mdx @@ -24,7 +24,7 @@ any slashes in the given path will be replaced by backslashes before returning. Referring directly to filesystem paths in resource arguments may cause spurious diffs if the same configuration is applied from multiple systems or on different host operating systems. We recommend using filesystem paths only -for transient values, such as the argument to [`file`](//docs/templates/hcl_templates/functions/file) (where +for transient values, such as the argument to [`file`](/docs/templates/hcl_templates/functions/file) (where only the contents are then stored) or in `connection` and `provisioner` blocks. ## Examples @@ -36,5 +36,5 @@ foo/bar ## Related Functions -- [`basename`](//docs/templates/hcl_templates/functions/file/basename) returns _only_ the last portion of a filesystem +- [`basename`](/docs/templates/hcl_templates/functions/file/basename) returns _only_ the last portion of a filesystem path, discarding the portion that would be returned by `dirname`. diff --git a/website/content/docs/templates/hcl_templates/functions/file/file.mdx b/website/content/docs/templates/hcl_templates/functions/file/file.mdx index 4b595ce5e..02a4a1dd3 100644 --- a/website/content/docs/templates/hcl_templates/functions/file/file.mdx +++ b/website/content/docs/templates/hcl_templates/functions/file/file.mdx @@ -38,5 +38,5 @@ Hello World ## Related Functions -- [`fileexists`](//docs/templates/hcl_templates/functions/file/fileexists) determines whether a file exists +- [`fileexists`](/docs/templates/hcl_templates/functions/file/fileexists) determines whether a file exists at a given path. diff --git a/website/content/docs/templates/hcl_templates/functions/file/fileexists.mdx b/website/content/docs/templates/hcl_templates/functions/file/fileexists.mdx index de0667f77..8acb0565a 100644 --- a/website/content/docs/templates/hcl_templates/functions/file/fileexists.mdx +++ b/website/content/docs/templates/hcl_templates/functions/file/fileexists.mdx @@ -32,4 +32,4 @@ fileexists("custom-section.sh") ? file("custom-section.sh") : local.default_cont ## Related Functions -- [`file`](//docs/templates/hcl_templates/functions/file) reads the contents of a file at a given path +- [`file`](/docs/templates/hcl_templates/functions/file) reads the contents of a file at a given path diff --git a/website/content/docs/templates/hcl_templates/functions/index.mdx b/website/content/docs/templates/hcl_templates/functions/index.mdx index 2c6c7f934..8dd41ea43 100644 --- a/website/content/docs/templates/hcl_templates/functions/index.mdx +++ b/website/content/docs/templates/hcl_templates/functions/index.mdx @@ -20,7 +20,7 @@ max(5, 12, 9) ``` For more details on syntax, see -[_Function Calls_](//docs/templates/hcl_templates/expressions#function-calls) +[_Function Calls_](/docs/templates/hcl_templates/expressions#function-calls) on the Expressions page. The HCL language does not support user-defined functions, and so only diff --git a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrhost.mdx b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrhost.mdx index c4b69d288..50347aeda 100644 --- a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrhost.mdx +++ b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrhost.mdx @@ -22,7 +22,7 @@ cidrhost(prefix, hostnum) no more than the number of digits remaining in the address after the given prefix. For more details on how this function interprets CIDR prefixes and populates host numbers, see the worked example for -[`cidrsubnet`](//docs/templates/hcl_templates/functions/ipnet/cidrsubnet). +[`cidrsubnet`](/docs/templates/hcl_templates/functions/ipnet/cidrsubnet). Conventionally host number zero is used to represent the address of the network itself and the host number that would fill all the host bits with @@ -46,5 +46,5 @@ fd00:fd12:3456:7890::22 ## Related Functions -- [`cidrsubnet`](//docs/templates/hcl_templates/functions/ipnet/cidrsubnet) calculates a subnet address under a given +- [`cidrsubnet`](/docs/templates/hcl_templates/functions/ipnet/cidrsubnet) calculates a subnet address under a given network address prefix. diff --git a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnet.mdx b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnet.mdx index e1b119b77..5e1ca17bc 100644 --- a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnet.mdx +++ b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnet.mdx @@ -28,7 +28,7 @@ additional bits added to the prefix. This function accepts both IPv6 and IPv4 prefixes, and the result always uses the same addressing scheme as the given prefix. -Unlike the related function [`cidrsubnets`](//docs/templates/hcl_templates/functions/ipnet/cidrsubnets), `cidrsubnet` +Unlike the related function [`cidrsubnets`](/docs/templates/hcl_templates/functions/ipnet/cidrsubnets), `cidrsubnet` allows you to give a specific network number to use. `cidrsubnets` can allocate multiple network addresses at once, but numbers them automatically starting with zero. @@ -89,7 +89,7 @@ This gives us some additional information but also confirms (using a slightly different notation) the conversion from decimal to binary and shows the range of possible host addresses in this network. -While [`cidrhost`](//docs/templates/hcl_templates/functions/ipnet/cidrhost) allows calculating single host IP addresses, +While [`cidrhost`](/docs/templates/hcl_templates/functions/ipnet/cidrhost) allows calculating single host IP addresses, `cidrsubnet` on the other hand creates a new network prefix _within_ the given network prefix. In other words, it creates a subnet. @@ -144,7 +144,7 @@ Hosts/Net: 14 Class A, Private Internet The new subnet has four bits available for host numbering, which means that there are 14 host addresses available for assignment once we subtract the network's own address and the broadcast address. You can thus use -[`cidrhost`](//docs/templates/hcl_templates/functions/ipnet/cidrhost) function to calculate those host addresses by +[`cidrhost`](/docs/templates/hcl_templates/functions/ipnet/cidrhost) function to calculate those host addresses by providing it a value between 1 and 14: ```shell-session @@ -159,9 +159,9 @@ For more information on CIDR notation and subnetting, see ## Related Functions -- [`cidrhost`](//docs/templates/hcl_templates/functions/ipnet/cidrhost) calculates the IP address for a single host +- [`cidrhost`](/docs/templates/hcl_templates/functions/ipnet/cidrhost) calculates the IP address for a single host within a given network address prefix. -- [`cidrnetmask`](//docs/templates/hcl_templates/functions/ipnet/cidrnetmask) converts an IPv4 network prefix in CIDR +- [`cidrnetmask`](/docs/templates/hcl_templates/functions/ipnet/cidrnetmask) converts an IPv4 network prefix in CIDR notation into netmask notation. -- [`cidrsubnets`](//docs/templates/hcl_templates/functions/ipnet/cidrsubnets) can allocate multiple consecutive +- [`cidrsubnets`](/docs/templates/hcl_templates/functions/ipnet/cidrsubnets) can allocate multiple consecutive addresses under a prefix at once, numbering them automatically. diff --git a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnets.mdx b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnets.mdx index fff40fcd0..6eafaf126 100644 --- a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnets.mdx +++ b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnets.mdx @@ -23,7 +23,7 @@ value is therefore a list with one element per `newbits` argument, each a string containing an address range in CIDR notation. For more information on IP addressing concepts, see the documentation for the -related function [`cidrsubnet`](//docs/templates/hcl_templates/functions/ipnet/cidrsubnet). `cidrsubnet` calculates +related function [`cidrsubnet`](/docs/templates/hcl_templates/functions/ipnet/cidrsubnet). `cidrsubnet` calculates a single subnet address within a prefix while allowing you to specify its subnet number, while `cidrsubnets` can calculate many at once, potentially of different sizes, and assigns subnet numbers automatically. @@ -58,7 +58,7 @@ the same addressing scheme as the given prefix. ``` You can use nested `cidrsubnets` calls with -[`for` expressions](//docs/templates/hcl_templates/expressions#for-expressions) +[`for` expressions](/docs/templates/hcl_templates/expressions#for-expressions) to concisely allocate groups of network address blocks: ```shell-session @@ -85,9 +85,9 @@ to concisely allocate groups of network address blocks: ## Related Functions -- [`cidrhost`](//docs/templates/hcl_templates/functions/ipnet/cidrhost) calculates the IP address for a single host +- [`cidrhost`](/docs/templates/hcl_templates/functions/ipnet/cidrhost) calculates the IP address for a single host within a given network address prefix. -- [`cidrnetmask`](//docs/templates/hcl_templates/functions/ipnet/cidrnetmask) converts an IPv4 network prefix in CIDR +- [`cidrnetmask`](/docs/templates/hcl_templates/functions/ipnet/cidrnetmask) converts an IPv4 network prefix in CIDR notation into netmask notation. -- [`cidrsubnet`](//docs/templates/hcl_templates/functions/ipnet/cidrsubnet) calculates a single subnet address, allowing +- [`cidrsubnet`](/docs/templates/hcl_templates/functions/ipnet/cidrsubnet) calculates a single subnet address, allowing you to specify its network number. diff --git a/website/content/docs/templates/hcl_templates/functions/numeric/ceil.mdx b/website/content/docs/templates/hcl_templates/functions/numeric/ceil.mdx index 3f88bc62f..0267a25fe 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/ceil.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/ceil.mdx @@ -22,5 +22,5 @@ given value, which may be a fraction. ## Related Functions -- [`floor`](//docs/templates/hcl_templates/functions/numeric/floor), which rounds to the nearest whole number _less than_ +- [`floor`](/docs/templates/hcl_templates/functions/numeric/floor), which rounds to the nearest whole number _less than_ or equal. diff --git a/website/content/docs/templates/hcl_templates/functions/numeric/floor.mdx b/website/content/docs/templates/hcl_templates/functions/numeric/floor.mdx index 9157635ee..b99be6beb 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/floor.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/floor.mdx @@ -22,5 +22,5 @@ given value, which may be a fraction. ## Related Functions -- [`ceil`](//docs/templates/hcl_templates/functions/numeric/ceil), which rounds to the nearest whole number _greater than_ +- [`ceil`](/docs/templates/hcl_templates/functions/numeric/ceil), which rounds to the nearest whole number _greater than_ or equal. diff --git a/website/content/docs/templates/hcl_templates/functions/numeric/max.mdx b/website/content/docs/templates/hcl_templates/functions/numeric/max.mdx index 1aa62c3a0..dd8120133 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/max.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/max.mdx @@ -25,4 +25,4 @@ to individual arguments: ## Related Functions -- [`min`](//docs/templates/hcl_templates/functions/numeric/min), which returns the _smallest_ number from a set. +- [`min`](/docs/templates/hcl_templates/functions/numeric/min), which returns the _smallest_ number from a set. diff --git a/website/content/docs/templates/hcl_templates/functions/numeric/min.mdx b/website/content/docs/templates/hcl_templates/functions/numeric/min.mdx index 4350fb32f..a5fd48da1 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/min.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/min.mdx @@ -25,4 +25,4 @@ to individual arguments: ## Related Functions -- [`max`](//docs/templates/hcl_templates/functions/numeric/max), which returns the _greatest_ number from a set. +- [`max`](/docs/templates/hcl_templates/functions/numeric/max), which returns the _greatest_ number from a set. diff --git a/website/content/docs/templates/hcl_templates/functions/numeric/parseint.mdx b/website/content/docs/templates/hcl_templates/functions/numeric/parseint.mdx index f600c910e..9a58dcc88 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/parseint.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/parseint.mdx @@ -47,5 +47,5 @@ Invalid value for "number" parameter: cannot parse "12" as a base 2 integer. ## Related Functions -- [`format`](//docs/templates/hcl_templates/functions/string/format) can format numbers and other values into strings, +- [`format`](/docs/templates/hcl_templates/functions/string/format) can format numbers and other values into strings, with optional zero padding, alignment, etc. diff --git a/website/content/docs/templates/hcl_templates/functions/string/chomp.mdx b/website/content/docs/templates/hcl_templates/functions/string/chomp.mdx index 45320d905..509d63a63 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/chomp.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/chomp.mdx @@ -24,5 +24,5 @@ hello ## Related Functions -- [`trimspace`](//docs/templates/hcl_templates/functions/string/trimspace), which removes all types of whitespace from +- [`trimspace`](/docs/templates/hcl_templates/functions/string/trimspace), which removes all types of whitespace from both the start and the end of a string. diff --git a/website/content/docs/templates/hcl_templates/functions/string/format.mdx b/website/content/docs/templates/hcl_templates/functions/string/format.mdx index 986a778ce..fe0f31971 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/format.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/format.mdx @@ -114,7 +114,7 @@ for an unsupported format verb. ## Related Functions -- [`formatdate`](//docs/templates/hcl_templates/functions/datetime/formatdate) is a specialized formatting function for +- [`formatdate`](/docs/templates/hcl_templates/functions/datetime/formatdate) is a specialized formatting function for human-readable timestamps. -- [`formatlist`](//docs/templates/hcl_templates/functions/string/formatlist) uses the same specification syntax to +- [`formatlist`](/docs/templates/hcl_templates/functions/string/formatlist) uses the same specification syntax to produce a list of strings. diff --git a/website/content/docs/templates/hcl_templates/functions/string/formatlist.mdx b/website/content/docs/templates/hcl_templates/functions/string/formatlist.mdx index edb3f6edc..a4bd9584f 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/formatlist.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/formatlist.mdx @@ -16,7 +16,7 @@ formatlist(spec, values...) ``` The specification string uses -[the same syntax as `format`](//docs/templates/hcl_templates/functions/string/format#specification-syntax). +[the same syntax as `format`](/docs/templates/hcl_templates/functions/string/format#specification-syntax). The given values can be a mixture of list and non-list arguments. Any given lists must be the same length, which decides the length of the resulting list. @@ -46,5 +46,5 @@ once per element of the list arguments. ## Related Functions -- [`format`](//docs/templates/hcl_templates/functions/string/format) defines the specification syntax used by this +- [`format`](/docs/templates/hcl_templates/functions/string/format) defines the specification syntax used by this function and produces a single string as its result. diff --git a/website/content/docs/templates/hcl_templates/functions/string/join.mdx b/website/content/docs/templates/hcl_templates/functions/string/join.mdx index 26d8ef8a2..56cd19d99 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/join.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/join.mdx @@ -26,5 +26,5 @@ foo ## Related Functions -- [`split`](//docs/templates/hcl_templates/functions/string/split) performs the opposite operation: producing a list +- [`split`](/docs/templates/hcl_templates/functions/string/split) performs the opposite operation: producing a list by separating a single string using a given delimiter. diff --git a/website/content/docs/templates/hcl_templates/functions/string/lower.mdx b/website/content/docs/templates/hcl_templates/functions/string/lower.mdx index cbf75fd67..b5616a902 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/lower.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/lower.mdx @@ -23,5 +23,5 @@ This function uses Unicode's definition of letters and of upper- and lowercase. ## Related Functions -- [`upper`](//docs/templates/hcl_templates/functions/string/upper) converts letters in a string to _uppercase_. -- [`title`](//docs/templates/hcl_templates/functions/string/title) converts the first letter of each word in a string to uppercase. +- [`upper`](/docs/templates/hcl_templates/functions/string/upper) converts letters in a string to _uppercase_. +- [`title`](/docs/templates/hcl_templates/functions/string/title) converts the first letter of each word in a string to uppercase. diff --git a/website/content/docs/templates/hcl_templates/functions/string/regex_replace.mdx b/website/content/docs/templates/hcl_templates/functions/string/regex_replace.mdx index ca54d3bdf..6f3a2b48e 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/regex_replace.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/regex_replace.mdx @@ -44,5 +44,5 @@ hello everybody ## Related Functions -- [`replace`](//docs/templates/hcl_templates/functions/string/replace) searches a given string for another given +- [`replace`](/docs/templates/hcl_templates/functions/string/replace) searches a given string for another given substring, and replaces all occurrences with a given replacement string. diff --git a/website/content/docs/templates/hcl_templates/functions/string/replace.mdx b/website/content/docs/templates/hcl_templates/functions/string/replace.mdx index a6f9d5c7b..1d459a251 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/replace.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/replace.mdx @@ -27,5 +27,5 @@ hello everybody ## Related Functions -- [`regex_replace`](//docs/templates/hcl_templates/functions/string/regex_replace) searches a given string for another given substring, +- [`regex_replace`](/docs/templates/hcl_templates/functions/string/regex_replace) searches a given string for another given substring, and replaces each occurrence with a given replacement string. diff --git a/website/content/docs/templates/hcl_templates/functions/string/split.mdx b/website/content/docs/templates/hcl_templates/functions/string/split.mdx index 86e8c1cd2..540834d3e 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/split.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/split.mdx @@ -36,5 +36,5 @@ split(separator, string) ## Related Functions -- [`join`](//docs/templates/hcl_templates/functions/string/join) performs the opposite operation: producing a string +- [`join`](/docs/templates/hcl_templates/functions/string/join) performs the opposite operation: producing a string joining together a list of strings with a given separator. diff --git a/website/content/docs/templates/hcl_templates/functions/string/strrev.mdx b/website/content/docs/templates/hcl_templates/functions/string/strrev.mdx index ce5d1e713..ab4c0cedd 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/strrev.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/strrev.mdx @@ -24,4 +24,4 @@ olleh ## Related Functions -- [`reverse`](//docs/templates/hcl_templates/functions/collection/reverse) reverses a sequence. +- [`reverse`](/docs/templates/hcl_templates/functions/collection/reverse) reverses a sequence. diff --git a/website/content/docs/templates/hcl_templates/functions/string/title.mdx b/website/content/docs/templates/hcl_templates/functions/string/title.mdx index 4b30d7281..fba689afa 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/title.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/title.mdx @@ -21,5 +21,5 @@ This function uses Unicode's definition of letters and of upper- and lowercase. ## Related Functions -- [`upper`](//docs/templates/hcl_templates/functions/string/upper) converts _all_ letters in a string to uppercase. -- [`lower`](//docs/templates/hcl_templates/functions/string/lower) converts all letters in a string to lowercase. +- [`upper`](/docs/templates/hcl_templates/functions/string/upper) converts _all_ letters in a string to uppercase. +- [`lower`](/docs/templates/hcl_templates/functions/string/lower) converts all letters in a string to lowercase. diff --git a/website/content/docs/templates/hcl_templates/functions/string/trim.mdx b/website/content/docs/templates/hcl_templates/functions/string/trim.mdx index e4505fcc9..843e3c6a3 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/trim.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/trim.mdx @@ -20,7 +20,7 @@ hello ## Related Functions -- [`trimprefix`](//docs/templates/hcl_templates/functions/string/trimprefix) removes a word from the start of a string. -- [`trimsuffix`](//docs/templates/hcl_templates/functions/string/trimsuffix) removes a word from the end of a string. -- [`trimspace`](//docs/templates/hcl_templates/functions/string/trimspace) removes all types of whitespace from +- [`trimprefix`](/docs/templates/hcl_templates/functions/string/trimprefix) removes a word from the start of a string. +- [`trimsuffix`](/docs/templates/hcl_templates/functions/string/trimsuffix) removes a word from the end of a string. +- [`trimspace`](/docs/templates/hcl_templates/functions/string/trimspace) removes all types of whitespace from both the start and the end of a string. diff --git a/website/content/docs/templates/hcl_templates/functions/string/trimprefix.mdx b/website/content/docs/templates/hcl_templates/functions/string/trimprefix.mdx index a141f96ab..96602a719 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/trimprefix.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/trimprefix.mdx @@ -19,7 +19,7 @@ world ## Related Functions -- [`trim`](//docs/templates/hcl_templates/functions/string/trim) removes characters at the start and end of a string. -- [`trimsuffix`](//docs/templates/hcl_templates/functions/string/trimsuffix) removes a word from the end of a string. -- [`trimspace`](//docs/templates/hcl_templates/functions/string/trimspace) removes all types of whitespace from +- [`trim`](/docs/templates/hcl_templates/functions/string/trim) removes characters at the start and end of a string. +- [`trimsuffix`](/docs/templates/hcl_templates/functions/string/trimsuffix) removes a word from the end of a string. +- [`trimspace`](/docs/templates/hcl_templates/functions/string/trimspace) removes all types of whitespace from both the start and the end of a string. diff --git a/website/content/docs/templates/hcl_templates/functions/string/trimspace.mdx b/website/content/docs/templates/hcl_templates/functions/string/trimspace.mdx index 4a96adb93..fe962bf5f 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/trimspace.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/trimspace.mdx @@ -24,5 +24,5 @@ hello ## Related Functions -- [`chomp`](//docs/templates/hcl_templates/functions/string/chomp) removes just line ending characters from the _end_ of +- [`chomp`](/docs/templates/hcl_templates/functions/string/chomp) removes just line ending characters from the _end_ of a string. diff --git a/website/content/docs/templates/hcl_templates/functions/string/trimsuffix.mdx b/website/content/docs/templates/hcl_templates/functions/string/trimsuffix.mdx index 1a7f50bca..ac4749761 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/trimsuffix.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/trimsuffix.mdx @@ -19,7 +19,7 @@ hello ## Related Functions -- [`trim`](//docs/templates/hcl_templates/functions/string/trim) removes characters at the start and end of a string. -- [`trimprefix`](//docs/templates/hcl_templates/functions/string/trimprefix) removes a word from the start of a string. -- [`trimspace`](//docs/templates/hcl_templates/functions/string/trimspace) removes all types of whitespace from +- [`trim`](/docs/templates/hcl_templates/functions/string/trim) removes characters at the start and end of a string. +- [`trimprefix`](/docs/templates/hcl_templates/functions/string/trimprefix) removes a word from the start of a string. +- [`trimspace`](/docs/templates/hcl_templates/functions/string/trimspace) removes all types of whitespace from both the start and the end of a string. diff --git a/website/content/docs/templates/hcl_templates/functions/string/upper.mdx b/website/content/docs/templates/hcl_templates/functions/string/upper.mdx index 4da4737d6..b712a2d89 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/upper.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/upper.mdx @@ -23,5 +23,5 @@ This function uses Unicode's definition of letters and of upper- and lowercase. ## Related Functions -- [`lower`](//docs/templates/hcl_templates/functions/string/lower) converts letters in a string to _lowercase_. -- [`title`](//docs/templates/hcl_templates/functions/string/title) converts the first letter of each word in a string to uppercase. +- [`lower`](/docs/templates/hcl_templates/functions/string/lower) converts letters in a string to _lowercase_. +- [`title`](/docs/templates/hcl_templates/functions/string/title) converts the first letter of each word in a string to uppercase. diff --git a/website/content/docs/templates/hcl_templates/functions/uuid/uuidv4.mdx b/website/content/docs/templates/hcl_templates/functions/uuid/uuidv4.mdx index 4eb92361c..70dbce513 100644 --- a/website/content/docs/templates/hcl_templates/functions/uuid/uuidv4.mdx +++ b/website/content/docs/templates/hcl_templates/functions/uuid/uuidv4.mdx @@ -25,4 +25,4 @@ b5ee72a3-54dd-c4b8-551c-4bdc0204cedb ## Related Functions -- [`uuidv5`](//docs/templates/hcl_templates/functions/uuid/uuidv5), which generates name-based UUIDs. +- [`uuidv5`](/docs/templates/hcl_templates/functions/uuid/uuidv5), which generates name-based UUIDs. diff --git a/website/content/docs/templates/hcl_templates/functions/uuid/uuidv5.mdx b/website/content/docs/templates/hcl_templates/functions/uuid/uuidv5.mdx index 2a86c81e8..d5935c418 100644 --- a/website/content/docs/templates/hcl_templates/functions/uuid/uuidv5.mdx +++ b/website/content/docs/templates/hcl_templates/functions/uuid/uuidv5.mdx @@ -16,7 +16,7 @@ description: |- uuidv5(namespace, name) ``` -Unlike the pseudo-random UUIDs generated by [`uuidv4`](//docs/templates/hcl_templates/functions/uuid/uuidv4), +Unlike the pseudo-random UUIDs generated by [`uuidv4`](/docs/templates/hcl_templates/functions/uuid/uuidv4), name-based UUIDs derive from namespace and an name, producing the same UUID value every time if the namespace and name are unchanged. @@ -76,4 +76,4 @@ human-significant manner, such as by reference to the standard that defined it. ## Related Functions -- [`uuidv4`](//docs/templates/hcl_templates/functions/uuid), which generates pseudorandom UUIDs. +- [`uuidv4`](/docs/templates/hcl_templates/functions/uuid), which generates pseudorandom UUIDs. diff --git a/website/content/docs/templates/hcl_templates/index.mdx b/website/content/docs/templates/hcl_templates/index.mdx index 29644b4d0..d01c1e482 100644 --- a/website/content/docs/templates/hcl_templates/index.mdx +++ b/website/content/docs/templates/hcl_templates/index.mdx @@ -56,14 +56,14 @@ source "amazon-ebs" "main" { For full details about Packer's syntax, see: -- [Configuration Syntax](//docs/templates/hcl_templates/syntax) -- [Expressions](//docs/templates/hcl_templates/expressions) +- [Configuration Syntax](/docs/templates/hcl_templates/syntax) +- [Expressions](/docs/templates/hcl_templates/expressions) ## Code Organization The HCL language uses configuration files that are named with the `.pkr.hcl` file extension. There is also [a JSON-based variant of the -language](//docs/templates/hcl_templates/syntax-json) that is named with the `.pkr.json` file +language](/docs/templates/hcl_templates/syntax-json) that is named with the `.pkr.json` file extension. Configuration files must always use UTF-8 encoding, and by convention are diff --git a/website/content/docs/templates/hcl_templates/locals.mdx b/website/content/docs/templates/hcl_templates/locals.mdx index f97db6513..b601e9174 100644 --- a/website/content/docs/templates/hcl_templates/locals.mdx +++ b/website/content/docs/templates/hcl_templates/locals.mdx @@ -13,7 +13,7 @@ description: >- Local values assign a name to an expression, that can then be used multiple times within a folder. -If [variables](//docs/templates/hcl_templates/variables) are analogous to function arguments then +If [variables](/docs/templates/hcl_templates/variables) are analogous to function arguments then _local values_ are comparable to a function's local variables. Input variable and local variable usage are introduced in the [_Variables diff --git a/website/content/docs/templates/hcl_templates/path-variables.mdx b/website/content/docs/templates/hcl_templates/path-variables.mdx index a7d94f839..e29010b4c 100644 --- a/website/content/docs/templates/hcl_templates/path-variables.mdx +++ b/website/content/docs/templates/hcl_templates/path-variables.mdx @@ -24,16 +24,16 @@ locals { ## Related Functions -- [`abspath`](//docs/templates/hcl_templates/functions/file/abspath) takes a string containing +- [`abspath`](/docs/templates/hcl_templates/functions/file/abspath) takes a string containing a filesystem path and converts it to an absolute path. -- [`basename`](//docs/templates/hcl_templates/functions/file/basename) returns _only_ the last +- [`basename`](/docs/templates/hcl_templates/functions/file/basename) returns _only_ the last portion of a filesystem path, discarding the portion that would be returned by `dirname`. -- [`fileset`](//docs/templates/hcl_templates/functions/file/fileset) enumerates a set of +- [`fileset`](/docs/templates/hcl_templates/functions/file/fileset) enumerates a set of regular file names given a path and pattern. -- [`dirname`](//docs/templates/hcl_templates/functions/file/dirname) returns all of the +- [`dirname`](/docs/templates/hcl_templates/functions/file/dirname) returns all of the segments of a filesystem path _except_ the last, discarding the portion that would be returned by `basename`. diff --git a/website/content/docs/templates/hcl_templates/syntax-json.mdx b/website/content/docs/templates/hcl_templates/syntax-json.mdx index 69a01d364..3ae38fd09 100644 --- a/website/content/docs/templates/hcl_templates/syntax-json.mdx +++ b/website/content/docs/templates/hcl_templates/syntax-json.mdx @@ -11,7 +11,7 @@ description: |- `@include 'from-1.5/beta-hcl2-note.mdx'` Most Packer configurations are written in [the native HCL -syntax](//docs/templates/hcl_templates/syntax), which is designed to be easy for humans to read and +syntax](/docs/templates/hcl_templates/syntax), which is designed to be easy for humans to read and update. Packer also supports an alternative syntax that is JSON-compatible. This @@ -97,7 +97,7 @@ different (see [block-type-specific exceptions](#block-type-specific-exceptions) correspond either to argument names or to nested block type names. - Where a property corresponds to an argument that accepts - [arbitrary expressions](//docs/templates/hcl_templates/expressions) in the native syntax, the + [arbitrary expressions](/docs/templates/hcl_templates/expressions) in the native syntax, the property value is mapped to an expression as described under [_Expression Mapping_](#expression-mapping) below. For arguments that do _not_ accept arbitrary expressions, the interpretation of the property @@ -114,20 +114,20 @@ different (see [block-type-specific exceptions](#block-type-specific-exceptions) ## Expression Mapping Since JSON grammar is not able to represent all of the Packer language -[expression syntax](//docs/templates/hcl_templates/expressions), JSON values interpreted as expressions +[expression syntax](/docs/templates/hcl_templates/expressions), JSON values interpreted as expressions are mapped as follows: | JSON | Packer Language Interpretation | | ------- | ----------------------------------------------------------------------------------------------------------------- | | Boolean | A literal `bool` value. | | Number | A literal `number` value. | -| String | Parsed as a [string template](//docs/templates/hcl_templates/expressions#string-templates) and then evaluated as described below. | +| String | Parsed as a [string template](/docs/templates/hcl_templates/expressions#string-templates) and then evaluated as described below. | | Object | Each property value is mapped per this table, producing an `object(...)` value with suitable attribute types. | | Array | Each element is mapped per this table, producing a `tuple(...)` value with suitable element types. | | Null | A literal `null`. | When a JSON string is encountered in a location where arbitrary expressions are -expected, its value is first parsed as a [string template](//docs/templates/hcl_templates/expressions#string-templates) +expected, its value is first parsed as a [string template](/docs/templates/hcl_templates/expressions#string-templates) and then it is evaluated to produce the final result. If the given template consists _only_ of a single interpolation sequence, diff --git a/website/content/docs/templates/hcl_templates/syntax.mdx b/website/content/docs/templates/hcl_templates/syntax.mdx index 817585479..b4f977c3f 100644 --- a/website/content/docs/templates/hcl_templates/syntax.mdx +++ b/website/content/docs/templates/hcl_templates/syntax.mdx @@ -18,7 +18,7 @@ are built from. This page describes the _native syntax_ of HCL, which is a rich language designed to be easy for humans to read and write. The constructs in HCL can -also be expressed in [JSON syntax](//docs/templates/hcl_templates/syntax-json), which is harder for +also be expressed in [JSON syntax](/docs/templates/hcl_templates/syntax-json), which is harder for humans to read and edit but easier to generate and parse programmatically. This low-level syntax of HCL is defined in terms of a syntax called _HCL_, @@ -48,7 +48,7 @@ after the equals sign is the argument's value. The context where the argument appears determines what value types are valid (for example, each source type has a schema that defines the types of its arguments), but many arguments accept arbitrary -[expressions](//docs/templates/hcl_templates/expressions), which allow the value to +[expressions](/docs/templates/hcl_templates/expressions), which allow the value to either be specified literally or generated from other values programmatically. ### Blocks diff --git a/website/content/docs/templates/hcl_templates/variables.mdx b/website/content/docs/templates/hcl_templates/variables.mdx index 29c8f502a..dd1107b95 100644 --- a/website/content/docs/templates/hcl_templates/variables.mdx +++ b/website/content/docs/templates/hcl_templates/variables.mdx @@ -24,7 +24,7 @@ Guide_](/guides/hcl/variables). variable is being discussed. Other kinds of variables in Packer include _environment variables_ (set by the shell where Packer runs) and _expression variables_ (used to indirectly represent a value in an -[expression](//docs/templates/hcl_templates/expressions)). +[expression](/docs/templates/hcl_templates/expressions)). ## Declaring an Input Variable @@ -84,7 +84,7 @@ configuration. ## Using Input Variable Values Within the build that declared a variable, its value can be accessed from -within [expressions](//docs/templates/hcl_templates/expressions) as `var.`, where `` +within [expressions](/docs/templates/hcl_templates/expressions) as `var.`, where `` matches the label given in the declaration block: ```hcl @@ -100,7 +100,7 @@ the folder where it was declared. ## Type Constraints The `type` argument in a `variable` block allows you to restrict the [type of -value](//docs/templates/hcl_templates/expressions#types-and-values) that will be accepted as the value +value](/docs/templates/hcl_templates/expressions#types-and-values) that will be accepted as the value for a variable. If no type constraint is set then a value of any type is accepted. @@ -242,7 +242,7 @@ case letters as in the above example. ### Complex-typed Values When variable values are provided in a variable definitions file, Packer's -[usual syntax](//docs/templates/hcl_templates/expressions) can be used to assign +[usual syntax](/docs/templates/hcl_templates/expressions) can be used to assign complex-typed values, like lists and maps. Some special rules apply to the `-var` command line option and to environment diff --git a/website/content/partials/from-1.5/variables/custom-validation.mdx b/website/content/partials/from-1.5/variables/custom-validation.mdx index f7c496ae7..042aec146 100644 --- a/website/content/partials/from-1.5/variables/custom-validation.mdx +++ b/website/content/partials/from-1.5/variables/custom-validation.mdx @@ -22,7 +22,7 @@ The expression can refer only to the variable that the condition applies to, and _must not_ produce errors. If the failure of an expression is the basis of the validation decision, use -[the `can` function](//docs/templates/hcl_templates/functions/conversion/can) to detect such errors. For example: +[the `can` function](/docs/templates/hcl_templates/functions/conversion/can) to detect such errors. For example: ```hcl variable "image_id" { diff --git a/website/redirects.next.js b/website/redirects.next.js index 4d8a3dafc..28cc0501f 100644 --- a/website/redirects.next.js +++ b/website/redirects.next.js @@ -136,14 +136,24 @@ module.exports = [ destination: '/docs/:path*', permanent: true, }, + { + source: '/docs/configuration/from-1.5/:path*/overview', + destination: '/docs/templates/hcl_templates/:path*', + permanent: true, + }, + { + source: '/docs/from-1.5/:path*', + destination: '/docs/templates/hcl_templates/:path*', + permanent: true, + }, { source: '/docs/templates/hcl_templates/:path*', - destination: '//docs/templates/hcl_templates/:path*', + destination: '/docs/templates/hcl_templates/:path*', permanent: true, }, { source: '/docs/templates/hcl_templates/:path*/overview', - destination: '//docs/templates/hcl_templates/:path*', + destination: '/docs/templates/hcl_templates/:path*', permanent: true, }, {