diff --git a/website/content/docs/community-tools.mdx b/website/content/docs/community-tools.mdx index 49909b8aa34..9b2c24aa386 100644 --- a/website/content/docs/community-tools.mdx +++ b/website/content/docs/community-tools.mdx @@ -12,22 +12,20 @@ power of Packer templates. ## Third-Party plugins -The plugins listed below have been built by the community of Packer users and -vendors. These plugins are not officially tested nor officially maintained by -HashiCorp, and are listed here in order to help users find them easily. - To learn more about how to use community plugins, or how to build your own, -check out the docs on [extending Packer](/packer/docs/plugins/install) +refer to the docs on [extending Packer](/packer/docs/plugins/install) If you have built a plugin and would like to add it to this community list, -please make a pull request so that we can document your -contribution here! +make a pull request so that we can document your contribution. + +Refer to the following topics to learn about plugins built by the community of Packer users and +vendors. We do not test or maintain community plugins. -@include "builders/community_builders.mdx" -@include "provisioners/community_provisioners.mdx" +- [Community Builders](/packer/docs/builders/community-supported) +- [Community Provisioners](/packer/docs/provisioners/community-supported) +- [Community Post-Processors](/packer/docs/post-processors/community-supported) -@include "post-processors/community_post-processors.mdx" ## Templates diff --git a/website/content/docs/datasources/hcp/hcp-packer-iteration.mdx b/website/content/docs/datasources/hcp/hcp-packer-iteration.mdx index a1bfc44744d..b28570bf879 100644 --- a/website/content/docs/datasources/hcp/hcp-packer-iteration.mdx +++ b/website/content/docs/datasources/hcp/hcp-packer-iteration.mdx @@ -1,7 +1,6 @@ --- description: | - The `hcp-packer-iteration` data source retrieves information about an -iteration from the HCP Packer registry. This data source is deprecated. Use the `hcpe-packer-verion` data source instead. + The `hcp-packer-iteration` data source retrieves information about an iteration from the HCP Packer registry. This data source is deprecated. Use the `hcpe-packer-verion` data source instead. page_title: hcp-packer-iteration data source reference --- 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 4272cbbcbe5..8115f6ccdc2 100644 --- a/website/content/docs/templates/hcl_templates/functions/conversion/can.mdx +++ b/website/content/docs/templates/hcl_templates/functions/conversion/can.mdx @@ -1,8 +1,7 @@ --- -page_title: can - Functions - Configuration Language +page_title: can function reference description: |- - The can function tries to evaluate an expression given as an argument and - indicates whether the evaluation succeeded. + The `can` function evaluates an expression and indicates whether it succeeds. --- # `can` Function diff --git a/website/content/docs/templates/hcl_templates/functions/conversion/convert.mdx b/website/content/docs/templates/hcl_templates/functions/conversion/convert.mdx index 5cb90d1576e..952126f6cb5 100644 --- a/website/content/docs/templates/hcl_templates/functions/conversion/convert.mdx +++ b/website/content/docs/templates/hcl_templates/functions/conversion/convert.mdx @@ -1,6 +1,6 @@ --- -page_title: convert - Functions - Configuration Language -description: 'The convert function converts a value or an expression to a given type. ' +page_title: convert function reference +description: The `convert` function converts a value or an expression to a given type. --- # `convert` Function 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 a34e6e293c8..94e70d0ad5b 100644 --- a/website/content/docs/templates/hcl_templates/functions/conversion/try.mdx +++ b/website/content/docs/templates/hcl_templates/functions/conversion/try.mdx @@ -1,9 +1,7 @@ --- -page_title: try - Functions - Configuration Language +page_title: try function reference description: |- - The try function tries to evaluate a sequence of expressions given as - arguments and returns the result of the first one that does not produce - any errors. + The `try` function evaluates a sequence of expressions and returns the result of the first expression that does not produce any errors. --- # `try` Function 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 8d918823047..1ccc24e961b 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/base64decode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/base64decode.mdx @@ -1,6 +1,6 @@ --- -page_title: base64decode - Functions - Configuration Language -description: The base64decode function decodes a string containing a base64 sequence. +page_title: base64decode function reference +description: The `base64decode` function decodes a base64-encoded string. --- # `base64decode` Function 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 2d3441d8887..a80e5bc1a3a 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/base64encode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/base64encode.mdx @@ -1,6 +1,6 @@ --- -page_title: base64encode - Functions - Configuration Language -description: The base64encode function applies Base64 encoding to a string. +page_title: base64encode function reference +description: The `base64encode` function encodes a string in base64 format. --- # `base64encode` Function diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/base64gzip.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/base64gzip.mdx index c015077dfa3..ce7dbe6bbb1 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/base64gzip.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/base64gzip.mdx @@ -1,7 +1,6 @@ --- -page_title: base64gzip - Functions - Configuration Language -description: The base64encode function compresses the given string with gzip and then - encodes the result in Base64. +page_title: base64gzip function reference +description: The `base64gzip` function compresses the given string using gzip and then encodes the result in base64. --- # `base64gzip` Function diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/csvdecode.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/csvdecode.mdx index 88cb42d49e6..a558a5c085f 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/csvdecode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/csvdecode.mdx @@ -1,6 +1,6 @@ --- -page_title: csvdecode - Functions - Configuration Language -description: The csvdecode function decodes CSV data into a list of maps. +page_title: csvdecode function reference +description: The `csvdecode` function decodes CSV data into a list of maps. --- # `csvdecode` Function 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 ade3fd2bd1d..c55783de040 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/jsondecode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/jsondecode.mdx @@ -1,8 +1,7 @@ --- -page_title: jsondecode - Functions - Configuration Language +page_title: jsondecode function reference description: |- - The jsondecode function decodes a JSON string into a representation of its - value. + The `jsondecode` function decodes a JSON string into its corresponding Packer value. --- # `jsondecode` Function 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 fb75ee7fa84..4304ff96ddb 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/jsonencode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/jsonencode.mdx @@ -1,6 +1,6 @@ --- -page_title: jsonencode - Functions - Configuration Language -description: The jsonencode function encodes a given value as a JSON string. +page_title: jsonencode function reference +description: The `jsonencode` function encodes a given value as a JSON string. --- # `jsonencode` Function diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/textdecodebase64.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/textdecodebase64.mdx index 923d66bc843..7a0b060538e 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/textdecodebase64.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/textdecodebase64.mdx @@ -1,6 +1,6 @@ --- -page_title: testdecodebase64 - Functions - Configuration Language -description: The testdecodebase64 function converts a base64 encoded string, whose underlying encoding is the one specified as argument, into a UTF-8 string. +page_title: testdecodebase64 function reference +description: The `testdecodebase64` function converts a base64-encoded string into a UTF-8 string. --- # `textdecodebase64` Function diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/textencodebase64.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/textencodebase64.mdx index 6abff637139..7a10a571626 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/textencodebase64.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/textencodebase64.mdx @@ -1,6 +1,6 @@ --- -page_title: testencodebase64 - Functions - Configuration Language -description: The testencodebase64 function converts a UTF-8 NFC input string to a base64 blob that encodes the target encoding's rendering of the input string. +page_title: testencodebase64 function reference +description: The `testencodebase64` function converts a UTF-8 NFC string into a base64 blob to match the destination encoding. --- # `textencodebase64` Function @@ -8,7 +8,7 @@ description: The testencodebase64 function converts a UTF-8 NFC input string to Encodes the input string to the destination encoding. The output is base64-encoded to account for HCL's string encoding limitations: they must be UTF-8, NFC-normalised. -Packer uses the "standard" Base64 alphabet as defined in +Packer uses the standard base64 alphabet as defined in [RFC 4648 section 4](https://tools.ietf.org/html/rfc4648#section-4). The `encoding_name` argument must contain one of the encoding names or aliases recorded in diff --git a/website/content/docs/templates/hcl_templates/functions/encoding/urlencode.mdx b/website/content/docs/templates/hcl_templates/functions/encoding/urlencode.mdx index a2b8de5cc74..fbe7d7bf50d 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/urlencode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/urlencode.mdx @@ -1,6 +1,6 @@ --- -page_title: urlencode - Functions - Configuration Language -description: The urlencode function applies URL encoding to a given string. +page_title: urlencode function reference +description: The `urlencode` function applies URL encoding to a given string. --- # `urlencode` Function 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 ea787ca2c06..c397d6fb736 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/yamldecode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/yamldecode.mdx @@ -1,8 +1,7 @@ --- -page_title: yamldecode - Functions - Configuration Language +page_title: yamldecode function reference description: |- - The yamldecode function decodes a YAML string into a representation of its - value. + The `yamldecode` function decodes a YAML string into its corresponding Packer value. --- # `yamldecode` Function 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 2aa0174714c..0b8f5c9e3e9 100644 --- a/website/content/docs/templates/hcl_templates/functions/encoding/yamlencode.mdx +++ b/website/content/docs/templates/hcl_templates/functions/encoding/yamlencode.mdx @@ -1,6 +1,6 @@ --- -page_title: yamlencode - Functions - Configuration Language -description: The yamlencode function encodes a given value as a YAML string. +page_title: yamlencode function reference +description: The `yamlencode` function encodes a given value as a YAML string. --- # `yamlencode` Function diff --git a/website/content/docs/templates/hcl_templates/functions/index.mdx b/website/content/docs/templates/hcl_templates/functions/index.mdx index 0a9ee2a9eee..9a074eeec07 100644 --- a/website/content/docs/templates/hcl_templates/functions/index.mdx +++ b/website/content/docs/templates/hcl_templates/functions/index.mdx @@ -1,16 +1,16 @@ --- -page_title: Functions - Configuration Language +page_title: Built-in functions reference overview description: |- - The HCL language has a number of built-in functions that can be called - from within expressions to transform and combine values. + Functions built into HCL language can transform and combine values. Learn about using built-in functions in your Packer templates. --- -# Built-in Functions +# Built-in functions overview -`@include 'from-1.5/beta-hcl2-note.mdx'` +This topic provides an overview of the built-in HashiCorp configuration language (HCL) functions you can use in your Packer templates. -The HCL language includes a number of built-in functions that you can -call from within expressions to transform and combine values. The general +## Functions syntax + +You can use functions in Packer templates to transform and combine values. The syntax for function calls is a function name followed by comma-separated arguments in parentheses: @@ -19,8 +19,7 @@ max(5, 12, 9) ``` For information on invoking functions in string literals, refer to the -[String Literals](https://developer.hashicorp.com/packer/docs/templates/hcl_templates/expressions#string-literals) section -in the HCL2 expressions documentation. +[string literals reference](/packer/docs/templates/hcl_templates/expressions#string-literals) section. -The HCL language does not support user-defined functions, and so only -the functions built in to the language are available for use. The documentation includes all of the available built-in functions. +HCL does not support user-defined functions. You can only call +the functions built into the language. 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 77c5679990c..0682f1b2e44 100644 --- a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrhost.mdx +++ b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrhost.mdx @@ -1,8 +1,8 @@ --- -page_title: cidrhost - Functions - Configuration Language +page_title: cidrhost function reference description: |- - The cidrhost function calculates a full host IP address within a given - IP network address prefix. + The `cidrhost` function calculates a full host IP address in a given + IP network address prefix. --- # `cidrhost` Function diff --git a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrnetmask.mdx b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrnetmask.mdx index fbb43eec471..04869b9825b 100644 --- a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrnetmask.mdx +++ b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrnetmask.mdx @@ -1,8 +1,8 @@ --- -page_title: cidrnetmask - Functions - Configuration Language +page_title: cidrnetmask function reference description: |- - The cidrnetmask function converts an IPv4 address prefix given in CIDR - notation into a subnet mask address. + The `cidrnetmask` function converts an IPv4 address prefix given in CIDR + notation into a subnet mask address. --- # `cidrnetmask` Function 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 fbe916df750..055bfb11c3a 100644 --- a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnet.mdx +++ b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnet.mdx @@ -1,8 +1,8 @@ --- -page_title: cidrsubnet - Functions - Configuration Language +page_title: cidrsubnet function reference description: |- - The cidrsubnet function calculates a subnet address within a given IP network - address prefix. + The `cidrsubnet` function calculates a subnet address within a given IP network + address prefix. --- # `cidrsubnet` Function 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 faac15f8b84..71035f4ee92 100644 --- a/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnets.mdx +++ b/website/content/docs/templates/hcl_templates/functions/ipnet/cidrsubnets.mdx @@ -1,8 +1,8 @@ --- -page_title: cidrsubnets - Functions - Configuration Language +page_title: cidrsubnets function reference description: |- - The cidrsubnets function calculates a sequence of consecutive IP address - ranges within a particular CIDR prefix. + The `cidrsubnets` function calculates a sequence of consecutive IP address + ranges in a CIDR prefix. --- # `cidrsubnets` Function diff --git a/website/content/docs/templates/hcl_templates/functions/numeric/abs.mdx b/website/content/docs/templates/hcl_templates/functions/numeric/abs.mdx index 023b415572b..f3b806e7c79 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/abs.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/abs.mdx @@ -1,6 +1,6 @@ --- -page_title: abs - Functions - Configuration Language -description: The abs function returns the absolute value of the given number. +page_title: abs function reference +description: The `abs` function returns the absolute value of the given number. --- # `abs` Function 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 2c3e9a70f10..8034b0f4db5 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/ceil.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/ceil.mdx @@ -1,8 +1,8 @@ --- -page_title: ceil - Functions - Configuration Language +page_title: ceil function reference description: |- - The ceil function returns the closest whole number greater than or equal to - the given value. + The `ceil` function returns the closest whole number greater than or equal to + the given value. --- # `ceil` Function 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 66faf73f200..574e6d61bfa 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/floor.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/floor.mdx @@ -1,8 +1,8 @@ --- -page_title: floor - Functions - Configuration Language +page_title: floor function reference description: |- - The floor function returns the closest whole number less than or equal to - the given value. + The `floor` function returns the closest whole number less than or equal to + the given value. --- # `floor` Function diff --git a/website/content/docs/templates/hcl_templates/functions/numeric/log.mdx b/website/content/docs/templates/hcl_templates/functions/numeric/log.mdx index c63952e05a8..591b50a441c 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/log.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/log.mdx @@ -1,6 +1,6 @@ --- -page_title: log - Functions - Configuration Language -description: The log function returns the logarithm of a given number in a given base. +page_title: log function reference +description: The `log` function returns the logarithm of a given number in a given base. --- # `log` Function 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 36f8ac2554e..f35dc050a41 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/max.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/max.mdx @@ -1,6 +1,6 @@ --- -page_title: max - Functions - Configuration Language -description: The max function takes one or more numbers and returns the greatest number. +page_title: max function reference +description: The `max` function returns the largest number from the given set of one or more numbers. --- # `max` Function 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 64e697143ab..4915ddd0d2c 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/min.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/min.mdx @@ -1,6 +1,6 @@ --- -page_title: min - Functions - Configuration Language -description: The min function takes one or more numbers and returns the smallest number. +page_title: min function reference +description: The `min` function returns the smallest number in a set of one or more numbers. --- # `min` Function 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 3b8ac241185..4665b2919f2 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/parseint.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/parseint.mdx @@ -1,8 +1,8 @@ --- -page_title: parseint - Functions - Configuration Language +page_title: parseint function reference description: >- - The parseint function parses the given string as a representation of an - integer. + The `parseint` function parses the given string as a representation of an + integer. --- # `parseint` Function diff --git a/website/content/docs/templates/hcl_templates/functions/numeric/pow.mdx b/website/content/docs/templates/hcl_templates/functions/numeric/pow.mdx index e8702cba972..ca90688f6bb 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/pow.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/pow.mdx @@ -1,6 +1,6 @@ --- -page_title: pow - Functions - Configuration Language -description: The pow function raises a number to a power. +page_title: pow function reference +description: The `pow` function raises a number to a power. --- # `pow` Function diff --git a/website/content/docs/templates/hcl_templates/functions/numeric/signum.mdx b/website/content/docs/templates/hcl_templates/functions/numeric/signum.mdx index 1caf6988389..d10002a387d 100644 --- a/website/content/docs/templates/hcl_templates/functions/numeric/signum.mdx +++ b/website/content/docs/templates/hcl_templates/functions/numeric/signum.mdx @@ -1,6 +1,6 @@ --- -page_title: signum - Functions - Configuration Language -description: The signum function determines the sign of a number. +page_title: signum function reference +description: The `signum` function determines the sign of a number. --- # `signum` Function 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 9586ab280ed..dd311a204ef 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/chomp.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/chomp.mdx @@ -1,6 +1,6 @@ --- -page_title: chomp - Functions - Configuration Language -description: The chomp function removes newline characters at the end of a string. +page_title: chomp function reference +description: The `chomp` function removes newline characters at the end of a string. --- # `chomp` Function 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 7ac645ffedf..3bfd9ee3a84 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/format.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/format.mdx @@ -1,8 +1,7 @@ --- -page_title: format - Functions - Configuration Language +page_title: format function reference description: |- - The format function produces a string by formatting a number of other values - according to a specification string. + The `format` function applies a specification to format values and produce a new string. --- # `format` Function 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 6d110ae2065..edf3284eabd 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/formatlist.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/formatlist.mdx @@ -1,8 +1,7 @@ --- -page_title: formatlist - Functions - Configuration Language +page_title: formatlist function reference description: |- - The formatlist function produces a list of strings by formatting a number of - other values according to a specification string. + The `formatlist` function applies a specification to format values and produce a list of strings. --- # `formatlist` Function diff --git a/website/content/docs/templates/hcl_templates/functions/string/indent.mdx b/website/content/docs/templates/hcl_templates/functions/string/indent.mdx index 158a22a4971..d91428b7a4b 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/indent.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/indent.mdx @@ -1,7 +1,7 @@ --- -page_title: indent - Functions - Configuration Language +page_title: indent function reference description: |- - The indent function adds a number of spaces to the beginnings of all but the + The `indent` function adds spaces to the beginnings of all but the first line of a given multi-line string. --- 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 acdbaa8ae03..149c874df5b 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/join.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/join.mdx @@ -1,8 +1,8 @@ --- -page_title: join - Functions - Configuration Language +page_title: join function reference description: |- - The join function produces a string by concatenating the elements of a list - with a given delimiter. + The `join` function produces a string by concatenating the elements of a list + with a given delimiter. --- # `join` Function 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 65482482207..8815d01b344 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/lower.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/lower.mdx @@ -1,8 +1,8 @@ --- -page_title: lower - Functions - Configuration Language +page_title: lower function reference description: >- - The lower function converts all cased letters in the given string to - lowercase. + The `lower` function converts all uppercase letters in the given string to + lowercase. --- # `lower` Function diff --git a/website/content/docs/templates/hcl_templates/functions/string/regex.mdx b/website/content/docs/templates/hcl_templates/functions/string/regex.mdx index 74d55a647a4..6f00e4782ec 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/regex.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/regex.mdx @@ -1,7 +1,7 @@ --- -page_title: regex - Functions - Configuration Language +page_title: regex function reference description: |- - The regex function applies a regular expression to a string and returns the + The `regex` function applies a regular expression to a string and returns the matching substrings. --- 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 29d10b8e095..f5e02ec70bd 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 @@ -1,12 +1,7 @@ --- -page_title: regex_replace - Functions - Configuration Language +page_title: regex_replace function reference description: >- - The regex_replace function searches a given string for another given - substring, - - and replaces all occurrences with a given replacement string. The substring - - argument can be a valid regular expression or a string. + The `regex_replace` function matches and replaces all occurrences of a substring with a replacement string. --- # `regex_replace` Function diff --git a/website/content/docs/templates/hcl_templates/functions/string/regexall.mdx b/website/content/docs/templates/hcl_templates/functions/string/regexall.mdx index 96900698148..0a1f92a8537 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/regexall.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/regexall.mdx @@ -1,7 +1,7 @@ --- -page_title: regexall - Functions - Configuration Language +page_title: regexall function reference description: |- - The regexall function applies a regular expression to a string and returns a list of all matches. + The `regexall` function applies a regular expression to a string and returns a list of all matches. --- # `regexall` Function 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 4097756f9b1..e430827c7be 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/replace.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/replace.mdx @@ -1,8 +1,7 @@ --- -page_title: replace - Functions - Configuration Language +page_title: replace function reference description: |- - The replace function searches a given string for another given substring, - and replaces all occurrences with a given replacement string. + The `replace` function replaces all occurrences of substring with a given string. --- # `replace` Function 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 677b10a924b..8ee3d578805 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/split.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/split.mdx @@ -1,8 +1,7 @@ --- -page_title: split - Functions - Configuration Language +page_title: split function reference description: |- - The split function produces a list by dividing a given string at all - occurrences of a given separator. + The `split` function divides the given string according to the specified separator to produce a list. --- # `split` Function diff --git a/website/content/docs/templates/hcl_templates/functions/string/strcontains.mdx b/website/content/docs/templates/hcl_templates/functions/string/strcontains.mdx index ea3389c37a0..fec3f45224b 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/strcontains.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/strcontains.mdx @@ -1,12 +1,12 @@ --- -page_title: strcontains - Functions - Configuration Language +page_title: strcontains function reference description: |- - The strcontains function checks whether a given string can be found within another string. + The `strcontains` function searches for a substring within a string. --- # `strcontains` Function -`strcontains` function checks whether a substring is within another string. +The `strcontains` function searches for a substring within a string. ```hcl strcontains(string, substr) 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 c543bfeb93a..0b1c08b4456 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/strrev.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/strrev.mdx @@ -1,6 +1,6 @@ --- -page_title: strrev - Functions - Configuration Language -description: The strrev function reverses a string. +page_title: strrev function reference +description: The `strrev` function reverses a string. --- # `strrev` Function diff --git a/website/content/docs/templates/hcl_templates/functions/string/substr.mdx b/website/content/docs/templates/hcl_templates/functions/string/substr.mdx index 594feb28e77..d186768b5d2 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/substr.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/substr.mdx @@ -1,8 +1,8 @@ --- -page_title: substr - Functions - Configuration Language +page_title: substr function reference description: |- - The substr function extracts a substring from a given string by offset and - length. + The `substr` function extracts a substring from a given string using an offset and + length. --- # `substr` Function 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 15d40f3d0b8..37b6ce2e0d5 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/title.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/title.mdx @@ -1,7 +1,7 @@ --- -page_title: title - Functions - Configuration Language +page_title: title function reference description: |- - The title function converts the first letter of each word in a given string + The `title` function converts the first letter of each word in a given string to uppercase. --- 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 321a46eac0e..bbd378953ee 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/trim.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/trim.mdx @@ -1,8 +1,8 @@ --- -page_title: trim - Functions - Configuration Language +page_title: trim function reference description: |- - The trim function removes the specified characters from the start and end of - a given string. + The `trim` function removes the specified characters from the start and end of + a given string. --- # `trim` Function 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 f9396edc0fd..29ddb7df79e 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/trimprefix.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/trimprefix.mdx @@ -1,8 +1,8 @@ --- -page_title: trimprefix - Functions - Configuration Language +page_title: trimprefix function reference description: |- - The trimprefix function removes the specified prefix from the start of a - given string. + The `trimprefix` function removes the specified prefix from the start of a + given string. --- # `trimprefix` Function 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 a1f619083a9..22308139db9 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/trimspace.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/trimspace.mdx @@ -1,8 +1,8 @@ --- -page_title: trimspace - Functions - Configuration Language +page_title: trimspace function reference description: |- - The trimspace function removes space characters from the start and end of - a given string. + The `trimspace` function removes space characters from the start and end of + a given string. --- # `trimspace` Function 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 e69644ca374..9c8ec3945dc 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/trimsuffix.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/trimsuffix.mdx @@ -1,8 +1,8 @@ --- -page_title: trimsuffix - Functions - Configuration Language +page_title: trimsuffix function reference description: |- - The trimsuffix function removes the specified suffix from the end of a - given string. + The `trimsuffix` function removes the specified suffix from the end of a + given string. --- # `trimsuffix` Function 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 7a6bb0a5b64..62d83c51527 100644 --- a/website/content/docs/templates/hcl_templates/functions/string/upper.mdx +++ b/website/content/docs/templates/hcl_templates/functions/string/upper.mdx @@ -1,7 +1,7 @@ --- -page_title: upper - Functions - Configuration Language +page_title: upper function reference description: >- - The upper function converts all cased letters in the given string to + The `upper` function converts all lowercase letters in the given 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 3c03179528f..d05fe59de67 100644 --- a/website/content/docs/templates/hcl_templates/functions/uuid/uuidv4.mdx +++ b/website/content/docs/templates/hcl_templates/functions/uuid/uuidv4.mdx @@ -1,6 +1,6 @@ --- -page_title: v4 - uuid - Functions - Configuration Language -description: The uuidv4 function generates a unique ID. +page_title: uuidv4 function reference +description: The `uuidv4` function generates a unique string ID according to RFC 4122 version 4. --- # `uuidv4` Function 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 310b4b1305c..99940e1613c 100644 --- a/website/content/docs/templates/hcl_templates/functions/uuid/uuidv5.mdx +++ b/website/content/docs/templates/hcl_templates/functions/uuid/uuidv5.mdx @@ -1,8 +1,7 @@ --- -page_title: uuidv5 - Functions - Configuration Language +page_title: uuidv5 function reference description: |- - The uuidv5 function generates a uuid v5 string representation of the value in - the specified namespace. + The `uuidv5` function generates a unique name-based ID for the value according to RFC 4122 version 5. --- # `uuidv5` Function diff --git a/website/redirects.js b/website/redirects.js index 26dd855139e..f3781b23ee7 100644 --- a/website/redirects.js +++ b/website/redirects.js @@ -95,7 +95,7 @@ module.exports = [ source: '/packer/docs/provisioners/custom', destination: '/packer/docs/plugins/creation/custom-provisioners', permanent: true, - } + }, /** * END EMPTY PAGE REDIRECTS */