Skip to content

Commit 1680b0d

Browse files
Merge pull request #36083 from hashicorp/docs/seo-updates
Docs/seo updates
2 parents e6bd282 + 922aff2 commit 1680b0d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+669
-778
lines changed

website/data/cli-nav-data.json

Lines changed: 15 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,7 @@
3333
{ "title": "Overview", "path": "code" },
3434
{ "title": "<code>console</code>", "href": "/cli/commands/console" },
3535
{ "title": "<code>fmt</code>", "href": "/cli/commands/fmt" },
36-
{ "title": "<code>validate</code>", "href": "/cli/commands/validate" },
37-
{
38-
"title": "<code>0.13upgrade</code>",
39-
"href": "/cli/commands/0.13upgrade"
40-
},
41-
{
42-
"title": "<code>0.12upgrade</code>",
43-
"href": "/cli/commands/0.12upgrade"
44-
}
36+
{ "title": "<code>validate</code>", "href": "/cli/commands/validate" }
4537
]
4638
},
4739
{
@@ -62,22 +54,18 @@
6254
]
6355
},
6456
{
65-
"title": "Importing Infrastructure",
57+
"title": "Import Infrastructure",
6658
"routes": [
6759
{ "title": "Overview", "path": "import" },
60+
{ "title": "Import existing resources", "path": "import/usage" },
6861
{
69-
"title": "<code>import</code>",
62+
"title": "Reference",
7063
"href": "/cli/commands/import"
71-
},
72-
{ "title": "Usage Tips", "path": "import/usage" },
73-
{
74-
"title": "Resource Importability",
75-
"path": "import/importability"
7664
}
7765
]
7866
},
7967
{
80-
"title": "Manipulating State",
68+
"title": "Manually Update State",
8169
"routes": [
8270
{ "title": "Overview", "path": "state" },
8371
{
@@ -266,7 +254,6 @@
266254
{ "title": "<code>apply</code>", "href": "/cli/commands/apply" },
267255
{ "title": "<code>console</code>", "href": "/cli/commands/console" },
268256
{ "title": "<code>destroy</code>", "href": "/cli/commands/destroy" },
269-
{ "title": "<code>env</code>", "href": "/cli/commands/env" },
270257
{ "title": "<code>fmt</code>", "href": "/cli/commands/fmt" },
271258
{
272259
"title": "<code>force-unlock</code>",
@@ -294,10 +281,6 @@
294281
"title": "<code>providers schema</code>",
295282
"href": "/cli/commands/providers/schema"
296283
},
297-
{
298-
"title": "<code>push (deprecated)</code>",
299-
"href": "/cli/commands/push"
300-
},
301284
{ "title": "<code>refresh</code>", "href": "/cli/commands/refresh" },
302285
{ "title": "<code>show</code>", "href": "/cli/commands/show" },
303286
{ "title": "<code>state</code>", "href": "/cli/commands/state" },
@@ -350,11 +333,11 @@
350333
"href": "/cli/commands/workspace/show"
351334
},
352335
{
353-
"title": "<code>0.12upgrade</code>",
336+
"title": "0.12upgrade",
354337
"href": "/cli/commands/0.12upgrade"
355338
},
356339
{
357-
"title": "<code>0.13upgrade</code>",
340+
"title": "0.13upgrade",
358341
"href": "/cli/commands/0.13upgrade"
359342
}
360343
]
@@ -367,7 +350,6 @@
367350
{ "title": "apply", "path": "commands/apply" },
368351
{ "title": "console", "path": "commands/console" },
369352
{ "title": "destroy", "path": "commands/destroy" },
370-
{ "title": "env", "path": "commands/env" },
371353
{ "title": "fmt", "path": "commands/fmt" },
372354
{ "title": "force-unlock", "path": "commands/force-unlock" },
373355
{ "title": "get", "path": "commands/get" },
@@ -388,7 +370,6 @@
388370
{ "title": "providers schema", "path": "commands/providers/schema" }
389371
]
390372
},
391-
{ "title": "push (deprecated)", "path": "commands/push" },
392373
{ "title": "refresh", "path": "commands/refresh" },
393374
{ "title": "show", "path": "commands/show" },
394375
{
@@ -426,8 +407,14 @@
426407
{ "title": "workspace show", "path": "commands/workspace/show" }
427408
]
428409
},
429-
{ "title": "0.12upgrade", "path": "commands/0.12upgrade" },
430-
{ "title": "0.13upgrade", "path": "commands/0.13upgrade" }
410+
{
411+
"title": "0.12upgrade",
412+
"path": "commands/0.12upgrade"
413+
},
414+
{
415+
"title": "0.13upgrade",
416+
"path": "commands/0.13upgrade"
417+
}
431418
]
432419
},
433420
{

website/data/internals-nav-data.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"path": "provider-registry-protocol"
2626
},
2727
{
28-
"title": "Resource Graph",
28+
"title": "Dependency Graph",
2929
"path": "graph"
3030
},
3131
{

website/docs/cli/auth/index.mdx

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
11
---
2-
page_title: Authentication - Terraform CLI
2+
page_title: Get an API token for HCP Terraform or Terraform Enterprise
33
description: >-
4-
Documentation about the login and logout commands that help automate getting
5-
an API token for your HCP Terraform account.
4+
Use the `terraform login` and `terraform logout` commands get
5+
an API token for your HCP Terraform or Terraform Enterprise account.
66
---
77

8-
# CLI Authentication
8+
# Get an API token for HCP Terraform and Terraform Enterprise
9+
10+
This topic describes how to use the `terraform login` and `terraform logout` to authenticate with HCP Terraform and Terraform Enterprise.
911

1012
> **Hands-on:** Try the [Authenticate the CLI with HCP Terraform](/terraform/tutorials/cloud/cloud-login?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial.
1113
14+
## Overview
15+
1216
[HCP Terraform](https://cloud.hashicorp.com/products/terraform) and
1317
[Terraform Enterprise](/terraform/enterprise) are platforms that perform
1418
Terraform runs to provision infrastructure, offering a collaboration-focused
15-
environment that makes it easier for teams to use Terraform together. (For
16-
expediency, the content below refers to both products as "HCP Terraform.")
19+
environment that makes it easier for teams to use Terraform together.
20+
21+
You can integrate the Terraform CLI with HCP Terraform and Terraform Enterprise in the following ways:
22+
23+
- Use the Terraform CLI as a front-end for [CLI-driven runs](/terraform/cloud-docs/run/cli) in HCP Terraform
24+
- Use HCP Terraform or Terraform Enterprise as a state backend and a private module registry.
1725

18-
Terraform CLI integrates with HCP Terraform in several ways — it can be a
19-
front-end for [CLI-driven runs](/terraform/cloud-docs/run/cli) in HCP Terraform,
20-
and can also use HCP Terraform as a state backend and a private module
21-
registry. All of these integrations require you to authenticate Terraform CLI
26+
These integrations require you to authenticate the Terraform CLI
2227
with your HCP Terraform account.
2328

24-
The best way to handle CLI authentication is with the `login` and `logout`
25-
commands, which help automate the process of getting an API token for your
26-
HCP Terraform user account.
29+
## Authentication
2730

28-
For details, see:
31+
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.
2932

30-
- [The `terraform login` command](/terraform/cli/commands/login)
31-
- [The `terraform logout` command](/terraform/cli/commands/logout)
33+
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.

website/docs/cli/cloud/command-line-arguments.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
page_title: Command Line Arguments
3-
description: Command Line Arguments
2+
page_title: -ignore-remote-version reference
3+
description: Use the -ignore-remote-version flag to override CLI-driven commands for HCP Terraform runs.
44
---
55

6-
# Command Line Arguments
6+
# `-ignore-remote-version` reference
77

88
When your configuration includes a `cloud` block, commands that
99
make local modifications to Terraform state and then push them back up to the remote workspace

website/docs/cli/cloud/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
page_title: Using HCP Terraform - Terraform CLI
2+
page_title: Use HCP Terraform or Terraform Enterprise with the Terraform CLI
33
description: >-
44
Learn how to use HCP Terraform and Terraform Enterprise on the command line with the Terraform CLI.
55
---
66

7-
# Using HCP Terraform with Terraform CLI
7+
# Use HCP Terraform with the Terraform CLI
88

99
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.
1010

website/docs/cli/code/index.mdx

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
---
2-
page_title: Writing and Modifying Code - Terraform CLI
2+
page_title: Format and validate Terraform configuration using the Terraform CLI
33
description: >-
4-
Learn commands that help validate, format, and upgrade code written in the
5-
Terraform Configuration Language.
4+
Learn about the Terraform commands that validate, format, and upgrade code written in HCL.
65
---
76

8-
# Writing and Modifying Terraform Code
7+
# Write and modify Terrafrom configuration from the CLI
8+
9+
This topic provides an overview of the Terraform CLI commands you can use to develop, format, and validate your Terraform configuration.
10+
11+
## Introduction
912

1013
The [Terraform language](/terraform/language) is Terraform's primary
1114
user interface, and all of Terraform's workflows rely on configurations written
1215
in the Terraform language.
1316

17+
## Workflows
18+
1419
Terraform CLI includes several commands to make Terraform code more convenient
1520
to work with. Integrating these commands into your editing workflow can
1621
potentially save you time and effort.

website/docs/cli/commands/0.12upgrade.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
page_title: 'Command: 0.12upgrade'
2+
page_title: terraform 0.12upgrade command reference
33
description: >-
4-
The 0.12upgrade subcommand automatically rewrites existing configurations for
4+
The `terraform 0.12upgrade` command automatically rewrites existing configurations for
55
Terraform 0.12 compatibility.
66
---
77

8-
# Command: 0.12upgrade
8+
# `terraform 0.12upgrade` command
99

1010
The `terraform 0.12upgrade` command applies several automatic upgrade rules to
1111
help prepare a module that was written for Terraform v0.11 to be used
@@ -114,4 +114,4 @@ prompt, so be sure you have a clean work tree before running it.
114114

115115
Because upgrading requires access to the configuration's provider plugins,
116116
all of the directories must be initialized with `terraform init` prior to
117-
running the above.
117+
running the above.

website/docs/cli/commands/0.13upgrade.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
page_title: 'Command: 0.13upgrade'
2+
page_title: terraform 0.13upgrade command reference
33
description: >-
4-
The 0.13upgrade subcommand updates existing configurations to use the new
4+
The `terraform 0.13upgrade` command updates existing configurations to use the new
55
provider source features from Terraform 0.13.
66
---
77

8-
# Command: 0.13upgrade
8+
# `terraform 0.13upgrade` command
99

1010
The `terraform 0.13upgrade` command updates existing configuration to add an
1111
explicit `source` attribute for each provider used in a given module. The
@@ -86,4 +86,4 @@ Select-Object -Unique | ForEach-Object { terraform 0.13upgrade -yes $_.FullName
8686
```
8787

8888
Note that the above commands include the `-yes` option to override the
89-
interactive prompt, so be sure you have a clean work tree before running it.
89+
interactive prompt, so be sure you have a clean work tree before running it.

website/docs/cli/commands/apply.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
page_title: 'Command: apply'
3-
description: >-
4-
The terraform apply command executes the actions proposed in a Terraform plan
2+
page_title: terraform apply command reference
3+
description: The `terraform apply` command executes the actions proposed in a Terraform plan
54
to create, update, or destroy infrastructure.
65
---
76

8-
# Command: apply
7+
# `terraform apply` command
98

109
The `terraform apply` command executes the actions proposed in a Terraform
1110
plan.
@@ -16,8 +15,6 @@ plan.
1615

1716
Usage: `terraform apply [options] [plan file]`
1817

19-
20-
2118
### Automatic Plan Mode
2219

2320
When you run `terraform apply` without passing a saved plan file, Terraform automatically creates a new execution plan as if you had run [`terraform plan`](/terraform/cli/commands/plan), prompts you to approve that plan, and takes the indicated actions. You can use all of the [planning modes](/terraform/cli/commands/plan#planning-modes) and

website/docs/cli/commands/console.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
page_title: 'Command: console'
2+
page_title: terraform console command reference
33
description: >-
4-
The terraform console command provides an interactive console for evaluating
4+
The `terraform console` command opens an interactive console for evaluating
55
expressions.
66
---
77

8-
# Command: console
8+
# `terraform console` command
99

10-
The `terraform console` command provides an interactive console for
10+
The `terraform console` command opens an interactive console for
1111
evaluating [expressions](/terraform/language/expressions).
1212

1313
## Usage

0 commit comments

Comments
 (0)