From bc9065334e4de62e73d2b943bfbe2e808a079bd5 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 14 Jul 2021 16:54:26 -0400 Subject: [PATCH] Update description metadata per PR feedback --- website/docs/language/data-sources/index.html.md | 2 +- website/docs/language/expressions/conditionals.html.md | 2 +- website/docs/language/expressions/dynamic-blocks.html.md | 2 +- website/docs/language/expressions/for.html.md | 2 +- website/docs/language/expressions/function-calls.html.md | 2 +- website/docs/language/expressions/index.html.md | 2 +- website/docs/language/expressions/operators.html.md | 2 +- website/docs/language/expressions/references.html.md | 2 +- website/docs/language/expressions/splat.html.md | 6 ++---- website/docs/language/expressions/strings.html.md | 2 +- website/docs/language/expressions/type-constraints.html.md | 3 +-- website/docs/language/expressions/types.html.md | 2 +- .../docs/language/expressions/version-constraints.html.md | 2 +- website/docs/language/files/index.html.md | 2 +- website/docs/language/files/override.html.md | 2 +- website/docs/language/functions/index.html.md | 2 +- website/docs/language/index.html.md | 2 +- website/docs/language/meta-arguments/count.html.md | 2 +- website/docs/language/meta-arguments/depends_on.html.md | 2 +- website/docs/language/meta-arguments/for_each.html.md | 2 +- website/docs/language/meta-arguments/lifecycle.html.md | 2 +- .../docs/language/meta-arguments/module-providers.html.md | 2 +- .../docs/language/meta-arguments/resource-provider.html.md | 2 +- website/docs/language/modules/develop/index.html.md | 2 +- website/docs/language/modules/index.html.md | 2 +- website/docs/language/modules/sources.html.md | 3 ++- website/docs/language/modules/syntax.html.md | 2 +- website/docs/language/providers/configuration.html.md | 4 ++-- website/docs/language/providers/requirements.html.md | 2 +- website/docs/language/resources/behavior.html.md | 2 +- website/docs/language/resources/index.html.md | 2 +- .../docs/language/resources/provisioners/connection.html.md | 2 +- 32 files changed, 35 insertions(+), 37 deletions(-) diff --git a/website/docs/language/data-sources/index.html.md b/website/docs/language/data-sources/index.html.md index ebc21c7ee..3121c1ed8 100644 --- a/website/docs/language/data-sources/index.html.md +++ b/website/docs/language/data-sources/index.html.md @@ -3,7 +3,7 @@ layout: "language" page_title: "Data Sources - Configuration Language" sidebar_current: "docs-config-data-sources" description: |- -Data sources allow Terraform to use external data, function output, and data from separate configurations. Learn about data resource arguments, behavior, dependencies, meta-arguments, and lifecycle. +Data sources allow Terraform to use external data, function output, and data from other configurations. Terraform accesses them via data resources. --- # Data Sources diff --git a/website/docs/language/expressions/conditionals.html.md b/website/docs/language/expressions/conditionals.html.md index d3bd181bd..f12d44933 100644 --- a/website/docs/language/expressions/conditionals.html.md +++ b/website/docs/language/expressions/conditionals.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Conditional Expressions - Configuration Language" description: |- - Use conditional expressions in configurations to select one of two values. They are commonly used to define defaults to replace invalid values. + Conditional expressions in configurations select one of two values. You can use them to define defaults to replace invalid values. --- # Conditional Expressions diff --git a/website/docs/language/expressions/dynamic-blocks.html.md b/website/docs/language/expressions/dynamic-blocks.html.md index 0174b7c65..b86f89364 100644 --- a/website/docs/language/expressions/dynamic-blocks.html.md +++ b/website/docs/language/expressions/dynamic-blocks.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Dynamic Blocks - Configuration Language" description: |- - Use `dynamic` blocks in configurations to dynamically construct multi-level, nested block structures. + `dynamic` blocks dynamically construct multi-level, nested block structures. Learn to configure `dynamic` blocks and understand their behavior. --- diff --git a/website/docs/language/expressions/for.html.md b/website/docs/language/expressions/for.html.md index c34b1197d..11eb71cd4 100644 --- a/website/docs/language/expressions/for.html.md +++ b/website/docs/language/expressions/for.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "For Expressions - Configuration Language" description: |- - Using `for` expressions in Terraform configurations. + `for` expressions transform complex input values into complex output values. Learn how Terraform orders elements and how to filter inputs and group results. --- # `for` Expressions diff --git a/website/docs/language/expressions/function-calls.html.md b/website/docs/language/expressions/function-calls.html.md index eb526fa65..961043439 100644 --- a/website/docs/language/expressions/function-calls.html.md +++ b/website/docs/language/expressions/function-calls.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Function Calls - Configuration Language" description: |- - Using function calls in Terraform configurations. + Function calls transform and combine values. Learn about Terraform's built-in functions. --- # Function Calls diff --git a/website/docs/language/expressions/index.html.md b/website/docs/language/expressions/index.html.md index 2923d5d88..9cb666677 100644 --- a/website/docs/language/expressions/index.html.md +++ b/website/docs/language/expressions/index.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Expressions - Configuration Language" description: |- - An overview of expressions used to compute values in Terraform configurations. + An overview of expressions you can use to reference or compute values in Terraform configurations, including types, operators, and functions. --- # Expressions diff --git a/website/docs/language/expressions/operators.html.md b/website/docs/language/expressions/operators.html.md index 0f1dff2cc..eb79dcbb6 100644 --- a/website/docs/language/expressions/operators.html.md +++ b/website/docs/language/expressions/operators.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Operators - Configuration Language" description: |- - Using operators in Terraform configurations. + Operators transform or combine expressions. Learn about arithmetic, logical, equality, and comparison operators. --- # Arithmetic and Logical Operators diff --git a/website/docs/language/expressions/references.html.md b/website/docs/language/expressions/references.html.md index 100eb57af..8a877ce61 100644 --- a/website/docs/language/expressions/references.html.md +++ b/website/docs/language/expressions/references.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "References to Values - Configuration Language" description: |- - Using references to values in Terraform configurations. + Reference named values in configurations, including resources, input variables, local and block-local values, module outputs, data sources, and workspace data. --- # References to Named Values diff --git a/website/docs/language/expressions/splat.html.md b/website/docs/language/expressions/splat.html.md index a9eb259b6..0ea75f58b 100644 --- a/website/docs/language/expressions/splat.html.md +++ b/website/docs/language/expressions/splat.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Splat Expressions - Configuration Language" description: |- - Using splat expressions in Terraform configurations. + Splat expressions concisely express common operations. They also transform single, non-null values into a single-element tuple. --- # Splat Expressions @@ -63,9 +63,7 @@ tuple value. If the value is _null_ then the splat expression will return an empty tuple. This special behavior can be useful for modules that accept optional input -variables whose default value is `null` to represent the absense of any value, -to adapt the variable value to work with other Terraform language features that -are designed to work with collections. For example: +variables whose default value is `null` to represent the absence of any value. This allows the module to adapt the variable value for Terraform language features designed to work with collections. For example: ``` variable "website" { diff --git a/website/docs/language/expressions/strings.html.md b/website/docs/language/expressions/strings.html.md index bbf363b63..5c4f2c62b 100644 --- a/website/docs/language/expressions/strings.html.md +++ b/website/docs/language/expressions/strings.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Strings and Templates - Configuration Language" description: |- - Using strings and templates in Terraform configurations. + String literals and template sequences interpolate values and manipulate text. Learn about both quoted and "heredoc" string syntax. --- # Strings and Templates diff --git a/website/docs/language/expressions/type-constraints.html.md b/website/docs/language/expressions/type-constraints.html.md index 43d7f938c..ec59f1b9b 100644 --- a/website/docs/language/expressions/type-constraints.html.md +++ b/website/docs/language/expressions/type-constraints.html.md @@ -3,8 +3,7 @@ layout: "language" page_title: "Type Constraints - Configuration Language" sidebar_current: "docs-config-types" description: |- - Terraform module authors and provider developers can use detailed type - constraints to validate the inputs of their modules and resources. + Learn how to use type constraints to validate user inputs to modules and resources. --- # Type Constraints diff --git a/website/docs/language/expressions/types.html.md b/website/docs/language/expressions/types.html.md index 4fe5efab0..1ad317b15 100644 --- a/website/docs/language/expressions/types.html.md +++ b/website/docs/language/expressions/types.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Types and Values - Configuration Language" description: |- - An overview of values and their types in the Terraform language. + Learn about value types and their syntax, including string, number, bool, list, and map. Also learn about complex types and type conversion. --- # Types and Values diff --git a/website/docs/language/expressions/version-constraints.html.md b/website/docs/language/expressions/version-constraints.html.md index 1c462c20b..861773c66 100644 --- a/website/docs/language/expressions/version-constraints.html.md +++ b/website/docs/language/expressions/version-constraints.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Version Constraints - Configuration Language" description: |- - Using version constraints in Terraform configurations. + Version constraint strings specify a range of acceptable versions for modules, providers, and Terraform itself. Learn version constraint syntax and behavior. --- # Version Constraints diff --git a/website/docs/language/files/index.html.md b/website/docs/language/files/index.html.md index 1175a7106..72ceb13c8 100644 --- a/website/docs/language/files/index.html.md +++ b/website/docs/language/files/index.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Files and Directories - Configuration Language" description: |- - An overview of how Terraform configuration files are named, organized, and stored as well as how Terraform modules are created and evaluated. + Learn how to name, organize, and store Terraform configuration files as well as how Terraform evaluates modules. --- # Files and Directories diff --git a/website/docs/language/files/override.html.md b/website/docs/language/files/override.html.md index 505c1c1a3..1d549cbe2 100644 --- a/website/docs/language/files/override.html.md +++ b/website/docs/language/files/override.html.md @@ -3,7 +3,7 @@ layout: "language" page_title: "Override Files - Configuration Language" sidebar_current: "docs-config-override" description: |- - How Terraform override files merge additional settings into existing configuration objects. + Override files merge additional settings into existing configuration objects. Learn how to use override files and about merging behavior. --- # Override Files diff --git a/website/docs/language/functions/index.html.md b/website/docs/language/functions/index.html.md index 2da4a6cb9..2a7af09ff 100644 --- a/website/docs/language/functions/index.html.md +++ b/website/docs/language/functions/index.html.md @@ -3,7 +3,7 @@ layout: "language" page_title: "Functions - Configuration Language" sidebar_current: "docs-config-functions" description: |- - An introduction to functions in the Terraform language that can transform and combine values. + An introduction to the built-in functions that you can use to transform and combine values in expressions. --- # Built-in Functions diff --git a/website/docs/language/index.html.md b/website/docs/language/index.html.md index c958f17ea..ca4e2a22c 100644 --- a/website/docs/language/index.html.md +++ b/website/docs/language/index.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Overview - Configuration Language" description: |- - An introduction to the Terraform Configuration Language that is used to declare resources in infrastructure as code. +You can use the Terraform language to write configuration files that tell Terraform how to manage a collection of infrastructure. --- # Terraform Language Documentation diff --git a/website/docs/language/meta-arguments/count.html.md b/website/docs/language/meta-arguments/count.html.md index 35380e929..8a2b1a16e 100644 --- a/website/docs/language/meta-arguments/count.html.md +++ b/website/docs/language/meta-arguments/count.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "The count Meta-Argument - Configuration Language" description: |- - Using the Terraform language `count` meta-argument to efficiently manage nearly identical resources without writing a separate block for each one. + The `count` meta-argument helps you efficiently manage nearly identical infrastructure resources without writing a separate block for each one. --- # The `count` Meta-Argument diff --git a/website/docs/language/meta-arguments/depends_on.html.md b/website/docs/language/meta-arguments/depends_on.html.md index e6ee5f6e7..c5de7e120 100644 --- a/website/docs/language/meta-arguments/depends_on.html.md +++ b/website/docs/language/meta-arguments/depends_on.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "The depends_on Meta-Argument - Configuration Language" description: |- - Using the Terraform language `depends_on` meta-argument to handle hidden resource or module dependencies. + The `depends_on` meta-argument allows you to handle hidden resource or module dependencies. --- # The `depends_on` Meta-Argument diff --git a/website/docs/language/meta-arguments/for_each.html.md b/website/docs/language/meta-arguments/for_each.html.md index dee916bfd..46491790a 100644 --- a/website/docs/language/meta-arguments/for_each.html.md +++ b/website/docs/language/meta-arguments/for_each.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "The for_each Meta-Argument - Configuration Language" description: |- - Using the Terraform language `for_each` meta-argument to efficiently manage similar resources without writing a separate block for each one. + The `for_each` meta-argument allows you to efficiently manage similar infrastructure resources without writing a separate block for each one. --- # The `for_each` Meta-Argument diff --git a/website/docs/language/meta-arguments/lifecycle.html.md b/website/docs/language/meta-arguments/lifecycle.html.md index 69423f175..72f78e255 100644 --- a/website/docs/language/meta-arguments/lifecycle.html.md +++ b/website/docs/language/meta-arguments/lifecycle.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "The lifecycle Meta-Argument - Configuration Language" description: |- - Using the Terraform language `lifecycle` meta-argument to customize resource behavior. + The meta-arguments in a `lifecycle` block allow you to customize resource behavior. For example, preventing Terraform from destroying associated infrastructure. --- # The `lifecycle` Meta-Argument diff --git a/website/docs/language/meta-arguments/module-providers.html.md b/website/docs/language/meta-arguments/module-providers.html.md index d5af20f25..4c9ff6b16 100644 --- a/website/docs/language/meta-arguments/module-providers.html.md +++ b/website/docs/language/meta-arguments/module-providers.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "The Module providers Meta-Argument - Configuration Language" description: |- - Using the Terraform language `providers` meta-argument to specify which provider configurations from a parent module are available inside a child module. + The `providers` meta-argument specifies which provider configurations from a parent module are available inside a child module. --- # The Module `providers` Meta-Argument diff --git a/website/docs/language/meta-arguments/resource-provider.html.md b/website/docs/language/meta-arguments/resource-provider.html.md index 6be261947..e66f66453 100644 --- a/website/docs/language/meta-arguments/resource-provider.html.md +++ b/website/docs/language/meta-arguments/resource-provider.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "The Resource provider Meta-Argument - Configuration Language" description: |- - Using the Terraform language `provider` meta-argument to specify which provider configuration to use for a resource. + The `provider` meta-argument specifies which provider configuration Terraform should use for a resource. --- # The Resource `provider` Meta-Argument diff --git a/website/docs/language/modules/develop/index.html.md b/website/docs/language/modules/develop/index.html.md index d7b2f3bae..d651ee91e 100644 --- a/website/docs/language/modules/develop/index.html.md +++ b/website/docs/language/modules/develop/index.html.md @@ -3,7 +3,7 @@ layout: "language" page_title: "Creating Modules" sidebar_current: "docs-modules" description: |- - An introduction to creating modules, containers for multiple resources that are used together in a Terraform configuration. + Modules are containers for multiple resources that are used together in a configuration. Learn when to create modules and about module structure. --- # Creating Modules diff --git a/website/docs/language/modules/index.html.md b/website/docs/language/modules/index.html.md index 7feca688b..669ad5f44 100644 --- a/website/docs/language/modules/index.html.md +++ b/website/docs/language/modules/index.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Modules Overview - Configuration Language" description: |- - An overview of Terraform modules, containers for multiple resources that are used together in a configuration. + Modules are containers for multiple resources that are used together in a configuration. Find resources for using, developing, and publishing modules. --- # Modules diff --git a/website/docs/language/modules/sources.html.md b/website/docs/language/modules/sources.html.md index d6423c25d..21ee57dfd 100644 --- a/website/docs/language/modules/sources.html.md +++ b/website/docs/language/modules/sources.html.md @@ -2,7 +2,8 @@ layout: "language" page_title: "Module Sources" sidebar_current: "docs-modules-sources" -description: Using `source` in Terraform modules to specify child modules in locations like GitHub, the Terraform Registry, Bitbucket, Git, Mercurial, S3, and GCS. +description: |- + The `source` argument tells Terraform where to find child modules in locations like GitHub, the Terraform Registry, Bitbucket, Git, Mercurial, S3, and GCS. --- # Module Sources diff --git a/website/docs/language/modules/syntax.html.md b/website/docs/language/modules/syntax.html.md index 58ac14539..0010e3056 100644 --- a/website/docs/language/modules/syntax.html.md +++ b/website/docs/language/modules/syntax.html.md @@ -3,7 +3,7 @@ layout: "language" page_title: "Modules - Configuration Language" sidebar_current: "docs-config-modules" description: |- - Calling one module from another in Terraform configurations. + Modules are containers for multiple resources that are used together. Learn how to call one module from another in configurations. --- # Module Blocks diff --git a/website/docs/language/providers/configuration.html.md b/website/docs/language/providers/configuration.html.md index 6641271a1..27f5544a4 100644 --- a/website/docs/language/providers/configuration.html.md +++ b/website/docs/language/providers/configuration.html.md @@ -3,12 +3,12 @@ layout: "language" page_title: "Provider Configuration - Configuration Language" sidebar_current: "docs-config-providers" description: |- - Configuring Terraform providers, including how to use the `alias` meta-argument to specify multiple configurations for a single provider. + Learn how to configure Terraform providers, including how to use the `alias` meta-argument to specify multiple configurations for a single provider. --- # Provider Configuration -Providers alow Terraform to interact with cloud providers, SaaS providers, and +Providers allow Terraform to interact with cloud providers, SaaS providers, and other APIs. Some providers require you to configure them with endpoint URLs, cloud regions, diff --git a/website/docs/language/providers/requirements.html.md b/website/docs/language/providers/requirements.html.md index 6366bb557..5a4ccd58d 100644 --- a/website/docs/language/providers/requirements.html.md +++ b/website/docs/language/providers/requirements.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Provider Requirements - Configuration Language" description: |- - Declaring providers in your module configuration so that Terraform can install them. + Providers are plugins that allow Terraform to interact with remote systems. Learn how to declare providers in your configuration. --- # Provider Requirements diff --git a/website/docs/language/resources/behavior.html.md b/website/docs/language/resources/behavior.html.md index c2f7b3e0a..f0fe4463c 100644 --- a/website/docs/language/resources/behavior.html.md +++ b/website/docs/language/resources/behavior.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Resource Behavior - Configuration Language" description: |- - How Terraform uses resource blocks to create infrastructure objects as well as details about resource attributes and dependencies. + Learn how Terraform uses `resource` blocks to create infrastructure objects. Also learn about resource dependencies and accessing resource attributes. --- # Resource Behavior diff --git a/website/docs/language/resources/index.html.md b/website/docs/language/resources/index.html.md index cd343fc0f..2e5bd229a 100644 --- a/website/docs/language/resources/index.html.md +++ b/website/docs/language/resources/index.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Resources Overview - Configuration Language" description: |- - An introduction to the Terraform language resources element that is used to describe infrastructure objects. + An introduction to the `resources` element that describes infrastructure objects in Terraform configurations. --- # Resources diff --git a/website/docs/language/resources/provisioners/connection.html.md b/website/docs/language/resources/provisioners/connection.html.md index d173320e7..c68bd94e1 100644 --- a/website/docs/language/resources/provisioners/connection.html.md +++ b/website/docs/language/resources/provisioners/connection.html.md @@ -3,7 +3,7 @@ layout: "language" page_title: "Provisioner Connection Settings" sidebar_current: "docs-provisioners-connection" description: |- - Managing provisioner connection defaults for SSH and WinRM using the `connection` block in Terraform language. + The `connection` block allows you to manage provisioner connection defaults for SSH and WinRM. --- # Provisioner Connection Settings