Docs/seo updates #36083
Merged
Docs/seo updates #36083
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The equivalence tests will be updated. Please verify the changes here. |
|
The equivalence tests will be updated. Please verify the changes here. |
BrianMMcClain
previously approved these changes
Nov 27, 2024
website/docs/cli/code/index.mdx
Outdated
| @@ -1,16 +1,22 @@ | |||
| --- | |||
| page_title: Writing and Modifying Code - Terraform CLI | |||
| page_title: Write and modify Terrafrom configuration from the CLI | |||
There was a problem hiding this comment.
I know this page originally included "write", but I'd argue all o these commands modify existing configuration rather than create new configuration. My vote would be something like "Format and validate configuration".
| @@ -1,12 +1,10 @@ | |||
| --- | |||
| page_title: Initializing Working Directories - Terraform CLI | |||
| page_title: Initialize the Terraform working directory | |||
There was a problem hiding this comment.
We've included the word "overview" in other index pages, do we want the same here?
trujillo-adam
commented
Nov 29, 2024
Co-authored-by: Brian McClain <[email protected]>
|
The equivalence tests will be updated. Please verify the changes here. |
Co-authored-by: Judith Malnick <[email protected]>
ritsok
reviewed
Dec 13, 2024
website/docs/cli/auth/index.mdx
Outdated
| description: >- | ||
| Documentation about the login and logout commands that help automate getting | ||
| an API token for your HCP Terraform account. | ||
| Use the terraform login and terraform logout commands get |
There was a problem hiding this comment.
should these commands have backticks?
ritsok
reviewed
Dec 13, 2024
ritsok
reviewed
Dec 13, 2024
ritsok
reviewed
Dec 13, 2024
ritsok
reviewed
Dec 13, 2024
ritsok
reviewed
Dec 13, 2024
ritsok
reviewed
Dec 13, 2024
ritsok
reviewed
Dec 13, 2024
ritsok
reviewed
Dec 13, 2024
| --- | ||
|
|
||
| # Import | ||
| # Import existing resources overview |
There was a problem hiding this comment.
Suggested change
| # Import existing resources overview | |
| # Import existing resources |
ritsok
reviewed
Dec 13, 2024
ritsok
previously approved these changes
Dec 13, 2024
Co-authored-by: rita <[email protected]>
trujillo-adam
commented
Dec 16, 2024
Co-authored-by: rita <[email protected]>
ritsok
reviewed
Dec 16, 2024
| @@ -1,40 +1,30 @@ | |||
| --- | |||
| page_title: 'Command: providers schema' | |||
| page_title: terraform providers schema command | |||
There was a problem hiding this comment.
Suggested change
| page_title: terraform providers schema command | |
| page_title: terraform providers schema command reference |
| page_title: Inspecting State - Terraform CLI | ||
| description: Commands that allow you to read and update state. | ||
| 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. |
There was a problem hiding this comment.
Suggested change
| description: The `terraform state` group of commands help you inspect Terraform state. Learn how inspecting Terraform state can help you read and update state. | |
| description: The `terraform state` group of commands let you inspect Terraform state. |
| @@ -1,12 +1,11 @@ | |||
| --- | |||
| page_title: 'Command: workspace select' | |||
| description: The terraform workspace select command is used to choose a workspace. | |||
| page_title: terraform workspace select` command reference | |||
There was a problem hiding this comment.
Suggested change
| page_title: terraform workspace select` command reference | |
| page_title: terraform workspace select command reference |
| The `terraform untaint` command tells Terraform that an object is functioning | ||
| correctly, even though its creation failed or it was previously manually | ||
| marked as degraded. | ||
| The `terraform untaint` command removes the `tainted` status from infrastructure objects tracked in the Terraform state data. |
There was a problem hiding this comment.
Suggested change
| The `terraform untaint` command removes the `tainted` status from infrastructure objects tracked in the Terraform state data. | |
| The `terraform untaint` command removes the `tainted` market from infrastructure objects tracked in Terraform state. |
| description: |- | ||
| The `terraform taint` command informs Terraform that a particular object | ||
| is damaged or degraded. | ||
| The `terraform taint` command marks specified objects in the Terraform state as tainted. |
There was a problem hiding this comment.
Suggested change
| The `terraform taint` command marks specified objects in the Terraform state as tainted. | |
| The `terraform taint` command marks specified objects in the Terraform state as tainted, prompting Terraform to recreate the resource in the next run. |
| page_title: 'Command: state push' | ||
| description: The `terraform state push` command pushes items to the Terraform state. | ||
| page_title: terraform state push command reference | ||
| description: The `terraform state push` command uploads a state file to the Terraform state. |
There was a problem hiding this comment.
Suggested change
| description: The `terraform state push` command uploads a state file to the Terraform state. | |
| description: The `terraform state push` command uploads a state file to the configured state storage location. |
| description: >- | ||
| Commands that allow you to manage the way that resources are tracked in state. | ||
| They are helpful when you move or change resources. | ||
| Terraform state commands can move and remove resources and transfer existing resources to a different provider. Learn how about changing or moving resources. |
There was a problem hiding this comment.
Suggested change
| Terraform state commands can move and remove resources and transfer existing resources to a different provider. Learn how about changing or moving resources. | |
| Terraform state commands can move and remove resources and transfer existing resources to a different provider. |
| page_title: Forcing Re-creation of Resources - Terraform CLI | ||
| description: Commands that allow you to destroy and re-create resources manually. | ||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| description: The -replace flag and taint command let you recreate infrastructure objects. |
| @@ -1,43 +1,37 @@ | |||
| --- | |||
| page_title: Testing Terraform - Terraform CLI | |||
| page_title: Testing features in Terraform | |||
There was a problem hiding this comment.
Suggested change
| page_title: Testing features in Terraform | |
| page_title: Testing your Terraform configuration |
| correctness in your infrastructure. | ||
| --- | ||
|
|
||
| # Testing Terraform | ||
| # Testing features in Terraform overview |
There was a problem hiding this comment.
Suggested change
| # Testing features in Terraform overview | |
| # Testing Terraform configuration overview |
otherwise it reads as if we're testing the features themselves
EnMod
previously approved these changes
Dec 16, 2024
ritsok
approved these changes
Dec 16, 2024
|
Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch. |
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update meta titles, descriptions, and H1 titles for SEO.