From 3b15748662d2b9d90b0a05751ab2e70f1dcf5826 Mon Sep 17 00:00:00 2001 From: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> Date: Fri, 13 Dec 2024 13:48:44 -0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: rita <8647768+ritsok@users.noreply.github.com> --- website/docs/cli/auth/index.mdx | 8 ++++---- website/docs/cli/cloud/index.mdx | 4 ++-- website/docs/cli/code/index.mdx | 6 +++--- website/docs/cli/commands/index.mdx | 2 +- website/docs/cli/config/index.mdx | 1 - website/docs/cli/import/index.mdx | 4 ++-- website/docs/cli/inspect/index.mdx | 2 +- website/docs/cli/plugins/index.mdx | 2 +- website/docs/cli/run/index.mdx | 4 ++-- website/docs/cli/state/inspect.mdx | 2 +- website/docs/cli/state/move.mdx | 2 +- website/docs/cli/state/recover.mdx | 2 +- website/docs/cli/state/taint.mdx | 2 +- website/docs/cli/test/index.mdx | 2 +- website/docs/cli/workspaces/index.mdx | 2 +- website/docs/internals/index.mdx | 2 +- website/docs/internals/json-format.mdx | 4 ++-- website/docs/internals/machine-readable-ui.mdx | 2 +- website/docs/internals/provider-registry-protocol.mdx | 2 +- website/docs/intro/vs/boto.mdx | 2 +- 20 files changed, 28 insertions(+), 29 deletions(-) diff --git a/website/docs/cli/auth/index.mdx b/website/docs/cli/auth/index.mdx index 2b1f70a3e5..b32e3dac1f 100644 --- a/website/docs/cli/auth/index.mdx +++ b/website/docs/cli/auth/index.mdx @@ -1,5 +1,5 @@ --- -page_title: Get an API token for HCP Terraform and Terraform Enterprise +page_title: Get an API token for HCP Terraform or Terraform Enterprise description: >- Use the terraform login and terraform logout commands get an API token for your HCP Terraform or Terraform Enterprise account. @@ -18,7 +18,7 @@ This topic describes how to use the `terraform login` and `terraform logout` to Terraform runs to provision infrastructure, offering a collaboration-focused environment that makes it easier for teams to use Terraform together. -You can integrate the Terraform CLI with Terraform web platform in the following ways: +You can integrate the Terraform CLI with HCP Terraform and Terraform Enterprise in the following ways: - Use the Terraform CLI as a front-end for [CLI-driven runs](/terraform/cloud-docs/run/cli) in HCP Terraform - Use HCP Terraform or Terraform Enterprise as a state backend and a private module registry. @@ -28,6 +28,6 @@ with your HCP Terraform account. ## Authentication -Run the `terraform login` command to automate the process of getting an API token for your HCP Terraform user account. Refer to the [`terraform login` command](/terraform/cli/commands/login) reference documentation for details. +Run the `terraform login` command to generate an API token for your HCP Terraform user account. Refer to the [`terraform login` command](/terraform/cli/commands/login) reference documentation for details. -Run the `terrafom logout` coommand to end your HCP Terraform or Terraform Enterprise session. Refer to the [`terraform logout` command](/terraform/cli/commands/logout) reference documentation for details. +Run the `terraform logout` command to end your HCP Terraform or Terraform Enterprise session. Refer to the [`terraform logout` command](/terraform/cli/commands/logout) reference documentation for details. diff --git a/website/docs/cli/cloud/index.mdx b/website/docs/cli/cloud/index.mdx index e97651d4f4..a8c93cb532 100644 --- a/website/docs/cli/cloud/index.mdx +++ b/website/docs/cli/cloud/index.mdx @@ -1,10 +1,10 @@ --- -page_title: Use HCP Terraform and Terraform Enterprise with Terraform CLI overview +page_title: Use HCP Terraform or Terraform Enterprise with the Terraform CLI description: >- Learn how to use HCP Terraform and Terraform Enterprise on the command line with the Terraform CLI. --- -# Use HCP Terraform with Terraform CLI Overview +# Use HCP Terraform with the Terraform CLI The Terraform CLI integration with HCP Terraform lets you use HCP Terraform and Terraform Enterprise on the command line. In the documentation HCP Terraform instructions also apply to Terraform Enterprise, except where explicitly stated. diff --git a/website/docs/cli/code/index.mdx b/website/docs/cli/code/index.mdx index 032e975a6d..8d6e086138 100644 --- a/website/docs/cli/code/index.mdx +++ b/website/docs/cli/code/index.mdx @@ -1,13 +1,13 @@ --- -page_title: Format and validate Terraform configuration from the CLI +page_title: Format and validate Terraform configuration using the Terraform CLI description: >- - Learn about the Terraform commands that help validate, format, and upgrade code written in the + Learn about the Terraform commands that validate, format, and upgrade code written in HCL. Terraform configuration language. --- # Write and modify Terrafrom configuration from the CLI -This topic provides an overview of the Terraform CLI commands you can use to programmatically write and modify Terraform configuration code. +This topic provides an overview of the Terraform CLI commands you can use to develop, format, and validate your Terraform configuration. ## Introduction diff --git a/website/docs/cli/commands/index.mdx b/website/docs/cli/commands/index.mdx index d26b5dc293..3f0c33948e 100644 --- a/website/docs/cli/commands/index.mdx +++ b/website/docs/cli/commands/index.mdx @@ -5,7 +5,7 @@ description: The Terrafrom CLI includes commands for provisioning infrastructure # Terraform CLI Overview -This topic provides an overview of the Terraform command line. +This topic provides an overview of the Terraform command line interface. > **Hands-on:** Try the [Terraform: Get Started](/terraform/tutorials/aws-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorials. diff --git a/website/docs/cli/config/index.mdx b/website/docs/cli/config/index.mdx index fbe40f3a51..117d55825e 100644 --- a/website/docs/cli/config/index.mdx +++ b/website/docs/cli/config/index.mdx @@ -2,7 +2,6 @@ page_title: Terraform CLI configuration overview description: >- The CLI config-file and supported Terraform environment variables let you customize Terraform CLI behavior. - Learn how Terraform CLI configuration works. --- # Terraform CLI configuration overview diff --git a/website/docs/cli/import/index.mdx b/website/docs/cli/import/index.mdx index 22af5cbe66..6d1e7b13a3 100644 --- a/website/docs/cli/import/index.mdx +++ b/website/docs/cli/import/index.mdx @@ -1,7 +1,7 @@ --- -page_title: Import existing infrastructure resources overview +page_title: Import existing infrastructure resources description: >- - The Terraform import features let you import and manage existing infrastructure resources so that you can begin managing your infrastructure as code. + Terraform lets you import existing infrastructure into state so that you can begin managing your infrastructure as code. --- # Import existing resources overview diff --git a/website/docs/cli/inspect/index.mdx b/website/docs/cli/inspect/index.mdx index 6397de7fbf..cd323c1724 100644 --- a/website/docs/cli/inspect/index.mdx +++ b/website/docs/cli/inspect/index.mdx @@ -1,5 +1,5 @@ --- -page_title: Inspect infrastructure commands overview +page_title: Inspect infrastructure description: >- The terraform inspect commands return dependency information and outputs. Learn how to use terraform inspect commands to understand your infrastructure. diff --git a/website/docs/cli/plugins/index.mdx b/website/docs/cli/plugins/index.mdx index 8ff267cb01..82f8bb3203 100644 --- a/website/docs/cli/plugins/index.mdx +++ b/website/docs/cli/plugins/index.mdx @@ -1,5 +1,5 @@ --- -page_title: Manage Terraform plugins overview +page_title: Manage Terraform plugins description: >- Providers are types of plugins for Terraform that manage infrastructure resources. Learn about managing plugins using the Terraform CLI. --- diff --git a/website/docs/cli/run/index.mdx b/website/docs/cli/run/index.mdx index 77b852ca8b..e919307581 100644 --- a/website/docs/cli/run/index.mdx +++ b/website/docs/cli/run/index.mdx @@ -1,6 +1,6 @@ --- -page_title: Terraform workflow for provisioning infrastructure overview -description: Learn about the Terraform workflow for provisioning infrastructure using core commands from the Terraform CLI. +page_title: Terraform workflow for provisioning infrastructure +description: Learn how to use the Terraform CLI to provision infrastructure. --- # Terraform workflow for provisioning infrastructure overview diff --git a/website/docs/cli/state/inspect.mdx b/website/docs/cli/state/inspect.mdx index dd9accd2d4..74f200ca50 100644 --- a/website/docs/cli/state/inspect.mdx +++ b/website/docs/cli/state/inspect.mdx @@ -1,5 +1,5 @@ --- -page_title: Inspect Terraform state overview +page_title: Inspect Terraform state description: The `terraform state` group of commands help you inspect Terraform state. Learn how inspecting Terraform state can help you read and update state. --- diff --git a/website/docs/cli/state/move.mdx b/website/docs/cli/state/move.mdx index 5256be914b..252184d103 100644 --- a/website/docs/cli/state/move.mdx +++ b/website/docs/cli/state/move.mdx @@ -1,5 +1,5 @@ --- -page_title: Move resources overview +page_title: Move resources description: >- Terraform state commands can move and remove resources and transfer existing resources to a different provider. Learn how about changing or moving resources. --- diff --git a/website/docs/cli/state/recover.mdx b/website/docs/cli/state/recover.mdx index 68155abe8f..8189731d88 100644 --- a/website/docs/cli/state/recover.mdx +++ b/website/docs/cli/state/recover.mdx @@ -1,5 +1,5 @@ --- -page_title: Recover state from backup overview +page_title: Recover state from backup description: >- Learn how to restore state backups and override Terraform state protections to fix state errors with the Terraform CLI. --- diff --git a/website/docs/cli/state/taint.mdx b/website/docs/cli/state/taint.mdx index 42673141f9..cb3e06d7dc 100644 --- a/website/docs/cli/state/taint.mdx +++ b/website/docs/cli/state/taint.mdx @@ -1,5 +1,5 @@ --- -page_title: Recreate resources overview +page_title: Recreate resources description: The -replace flag and taint command help you replace infrastructure objects. Learn how the -replace flag and taint command can help you recreate resources. --- diff --git a/website/docs/cli/test/index.mdx b/website/docs/cli/test/index.mdx index 7eeebd6c32..08177edce9 100644 --- a/website/docs/cli/test/index.mdx +++ b/website/docs/cli/test/index.mdx @@ -1,5 +1,5 @@ --- -page_title: Testing features in Terraform overview +page_title: Testing features in Terraform description: >- Learn about the terraform test command, which runs structured tests and validations for your configuration to ensure correctness in your infrastructure. diff --git a/website/docs/cli/workspaces/index.mdx b/website/docs/cli/workspaces/index.mdx index b776fcb45c..3baca17bd4 100644 --- a/website/docs/cli/workspaces/index.mdx +++ b/website/docs/cli/workspaces/index.mdx @@ -1,5 +1,5 @@ --- -page_title: Manage workspaces overview +page_title: Manage workspaces description: >- Workspaces are separate instances of Terraform state data. Learn commands for managing workspaces. --- diff --git a/website/docs/internals/index.mdx b/website/docs/internals/index.mdx index 57c250fe75..f025c4b7d0 100644 --- a/website/docs/internals/index.mdx +++ b/website/docs/internals/index.mdx @@ -1,5 +1,5 @@ --- -page_title: Terraform internals overview +page_title: Terraform internals description: >- Learn about internal Terraform processes, such as generating the resource dependency graph. --- diff --git a/website/docs/internals/json-format.mdx b/website/docs/internals/json-format.mdx index 584cdf049c..815f89afab 100644 --- a/website/docs/internals/json-format.mdx +++ b/website/docs/internals/json-format.mdx @@ -1,7 +1,7 @@ --- -page_title: JSON output format overview +page_title: JSON output format description: >- - Terraform can print details about state, configuration, and proposed infrastructure plans to the terminal in JSON format. Learn about the JSON representation. + Learn how to configure Terraform to print JSON-formatted details about state, configuration, and proposed infrastructure plans. --- # JSON Output Format Overview diff --git a/website/docs/internals/machine-readable-ui.mdx b/website/docs/internals/machine-readable-ui.mdx index 99af5e1091..05f4c20fb2 100644 --- a/website/docs/internals/machine-readable-ui.mdx +++ b/website/docs/internals/machine-readable-ui.mdx @@ -1,7 +1,7 @@ --- page_title: Machine-readable output reference description: >- - Terraform provides streamd machine-readable UI output in JSON format so that you can integrate with monitoring software. Learn about the machine-readlable output. + Terraform streams machine-readable output in JSON format, letting you use third-party tools to monitor operations. --- # Machine-readable UI Output Reference diff --git a/website/docs/internals/provider-registry-protocol.mdx b/website/docs/internals/provider-registry-protocol.mdx index c832e48254..a8acc4e948 100644 --- a/website/docs/internals/provider-registry-protocol.mdx +++ b/website/docs/internals/provider-registry-protocol.mdx @@ -1,7 +1,7 @@ --- page_title: Provider registry protocol reference description: |- - Use the provider registry protocol to enable Terraform to discover metadata about providers available for installation and to locate their distribution packages. + Use the provider registry protocol to enable Terraform to discover metadata about available providers and locate their distribution packages. --- # Provider Registry Protocol Reference diff --git a/website/docs/intro/vs/boto.mdx b/website/docs/intro/vs/boto.mdx index 588de6f3b0..698e10a28d 100644 --- a/website/docs/intro/vs/boto.mdx +++ b/website/docs/intro/vs/boto.mdx @@ -1,6 +1,6 @@ --- page_title: Terraform versus Boto, Fog, and other cloud provider client libraries -description: Learn how Terraform's high level syntax compares to Boto, Flog, and other cloud provider client libraries. +description: Learn how Terraform's syntax compares to Boto, Flog, and other cloud provider client libraries. --- # Terraform versus Boto, Fog, and other cloud provider client libraries