From 772e8fdd358e5f8a9f6301f375dc854f3ebccb18 Mon Sep 17 00:00:00 2001 From: Christian Adamini Date: Mon, 19 May 2025 22:40:19 +0200 Subject: [PATCH] Simplify docs/cli/code/index texts (#35183) --- website/docs/cli/code/index.mdx | 36 ++++++++++++++++----------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/website/docs/cli/code/index.mdx b/website/docs/cli/code/index.mdx index bc681b34e5..2863c9d4a7 100644 --- a/website/docs/cli/code/index.mdx +++ b/website/docs/cli/code/index.mdx @@ -1,7 +1,6 @@ --- page_title: Format and validate Terraform configuration using the Terraform CLI -description: >- - Learn about the Terraform commands that validate, format, and upgrade code written in HCL. +description: Learn about the Terraform commands that validate, format, and upgrade code written in HCL. --- # Write and modify Terrafrom configuration from the CLI @@ -17,33 +16,32 @@ in the Terraform language. ## Workflows Terraform CLI includes several commands to make Terraform code more convenient -to work with. Integrating these commands into your editing workflow can -potentially save you time and effort. +to work with. You can integrate the following commands into your editing +workflow to test expressions and format and validate your configuration syntax: -- [The `terraform console` command](/terraform/cli/commands/console) starts an +- The [`terraform console`](/terraform/cli/commands/console) command starts an interactive shell for evaluating Terraform - [expressions](/terraform/language/expressions), which can be a faster way - to verify that a particular resource argument results in the value you expect. + [expressions](/terraform/language/expressions), to quickly verify that a + particular resource argument results in the value you expect. -- [The `terraform fmt` command](/terraform/cli/commands/fmt) rewrites Terraform +- The [`terraform fmt`](/terraform/cli/commands/fmt) command automatically rewrites Terraform configuration files to a canonical format and style, so you don't have to - waste time making minor adjustments for readability and consistency. It works + waste time making minor adjustments for readability and consistency. The `terraform fmt` command works well as a pre-commit hook in your version control system. -- [The `terraform validate` command](/terraform/cli/commands/validate) validates the +- The [`terraform validate`](/terraform/cli/commands/validate) commands validates the syntax and arguments of the Terraform configuration files in a directory, including argument and attribute names and types for resources and modules. The `plan` and `apply` commands automatically validate a configuration before - performing any other work, so `validate` isn't a crucial part of the core - workflow, but it can be very useful as a pre-commit hook or as part of a + performing any other work. Running `validate` isn't a crucial part of the core + workflow but can be very useful as a pre-commit hook or as part of a continuous integration pipeline. -- [The `0.13upgrade` command](/terraform/cli/commands/0.13upgrade) and - [the `0.12upgrade` command](/terraform/cli/commands/0.12upgrade) can automatically - modify the configuration files in a Terraform module to help deal with major +- The [`0.13upgrade`](/terraform/cli/commands/0.13upgrade) and + [`0.12upgrade`](/terraform/cli/commands/0.12upgrade) commands modify the configuration files in a Terraform module automatically to help deal with major syntax changes that occurred in the 0.13 and 0.12 releases of Terraform. Both - of these commands are only available in the Terraform version they are - associated with, and you are expected to upgrade older code to be compatible + commands are only available in the Terraform version they are + associated with. Make sure to upgrade older code to be compatible with 0.12 before attempting to make it compatible with 0.13. For more detailed - information about updating code for new Terraform versions, see the [upgrade - guides](/terraform/language/upgrade-guides) in the Terraform language docs. + information about updating code for new Terraform versions, refer to the [upgrade + guides](/terraform/language/upgrade-guides).