Simplify docs/cli/code/index texts #35183
Conversation
| @@ -15,30 +15,29 @@ 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. | |||
|
|
|||
| - [The `terraform console` command](/terraform/cli/commands/console) starts an | |||
| - [`terraform console`](/terraform/cli/commands/console): Start an | |||
There was a problem hiding this comment.
Review note:
-
In https://developer.hashicorp.com/terraform/cli/workspaces, we use "the" before and "command" after the code formatted command part (as in my other places). Both words are not repeated but "command" is used once for all of them in the end.
With the intro, this pattern doesn't make sense in my opinion. The following commands simply need a list of commands, so "the" and "command" should not be repeated. -
I also thought about referring to the command with an "s", e.g. "starts", but decided to go for directly addressing the user.
| 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. | ||
| guides](/terraform/language/upgrade-guides). |
There was a problem hiding this comment.
Review note:
IDK the pattern but I would leave it out. If the user is interested and clicks the links they land on the page in the language docs anyway.
Just in case, you wanna revert my change (if the pattern is to mention the docs name of links):
| guides](/terraform/language/upgrade-guides). | |
| guides](/terraform/language/upgrade-guides) in the Terraform language docs. |
|
Thanks for this submission. Given these changes are largely stylistic in nature, they would need to be approved by the documentation team. Thanks again! |
| Learn commands that help validate, format, and upgrade code written in the | ||
| Terraform Configuration Language. | ||
| Learn commands that help validate, format, and upgrade code written in | ||
| Terraform's configuration language. |
There was a problem hiding this comment.
Used in different places like this, e.g.
- https://developer.hashicorp.com/terraform/language/style
- https://developer.hashicorp.com/terraform/language/syntax/configuration
Other places use "the Terraform language".
I found this article when reading about Terraform for learning. I hope my changes to simplify the reading flow make sense.