Merge pull request #29216 from hashicorp/laura-description-metadata-cli

Laura description metadata cli
This commit is contained in:
Laura Pacilio 2021-07-30 14:49:36 -04:00 committed by GitHub
commit 5b07bb7040
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
51 changed files with 57 additions and 70 deletions

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Authentication - Terraform CLI"
description: "Documentation about the login and logout commands that help automate getting an API token for your Terraform Cloud account."
---
# CLI Authentication

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Writing and Modifying Code - Terraform CLI"
description: "Learn commands that help validate, format, and upgrade code written in the Terraform Configuration Language."
---
# Writing and Modifying Terraform Code

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: apply"
sidebar_current: "docs-commands-apply"
description: |-
The `terraform apply` command executes the actions proposed in a Terraform plan.
description: "The terraform apply command executes the actions proposed in a Terraform plan to create, update, or destroy infrastructure."
---
# Command: apply

View File

@ -2,9 +2,8 @@
layout: "docs"
page_title: "Command: console"
sidebar_current: "docs-commands-console"
description: |-
The `terraform console` command provides an interactive console for
evaluting expressions.
description: "The terraform console command provides an interactive console for
evaluating expressions."
---
# Command: console

View File

@ -2,9 +2,7 @@
layout: "docs"
page_title: "Command: destroy"
sidebar_current: "docs-commands-destroy"
description: |-
The `terraform destroy` command is a convenient way to destroy all objects
managed by a particular Terraform configuration.
description: "The terraform destroy command destroys all objects managed by a Terraform configuration."
---
# Command: destroy

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: env"
sidebar_current: "docs-commands-envcmd"
description: |-
The terraform env command is a deprecated, legacy form of "terraform workspace".
description: "The terraform env command is a deprecated form of the terraform workspace command."
---
# Command: env

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: fmt"
sidebar_current: "docs-commands-fmt"
description: |-
The `terraform fmt` command is used to rewrite Terraform configuration files to a canonical format and style.
description: "The terraform fmt command rewrites configuration files to a canonical format and style."
---
# Command: fmt

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: force-unlock"
sidebar_current: "docs-commands-force-unlock"
description: |-
The `terraform force-unlock` manually unlocks the Terraform state
description: "The terraform force-unlock command unlocks the state for a configuration. It does not modify your infrastructure."
---
# Command: force-unlock

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: get"
sidebar_current: "docs-commands-get"
description: |-
The `terraform get` command is used to download and update modules.
description: "The terraform get command downloads and updates modules."
---
# Command: get

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: graph"
sidebar_current: "docs-commands-graph"
description: |-
The `terraform graph` command is used to generate a visual representation of either a configuration or execution plan. The output is in the DOT format, which can be used by GraphViz to generate charts.
description: "The terraform graph command generates a visual representation of a configuration or execution plan that you can use to generate charts."
---
# Command: graph

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: import"
sidebar_current: "docs-commands-import"
description: |-
The `terraform import` command is used to import existing resources into Terraform.
description: "The terraform import command brings existing resources into Terraform state."
---
# Command: import

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Basic CLI Features"
sidebar_current: "docs-commands"
description: |-
Main usage information for the Terraform CLI tool.
description: "An introduction to the terraform command and its available subcommands."
---
# Basic CLI Features

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: init"
sidebar_current: "docs-commands-init"
description: |-
The `terraform init` command is used to initialize a Terraform configuration. This is the first command that should be run for any new or existing Terraform configuration. It is safe to run this command multiple times.
description: "The terraform init command initializes a working directory containing configuration files and installs plugins for required providers."
---
# Command: init
@ -80,7 +79,7 @@ is initialized using the given configuration settings.
Re-running init with an already-initialized backend will update the working
directory to use the new backend settings. Either `-reconfigure` or
`-migrate-state` must be supplied to update the backend configuration.
`-migrate-state` must be supplied to update the backend configuration.
The `-migrate-state` option will attempt to copy existing state to the new
backend, and depending on what changed, may result in interactive prompts to

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: plan"
sidebar_current: "docs-commands-plan"
description: |-
The terraform plan command creates an execution plan.
description: "The terraform plan command creates an execution plan with a preview of the changes that Terraform will make to your infrastructure."
---
# Command: plan

View File

