Fix metadata description format on all pages
This commit is contained in:
parent
fd3b5a48c7
commit
a780f625e9
|
@ -2,8 +2,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 other configurations. Terraform accesses them via data resources.
|
||||
description: "Data sources allow Terraform to use external data, function output, and data from other configurations. Learn data resource arguments, behavior, and lifecycle."
|
||||
---
|
||||
|
||||
# Data Sources
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Dependency Lock File (.terraform.lock.hcl) - Configuration Language"
|
||||
description: |-
|
||||
Terraform uses the dependency lock file `.teraform.lock.hcl` to track and select provider versions. Learn about dependency installation and lock file changes.
|
||||
description: "Terraform uses the dependency lock file `.teraform.lock.hcl` to track and select provider versions. Learn about dependency installation and lock file changes."
|
||||
---
|
||||
|
||||
# Dependency Lock File
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Conditional Expressions - Configuration Language"
|
||||
description: |-
|
||||
Conditional expressions in configurations select one of two values. You can use them to define defaults to replace invalid values.
|
||||
description: "Conditional expressions select one of two values. You can use them to define defaults to replace invalid values."
|
||||
---
|
||||
|
||||
# Conditional Expressions
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Dynamic Blocks - Configuration Language"
|
||||
description: |-
|
||||
`dynamic` blocks dynamically construct multi-level, nested block structures. Learn to configure `dynamic` blocks and understand their behavior.
|
||||
description: "`dynamic` blocks automatically construct multi-level, nested block structures. Learn to configure `dynamic` blocks and understand their behavior."
|
||||
---
|
||||
|
||||
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "For Expressions - Configuration Language"
|
||||
description: |-
|
||||
`for` expressions transform complex input values into complex output values. Learn how Terraform orders elements and how to filter inputs and group results.
|
||||
description: "`for` expressions transform complex input values into complex output values. Learn how to filter inputs and how to group results."
|
||||
---
|
||||
|
||||
# `for` Expressions
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Function Calls - Configuration Language"
|
||||
description: |-
|
||||
Function calls transform and combine values. Learn about Terraform's built-in functions.
|
||||
description: "Functions transform and combine values. Learn about Terraform's built-in functions."
|
||||
---
|
||||
|
||||
# Function Calls
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Expressions - Configuration Language"
|
||||
description: |-
|
||||
An overview of expressions you can use to reference or compute values in Terraform configurations, including types, operators, and functions.
|
||||
description: "An overview of expressions to reference or compute values in Terraform configurations, including types, operators, and functions."
|
||||
---
|
||||
|
||||
# Expressions
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Operators - Configuration Language"
|
||||
description: |-
|
||||
Operators transform or combine expressions. Learn about arithmetic, logical, equality, and comparison operators.
|
||||
description: "Operators transform or combine expressions. Learn about arithmetic, logical, equality, and comparison operators."
|
||||
---
|
||||
|
||||
# Arithmetic and Logical Operators
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "References to Values - Configuration Language"
|
||||
description: |-
|
||||
Reference named values in configurations, including resources, input variables, local and block-local values, module outputs, data sources, and workspace data.
|
||||
description: "Reference values in configurations, including resources, input variables, local and block-local values, module outputs, data sources, and workspace data."
|
||||
---
|
||||
|
||||
# References to Named Values
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Splat Expressions - Configuration Language"
|
||||
description: |-
|
||||
Splat expressions concisely express common operations. They also transform single, non-null values into a single-element tuple.
|
||||
description: "Splat expressions concisely represent common operations. In Terraform, they also transform single, non-null values into a single-element tuple."
|
||||
---
|
||||
|
||||
# Splat Expressions
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Strings and Templates - Configuration Language"
|
||||
description: |-
|
||||
String literals and template sequences interpolate values and manipulate text. Learn about both quoted and "heredoc" string syntax.
|
||||
description: "String literals and template sequences interpolate values and manipulate text. Learn about both quoted and heredoc string syntax."
|
||||
|
||||
---
|
||||
|
||||
# Strings and Templates
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Type Constraints - Configuration Language"
|
||||
sidebar_current: "docs-config-types"
|
||||
description: |-
|
||||
Learn how to use type constraints to validate user inputs to modules and resources.
|
||||
description: "Learn how to use type constraints to validate user inputs to modules and resources."
|
||||
---
|
||||
|
||||
# Type Constraints
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Types and Values - Configuration Language"
|
||||
description: |-
|
||||
Learn about value types and their syntax, including string, number, bool, list, and map. Also learn about complex types and type conversion.
|
||||
description: "Learn about value types and syntax, including string, number, bool, list, and map. Also learn about complex types and type conversion."
|
||||
---
|
||||
|
||||
# Types and Values
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Version Constraints - Configuration Language"
|
||||
description: |-
|
||||
Version constraint strings specify a range of acceptable versions for modules, providers, and Terraform itself. Learn version constraint syntax and behavior.
|
||||
description: "Version constraint strings specify a range of acceptable versions for modules, providers, and Terraform itself. Learn version constraint syntax and behavior."
|
||||
---
|
||||
|
||||
# Version Constraints
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Files and Directories - Configuration Language"
|
||||
description: |-
|
||||
Learn how to name, organize, and store Terraform configuration files as well as how Terraform evaluates modules.
|
||||
description: "Learn how to name, organize, and store Terraform configuration files. Also learn how Terraform evaluates modules."
|
||||
---
|
||||
|
||||
# Files and Directories
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Override Files - Configuration Language"
|
||||
sidebar_current: "docs-config-override"
|
||||
description: |-
|
||||
Override files merge additional settings into existing configuration objects. Learn how to use override files and about merging behavior.
|
||||
description: "Override files merge additional settings into existing configuration objects. Learn how to use override files and about merging behavior."
|
||||
---
|
||||
|
||||
# Override Files
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Functions - Configuration Language"
|
||||
sidebar_current: "docs-config-functions"
|
||||
description: |-
|
||||
An introduction to the built-in functions that you can use to transform and combine values in expressions.
|
||||
description: "An introduction to the built-in functions that you can use to transform and combine values in expressions."
|
||||
---
|
||||
|
||||
# Built-in Functions
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "The count Meta-Argument - Configuration Language"
|
||||
description: |-
|
||||
The `count` meta-argument helps you efficiently manage nearly identical infrastructure resources without writing a separate block for each one.
|
||||
description: "`count` helps you efficiently manage nearly identical infrastructure resources without writing a separate block for each one."
|
||||
---
|
||||
|
||||
# The `count` Meta-Argument
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "The depends_on Meta-Argument - Configuration Language"
|
||||
description: |-
|
||||
The `depends_on` meta-argument allows you to handle hidden resource or module dependencies.
|
||||
description: "`depends_on` allows you to handle hidden resource or module dependencies."
|
||||
---
|
||||
|
||||
# The `depends_on` Meta-Argument
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "The for_each Meta-Argument - Configuration Language"
|
||||
description: |-
|
||||
The `for_each` meta-argument allows you to efficiently manage similar infrastructure resources without writing a separate block for each one.
|
||||
description: "`for_each` allows you to efficiently manage similar infrastructure resources without writing a separate block for each one."
|
||||
---
|
||||
|
||||
# The `for_each` Meta-Argument
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "The lifecycle Meta-Argument - Configuration Language"
|
||||
description: |-
|
||||
The meta-arguments in a `lifecycle` block allow you to customize resource behavior. For example, preventing Terraform from destroying associated infrastructure.
|
||||
description: "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
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "The Module providers Meta-Argument - Configuration Language"
|
||||
description: |-
|
||||
The `providers` meta-argument specifies which provider configurations from a parent module are available inside a child module.
|
||||
description: "`providers` specifies which provider configurations from a parent module are available in a child module."
|
||||
---
|
||||
|
||||
# The Module `providers` Meta-Argument
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "The Resource provider Meta-Argument - Configuration Language"
|
||||
description: |-
|
||||
The `provider` meta-argument specifies which provider configuration Terraform should use for a resource.
|
||||
description: "`provider` specifies the provider configuration Terraform should use for a resource, overriding Terraform's default behavior."
|
||||
---
|
||||
|
||||
# The Resource `provider` Meta-Argument
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Creating Modules"
|
||||
sidebar_current: "docs-modules"
|
||||
description: |-
|
||||
Modules are containers for multiple resources that are used together in a configuration. Learn when to create modules and about module structure.
|
||||
description: "Modules are containers for multiple resources that are used together in a configuration. Learn when to create modules and about module structure."
|
||||
---
|
||||
|
||||
# Creating Modules
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Modules Overview - Configuration Language"
|
||||
description: |-
|
||||
Modules are containers for multiple resources that are used together in a configuration. Find resources for using, developing, and publishing modules.
|
||||
description: "Modules are containers for multiple resources that are used together in a configuration. Find resources for using, developing, and publishing modules."
|
||||
---
|
||||
|
||||
# Modules
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Module Sources"
|
||||
sidebar_current: "docs-modules-sources"
|
||||
description: |-
|
||||
The `source` argument tells Terraform where to find child modules in locations like GitHub, the Terraform Registry, Bitbucket, Git, Mercurial, S3, and GCS.
|
||||
description: "`source` tells Terraform where to find child modules in locations like GitHub, the Terraform Registry, Bitbucket, Git, Mercurial, S3, and GCS."
|
||||
---
|
||||
|
||||
# Module Sources
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Modules - Configuration Language"
|
||||
sidebar_current: "docs-config-modules"
|
||||
description: |-
|
||||
Modules are containers for multiple resources that are used together. Learn how to call one module from another in configurations.
|
||||
description: "Modules are containers for multiple resources that are used together in configurations. Learn how to call one module from another and access module output."
|
||||
---
|
||||
|
||||
# Module Blocks
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Provider Configuration - Configuration Language"
|
||||
sidebar_current: "docs-config-providers"
|
||||
description: |-
|
||||
Learn how to configure Terraform providers, including how to use the `alias` meta-argument to specify multiple configurations for a single provider.
|
||||
description: "Learn how to set up providers, including how to use the `alias` meta-argument to specify multiple configurations for a single provider."
|
||||
---
|
||||
|
||||
# Provider Configuration
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Providers - Configuration Language"
|
||||
description: |-
|
||||
An overview of how to install and use providers, Terraform plugins that interact with services, cloud providers, and other APIs.
|
||||
description: "An overview of how to install and use providers, Terraform plugins that interact with services, cloud providers, and other APIs."
|
||||
---
|
||||
|
||||
# Providers
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Provider Requirements - Configuration Language"
|
||||
description: |-
|
||||
Providers are plugins that allow Terraform to interact with remote systems. Learn how to declare providers in your configuration.
|
||||
description: "Providers are plugins that allow Terraform to interact with services, cloud providers, and other APIs. Learn how to declare providers in a configuration."
|
||||
---
|
||||
|
||||
# Provider Requirements
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Resource Behavior - Configuration Language"
|
||||
description: |-
|
||||
Learn how Terraform uses `resource` blocks to create infrastructure objects. Also learn about resource dependencies and accessing resource attributes.
|
||||
description: "Learn how Terraform uses `resource` blocks to create infrastructure objects. Also learn about resource dependencies and how to access resource attributes."
|
||||
---
|
||||
|
||||
# Resource Behavior
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Resources Overview - Configuration Language"
|
||||
description: |-
|
||||
An introduction to the `resources` element that describes infrastructure objects in Terraform configurations.
|
||||
description: "`resources` describe infrastructure objects in Terraform configurations. Find documentation for resource syntax, behavior, and meta-arguments."
|
||||
---
|
||||
|
||||
# Resources
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Provisioner Connection Settings"
|
||||
sidebar_current: "docs-provisioners-connection"
|
||||
description: |-
|
||||
The `connection` block allows you to manage provisioner connection defaults for SSH and WinRM.
|
||||
description: "The `connection` block allows you to manage provisioner connection defaults for SSH and WinRM."
|
||||
---
|
||||
|
||||
# Provisioner Connection Settings
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Provisioners Overview - Configuration Language"
|
||||
description: |-
|
||||
Provisioners model specific actions on a local or remote machine to prepare servers or other infrastructure for service.
|
||||
description: "Provisioners model specific actions on a local or remote machine to prepare servers or other infrastructure for service."
|
||||
---
|
||||
|
||||
# Provisioners
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Provisioners Without a Resource"
|
||||
sidebar_current: "docs-provisioners-null-resource"
|
||||
description: |-
|
||||
'null_resource' allows you to configure Terraform provisioners that are not directly associated with a single existing resource.
|
||||
description: "'null_resource' allows you to configure provisioners that are not directly associated with a single existing resource."
|
||||
---
|
||||
|
||||
# Provisioners Without a Resource
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Provisioners"
|
||||
sidebar_current: "docs-provisioners"
|
||||
description: |-
|
||||
Provisioners run scripts on a local or remote machine during resource creation or destruction. Learn how to declare provisioners in a configuration.
|
||||
description: "Provisioners run scripts on a local or remote machine during resource creation or destruction. Learn how to declare provisioners in a configuration."
|
||||
---
|
||||
|
||||
# Provisioners
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Resources - Configuration Language"
|
||||
sidebar_current: "docs-config-resources"
|
||||
description: |-
|
||||
Resources correspond to infrastructure objects like virtual networks or compute instances. Learn about resource types, syntax, behavior, and arguments.
|
||||
description: "Resources correspond to infrastructure objects like virtual networks or compute instances. Learn about resource types, syntax, behavior, and arguments."
|
||||
---
|
||||
|
||||
# Resource Blocks
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Backend Overview - Configuration Language"
|
||||
description: |-
|
||||
A backend defines where and how Terraform performs operations, such as where it stores state files. Learn about recommended backends and how backends work.
|
||||
description: "A backend defines where and how Terraform performs operations, such as where it stores state files. Learn about recommended backends and how backends work."
|
||||
---
|
||||
|
||||
# Backends
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Terraform Settings - Configuration Language"
|
||||
sidebar_current: "docs-config-terraform"
|
||||
description: |-
|
||||
The `terraform` block allows you to configure Terraform behavior, including the Terraform version, backend, and required providers.
|
||||
description: "The `terraform` block allows you to configure Terraform behavior, including the Terraform version, backend, and required providers."
|
||||
---
|
||||
|
||||
# Terraform Settings
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "State"
|
||||
sidebar_current: "docs-state"
|
||||
description: |-
|
||||
An introduction to state, information that Terraform uses to map resources to a configuration, track metadata, and improve performance.
|
||||
description: "An introduction to state, information that Terraform uses to map resources to a configuration, track metadata, and improve performance."
|
||||
---
|
||||
|
||||
# State
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Syntax - Configuration Language"
|
||||
sidebar_current: "docs-config-syntax"
|
||||
description: |-
|
||||
Key constructs of the native Terraform language syntax, including identifiers, arguments, blocks, and comments.
|
||||
description: "Key constructs of the native Terraform language syntax, including identifiers, arguments, blocks, and comments."
|
||||
---
|
||||
|
||||
# Configuration Syntax
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Syntax Overview - Configuration Language"
|
||||
description: |-
|
||||
Terraform language syntax for both the native and JSON variants. Also formatting conventions that you can enforce with `terraform fmt`.
|
||||
description: "Terraform language syntax for both the native and JSON variants. Also learn formatting conventions that you can enforce with `terraform fmt`."
|
||||
---
|
||||
|
||||
# Syntax
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "JSON Configuration Syntax - Configuration Language"
|
||||
sidebar_current: "docs-config-syntax-json"
|
||||
description: |-
|
||||
Details about the JSON-compatible language syntax, including file structure, expression mapping, block mapping, and block-type-specific exceptions.
|
||||
description: "Learn about the JSON-compatible language syntax, including file structure, expression mapping, block mapping, and block-type-specific exceptions."
|
||||
---
|
||||
|
||||
# JSON Configuration Syntax
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Style Conventions - Configuration Language"
|
||||
sidebar_current: "docs-config-style"
|
||||
description: |-
|
||||
Recommended formatting conventions for the Terraform language.
|
||||
description: "Learn recommended formatting conventions for the Terraform language and a command to automatically enforce them."
|
||||
---
|
||||
|
||||
# Style Conventions
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
layout: "language"
|
||||
page_title: "Variables and Outputs"
|
||||
description: |-
|
||||
An overview of input variables, output values, and local values in Terraform language.
|
||||
description: "An overview of input variables, output values, and local values in Terraform language."
|
||||
---
|
||||
|
||||
# Variables and Outputs
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Local Values - Configuration Language"
|
||||
sidebar_current: "docs-config-locals"
|
||||
description: |-
|
||||
Local values assign a name to an expression that can be used multiple times within a Terraform module.
|
||||
description: "Local values assign a name to an expression that can be used multiple times within a Terraform module."
|
||||
---
|
||||
|
||||
# Local Values
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Input Variables - Configuration Language"
|
||||
sidebar_current: "docs-config-variables"
|
||||
description: |-
|
||||
Input variables allow you to customize modules without altering their source code. Learn how to declare, define, and reference variables in configurations.
|
||||
description: "Input variables allow you to customize modules without altering their source code. Learn how to declare, define, and reference variables in configurations."
|
||||
---
|
||||
|
||||
# Input Variables
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
layout: "language"
|
||||
page_title: "Provider Documentation"
|
||||
sidebar_current: "docs-providers"
|
||||
description: |-
|
||||
Pointers to provider documentation on the Terraform Registry and to information about how to create documentation for your provider.
|
||||
description: "Find provider documentation on the Terraform Registry and information about creating documentation for your provider."
|
||||
---
|
||||
|
||||
# Provider Documentation
|
||||
|
@ -12,6 +11,5 @@ description: |-
|
|||
Every Terraform provider has its own documentation on the [Terraform Registry](https://registry.terraform.io/browse/providers) that describes its resource types and their arguments.
|
||||
|
||||
## Write Provider Docs
|
||||
Learn more about writing, generating, and rendering provider documentation
|
||||
in the [provider publishing documentation](/docs/registry/providers/docs.html).
|
||||
Learn more about [writing, generating, and rendering provider documentation](/docs/registry/providers/docs.html).
|
||||
|
||||
|
|
Loading…
Reference in New Issue