@ -2,9 +2,7 @@
layout: "docs"
page_title: "Command: providers"
sidebar_current: "docs-commands-providers"
description: |-
The `terraform providers` command prints information about the providers used
in the current configuration.
description: "The terraform providers command prints information about the providers required in the current configuration."
---
# Command: providers

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Command: version"
sidebar_current: "docs-commands-version"
description: |-
The `terraform version` command displays the version of Terraform and all installed plugins.
description: "The terraform version command displays the Terraform version and the version of all installed plugins."
---
# Command: version
@ -21,10 +20,10 @@ and security checks [unless disabled](/docs/cli/commands/index.html#upgrade-and-
This command has one optional flag:
* `-json` - If specified, the version information is formatted as a JSON object,
* `-json` - If specified, the version information is formatted as a JSON object,
and no upgrade or security information is included.
-> **Note:** Platform information was added to the `version` command in Terraform 0.15.
-> **Note:** Platform information was added to the `version` command in Terraform 0.15.
## Example

View File

@ -2,8 +2,8 @@
layout: "docs"
page_title: "Command: workspace"
sidebar_current: "docs-commands-workspace-index"
description: |-
The terraform workspace command is used to manage workspaces.
description: "The workspace command helps you manage workspaces."
---
# Command: workspace

View File

@ -2,9 +2,7 @@
layout: "docs"
page_title: "CLI Configuration"
sidebar_current: "docs-commands-cli-config"
description: |-
The general behavior of the Terraform CLI can be customized using the CLI
configuration file.
description: "Learn to use the CLI configuration file to customize your CLI settings, including credentials, plugin caching, provider installation methods, etc."
---
# CLI Configuration File (`.terraformrc` or `terraform.rc`)
@ -360,7 +358,7 @@ grow to contain several unused versions which you must delete manually.
-> **Note:** The plugin cache directory is not guaranteed to be concurrency
safe. The provider installer's behavior in environments with multiple `terraform
init` calls is undefined.
init` calls is undefined.
### Development Overrides for Provider Developers

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Environment Variables"
sidebar_current: "docs-commands-environment-variables"
description: |-
Terraform uses environment variables to configure various aspects of its behavior.
description: "Learn to use environment variables to change Terraform's default behavior. Configure log content and output, set variables, and more."
---
# Environment Variables

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "CLI Configuration - Terraform CLI"
description: "Find documentation about the CLI config file and customizing Terraform environment variables."
---
# CLI Configuration

View File

@ -2,10 +2,7 @@
layout: "docs"
page_title: "Import"
sidebar_current: "docs-import"
description: |-
Terraform is able to import existing infrastructure. This allows you take
resources you've created by some other means and bring it under Terraform
management.
description: "Terraform can import and manage existing infrastructure. This can help you transition your infrastructure to Terraform."
---
# Import

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Terraform CLI Documentation"
sidebar_current: "docs-home"
description: |-
Documentation for Terraform's CLI-based workflows.
description: "Learn how to use Terraform's CLI-based workflows. You can use the CLI alone or in conjunction with Terraform Cloud or Terraform Enterprise."
---
# Terraform CLI Documentation

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Initializing Working Directories - Terraform CLI"
description: "Working directories contain configurations, settings, cached plugins and modules, and state data. Learn how to initialize and manage working directories."
---
# Initializing Working Directories

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Inspecting Infrastructure - Terraform CLI"
description: "Learn commands to inspect dependency information, outputs, etc. Use them for integration or to understand your infrastructure."
---
# Inspecting Infrastructure

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Managing Plugins - Terraform CLI"
description: "Commands to install, configure, and show information about providers. Also commands to reduce install effort in air-gapped environments."
---
# Managing Plugins

View File

@ -1,8 +1,7 @@
---
layout: "docs"
page_title: "Plugin Signing"
description: |-
Terraform plugin signing trust levels
description: "Learn about the types of signatures providers can have on the Terraform Registry."
---
<!-- THIS PAGED IS LINKED TO IN THE CLI -->

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Provisioning Infrastructure - Terraform CLI"
description: "Learn about commands for core provisioning tasks: plan, apply, and destroy."
---
# Provisioning Infrastructure with Terraform

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Manipulating State - Terraform CLI"
description: "State data tracks which real-world object corresponds to each resource. Inspect state, move or import resources, and more."
---
# Manipulating Terraform State

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Inspecting State - Terraform CLI"
description: "Commands that allow you to read and update state."
---
# Inspecting State

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Moving Resources - Terraform CLI"
description: "Commands that allow you to manage the way that resources are tracked in state. They are helpful when you move or change resources."
---
# Moving Resources

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Recovering from State Disasters - Terraform CLI"
descriptin: "Commands that allow you to restore state backups and override Terraform state protections."
---
# Recovering from State Disasters

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Forcing Re-creation of Resources (Tainting) - Terraform CLI"
description: "Commands that allow you to destroy and re-create resources manually."
---
# Forcing Re-creation of Resources (Tainting)

View File

@ -1,6 +1,7 @@
---
layout: "docs"
page_title: "Managing Workspaces - Terraform CLI"
description: "Commands to list, select, create, and output workspaces. Workspaces help manage different groups of resources with one configuration."
---
# Managing Workspaces

View File

@ -2,8 +2,7 @@
layout: "docs"
page_title: "Internals"
sidebar_current: "docs-internals"
description: |-
This section covers the internals of Terraform and explains how plans are generated, the lifecycle of a provider, etc. The goal of this section is to remove any notion of "magic" from Terraform. We want you to be able to trust and understand what Terraform is doing to function.
description: "Learn the technical details of how Terraform generates and executes infrastructure plans, works with plugins, obtains credentials, etc."
---
# Terraform Internals

View File

@ -1,7 +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

View File

@ -1,7 +1,7 @@
---
layout: "language"
page_title: "Dynamic Blocks - Configuration Language"
description: "`dynamic` blocks automatically 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."
---

View File

@ -1,7 +1,7 @@
---
layout: "language"
page_title: "For Expressions - Configuration Language"
description: "`for` expressions transform complex input values into complex output values. Learn how to filter inputs and how to 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

View File

@ -1,7 +1,7 @@
---
layout: "language"
page_title: "The count Meta-Argument - Configuration Language"
description: "`count` 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

View File

@ -1,7 +1,7 @@
---
layout: "language"
page_title: "The depends_on Meta-Argument - Configuration Language"
description: "`depends_on` allows you to handle hidden resource or module dependencies."
description: "The depends_on meta-argument allows you to handle hidden resource or module dependencies."
---
# The `depends_on` Meta-Argument

View File

@ -1,7 +1,7 @@
---
layout: "language"
page_title: "The for_each Meta-Argument - Configuration Language"
description: "`for_each` allows you to efficiently manage similar infrastructure resources without writing a separate block for each one."
description: "The for_each meta-argument allows you to manage similar infrastructure resources without writing a separate block for each one."
---
# The `for_each` Meta-Argument

View File

@ -1,7 +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."
---
# The `lifecycle` Meta-Argument

View File

@ -1,7 +1,7 @@
---
layout: "language"
page_title: "The Module providers Meta-Argument - Configuration Language"
description: "`providers` specifies which provider configurations from a parent module are available in a child module."
description: "The providers meta-argument specifies which provider configurations from a parent module are available in a child module."
---
# The Module `providers` Meta-Argument

View File

@ -1,7 +1,7 @@
---
layout: "language"
page_title: "The Resource provider Meta-Argument - Configuration Language"
description: "`provider` specifies the provider configuration Terraform should use for a resource, overriding Terraform's default behavior."
description: "The provider meta-argument specifies the provider configuration Terraform should use for a resource, overriding Terraform's default behavior."
---
# The Resource `provider` Meta-Argument
@ -56,4 +56,3 @@ The `provider` meta-argument expects
which does not need to be quoted. Arbitrary expressions are not permitted for
`provider` because it must be resolved while Terraform is constructing the
dependency graph, before it is safe to evaluate expressions.

View File

@ -2,7 +2,7 @@
layout: "language"
page_title: "Module Sources"
sidebar_current: "docs-modules-sources"
description: "`source` tells Terraform where to find 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's configurations in locations like GitHub, the Terraform Registry, Bitbucket, Git, Mercurial, S3, and GCS."
---
# Module Sources

View File

@ -2,7 +2,7 @@
layout: "language"
page_title: "Provider Configuration - Configuration Language"
sidebar_current: "docs-config-providers"
description: "Learn how to set up 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

View File

@ -1,7 +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 how to access 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

View File

@ -1,7 +1,7 @@
---
layout: "language"
page_title: "Resources Overview - Configuration Language"
description: "`resources` describe infrastructure objects in Terraform configurations. Find documentation for resource syntax, behavior, and meta-arguments."
description: "Resources describe infrastructure objects in Terraform configurations. Find documentation for resource syntax, behavior, and meta-arguments."
---
# Resources

View File

@ -2,7 +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

View File

@ -2,7 +2,7 @@
layout: "language"
page_title: "Provisioners Without a Resource"
sidebar_current: "docs-provisioners-null-resource"
description: "'null_resource' allows you to configure provisioners that are not directly associated with a single existing resource."
description: "A null_resource allows you to configure provisioners that are not directly associated with a single existing resource."
---
# Provisioners Without a Resource

View File

@ -2,7 +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

View File

@ -1,7 +1,7 @@
---
layout: "language"
page_title: "Syntax Overview - Configuration Language"
description: "Terraform language syntax for both the native and JSON variants. Also learn 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