Skip to content

Commit 6bfc3dd

Browse files
committed
Sarah feedback
1 parent 035334d commit 6bfc3dd

File tree

9 files changed

+17
-17
lines changed

9 files changed

+17
-17
lines changed

content/terraform-docs-common/data/cloud-docs-nav-data.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,7 @@
599599
"title": "Deploy infrastructure",
600600
"routes": [
601601
{ "title": "Configuration versions", "path": "stacks/deploy/configuration-versions" },
602-
{ "title": "Review deployment plans", "path": "stacks/deploy/runs" }
602+
{ "title": "Review deployment runs", "path": "stacks/deploy/runs" }
603603
]
604604
},
605605
{
@@ -624,7 +624,6 @@
624624
{ "title": "Kubernetes configuration", "href": "dynamic-provider-credentials/kubernetes-configuration" },
625625
{ "title": "HCP configuration", "href": "dynamic-provider-credentials/hcp-configuration" },
626626
{ "title": "Manually generating workload identity tokens", "href": "dynamic-provider-credentials/manual-generation" },
627-
{ "title": "Specifying multiple configurations", "href": "dynamic-provider-credentials/specifying-multiple-configurations"},
628627
{
629628
"title": "Vault-backed dynamic credentials",
630629
"routes": [

content/terraform-docs-common/docs/cloud-docs/overview/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Some of HCP Terraform's features are limited to particular paid upgrade plans.
4444

4545
Each higher paid upgrade plan is a strict superset of any lower plans — for example, the **Standard** edition includes all of the features of the **Essentials** edition. The **Premium** edition includes all of the features of the **Standard** and **Essentials** editions. Paid feature callouts in the documentation indicate the _lowest_ edition at which the feature is available, but any higher plans also include that feature.
4646

47-
To learn more about HCP Terraform's paid plans and features, refer to []
47+
To learn more about HCP Terraform's paid plans and features, refer to the [pricing page](https://www.hashicorp.com/products/terraform/pricing).
4848

4949
Terraform Enterprise generally includes all of HCP Terraform's paid features, plus additional features geared toward large enterprises. However, some features are implemented differently due to the differences between self-hosted and SaaS environments, and some features might be absent due to being impractical or irrelevant in the types of organizations that need Terraform Enterprise. Cloud-only or Enterprise-only features are clearly indicated in documentation.
5050

@@ -116,10 +116,10 @@ Stacks can also directly share information with each other Stacks in the same pr
116116

117117
Like other kinds of code, infrastructure-as-code belongs in version control, so HCP Terraform is designed to work directly with your version control system (VCS) provider.
118118

119-
Each workspace or Stack can be linked to a VCS repository that contains its configuration, optionally specifying a branch and subdirectory. By default, HCP Terraform automatically retrieves configuration content from linked repositories, and watches the repository for changes:
119+
Each workspace can be linked to a VCS repository that contains its configuration, optionally specifying a branch and subdirectory. You can also link Stacks to a VCS repository. By default, HCP Terraform automatically retrieves configuration content from linked repositories, and watches the repository for changes:
120120

121-
- When new commits are merged, VCS-linked workspaces and Stacks automatically run Terraform plans with the new code.
122-
- When pull requests are opened, linked workspaces run speculative plans with the proposed code changes and post the results as a pull request check; reviewers can see at a glance whether the plan was successful, and can click through to view the proposed changes in detail.
121+
- When new commits are merged, linked workspaces and Stacks automatically run Terraform plans with the new code.
122+
- When pull requests are opened, linked workspaces and Stacks run speculative plans with the proposed code changes and post the results as a pull request check; reviewers can see at a glance whether the plan was successful, and can click through to view the proposed changes in detail.
123123

124124
VCS integration is powerful, but optional; if you use an unsupported VCS or want to preserve an existing validation and deployment pipeline, you can use the API or Terraform CLI to upload new configuration versions. You'll still get the benefits of remote execution and HCP Terraform's other features.
125125

content/terraform-docs-common/docs/cloud-docs/projects/best-practices.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Projects let you group and scope access to your workspaces<!-- BEGIN: TFC:only n
1212
Projects offer several advantages to help you further develop your workspace <!-- BEGIN: TFC:only name:stacks-tfe --> and Stack<!-- END: TFC:only name:stacks-tfe --> grouping strategy:
1313

1414
- **Focused view**: You can scope which workspaces <!-- BEGIN: TFC:only name:stacks-tfe --> and Stacks<!-- END: TFC:only name:stacks-tfe --> HCP Terraform displays by project, allowing for a more organized view.
15-
- **Simplified workspace management**: You can create project-level permissions and variable sets that apply to all current and future workspaces <!-- BEGIN: TFC:only name:stacks-tfe -->and Stacks <!-- END: TFC:only name:stacks-tfe -->in the project. For example, you can create a project variable set containing your cloud provider credentials for all workspaces in the project to access.
15+
- **Simplified workspace management**: You can create project-level permissions and variable sets that apply to all current and future workspaces <!-- BEGIN: TFC:only name:stacks-tfe -->and Stacks <!-- END: TFC:only name:stacks-tfe -->in the project. For example, you can create a project variable set containing your cloud provider credentials for all workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> and Stacks<!-- END: TFC:only name:stacks-tfe --> in the project to access.
1616
- **Reduced risk with centralized control**: You can scope project permissions to only grant teams administrator access to the projects and workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> and Stacks<!-- END: TFC:only name:stacks-tfe --> they need.
1717

1818
## Recommendations

content/terraform-docs-common/docs/cloud-docs/projects/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ By default, a project uses the organization's [default execution mode](/terrafor
5252

5353
## Execution mode
5454

55-
By default, a project uses the organization's execution mode, which is either **Remote** or **Local**, but you can override the organization execution mode in your project. Any workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> or Stacks <!-- END: TFC:only name:stacks-tfe -->created in the project after changing the project execution mode inherit the project default. Refer to [Change the execution mode](/terraform/cloud-docs/projects/manage#change-the-execution-mode) for instructions.
55+
By default, a project uses the organization's execution mode, which is either **Remote** or **Local**, but you can override the organization execution mode in your project. Any workspaces created in the project after changing the project execution mode inherit the project default. Refer to [Change the execution mode](/terraform/cloud-docs/projects/manage#change-the-execution-mode) for instructions.
5656

5757
You can enable the following execution modes:
5858

content/terraform-docs-common/docs/cloud-docs/stacks/deploy/configuration-versions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ A Stack configuration version is a snapshot of all of the pieces that make up yo
2020
## Requirements
2121

2222
To view a Stack and its configuration versions, you must also be a member of a team in your organization with one of the following permissions:
23-
* [Organization-level **Manage all projects**](/terraform/cloud-docs/users-teams-organizations/permissions#manage-all-projects)
24-
* [Project-level **Maintain**](/terraform/cloud-docs/users-teams-organizations/permissions#read) or higher
23+
* [Organization-level **Manage all projects**](/terraform/cloud-docs/users-teams-organizations/permissions/organization) or higher
24+
* [Project-level **Read**](/terraform/cloud-docs/users-teams-organizations/permissions/project) or higher
2525

2626
## Create a configuration version
2727

content/terraform-docs-common/docs/cloud-docs/stacks/deploy/runs.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ You can also view, approve, or cancel deployment runs directly from the Terrafor
1313
## Requirements
1414

1515
To view a Stack and its deployment runs, you must also be a member of a team in your organization with one of the following permissions:
16-
* [Organization-level **View all projects**](/terraform/cloud-docs/users-teams-organizations/permissions#view-all-projects) or higher
17-
* [Project-level **Write**](/terraform/cloud-docs/users-teams-organizations/permissions#write) or higher
16+
* [Organization-level **View all projects**](/terraform/cloud-docs/users-teams-organizations/permissions/organization) or higher
17+
* [Project-level **Read**](/terraform/cloud-docs/users-teams-organizations/permissions/project) or higher to view deployment runs
18+
* [Project-level **Write**](/terraform/cloud-docs/users-teams-organizations/permissions/project) or higher to interact with deployment runs
1819

1920
## View a deployment
2021

content/terraform-docs-common/docs/cloud-docs/stacks/runs.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ HCP Terraform creates a new configuration version each time any of the following
3535

3636
## Stack deployment runs
3737

38-
Each configuration version creates a deployment run for every deployment of your Stack to implement the changes in that version. A deployment run consists of the steps that Terraform can perform to update that deployment to match the associated configuration version. A single run can include many plans and apply cycles, and a successful run ends with an empty plan to reflect that deployments have executed all downstream changes.
38+
Each configuration version creates a deployment run for every deployment of your Stack to implement the changes in that version. A deployment run consists of the steps that Terraform can perform to update that deployment to match the associated configuration version. A single run can include many plan and apply cycles, and a successful run ends with an empty plan to reflect that deployments have executed all downstream changes.
3939

4040
The goal of deployment runs is to apply a configuration version to every deployment in the Stack. When all deployments successfully match the same Stack configuration, the Stack achieves convergence.
4141

@@ -66,7 +66,7 @@ While a deployment holds a state lock, other runs for that deployment must wait.
6666
- Fails and stops execution
6767
- Gets manually canceled by an operator
6868

69-
After the running deployment releases its lock, the next approved run in the queue can acquire the lock and begin its execution. To learn more state for deployments in a Stack, refer to [State for Stacks](/terraform/cloud-docs/stacks/state).
69+
After the running deployment releases its lock, the next approved run in the queue can acquire the lock and begin its execution. To learn more about state for deployments in a Stack, refer to [State for Stacks](/terraform/cloud-docs/stacks/state).
7070

7171
### Deployment run modes
7272

content/terraform-docs-common/docs/cloud-docs/variables/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To learn more about accessing environment variable values in Stacks, refer to [V
3535

3636
#### Parallelism
3737

38-
You can use the `TFE_PARALLELISM` environment variable when your infrastructure providers produce errors on concurrent operations or use non-standard rate limiting. The `TFE_PARALLELISM` variable sets the `-parallelism=<N>` flag for `terraform plan` and `terraform apply` ([more about `parallelism`](/terraform/internals/graph#walking-the-graph)). Valid values are between 1 and 256, inclusive, and the default is `10`. HCP Terraform agents do not support `TFE_PARALLELISM`, but you can specify flags as environment variables directly via [`TF_CLI_ARGS_name`](/terraform/cli/config/environment-variables#tf-cli-args). In these cases, use `TF_CLI_ARGS_plan="-parallelism=<N>"` or `TF_CLI_ARGS_apply="-parallelism=<N>"` instead.
38+
In workspaces, you can use the `TFE_PARALLELISM` environment variable when your infrastructure providers produce errors on concurrent operations or use non-standard rate limiting. The `TFE_PARALLELISM` variable sets the `-parallelism=<N>` flag for `terraform plan` and `terraform apply` ([more about `parallelism`](/terraform/internals/graph#walking-the-graph)). Valid values are between 1 and 256, inclusive, and the default is `10`. HCP Terraform agents do not support `TFE_PARALLELISM`, but you can specify flags as environment variables directly via [`TF_CLI_ARGS_name`](/terraform/cli/config/environment-variables#tf-cli-args). In these cases, use `TF_CLI_ARGS_plan="-parallelism=<N>"` or `TF_CLI_ARGS_apply="-parallelism=<N>"` instead.
3939

4040
!> **Warning:** We recommend reading and understanding [Terraform parallelism](https://support.hashicorp.com/hc/en-us/articles/10348130482451) prior to setting `TFE_PARALLELISM`. You can also contact HashiCorp support for direct advice.
4141

content/terraform-docs-common/docs/cloud-docs/variables/managing-variables.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ To create a variable set:
120120
1. Choose a variable set scope:
121121
- Organization-owned
122122
- **Apply globally:** HCP Terraform automatically applies this global variable set to all existing and future workspaces.
123-
- **Apply to specific projects, workspaces, or<!-- BEGIN: TFC:only name:stacks-tfe --> Stacks<!-- END: TFC:only name:stacks-tfe -->:** Use the text fields to search for and select workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> ,Stacks,<!-- END: TFC:only name:stacks-tfe --> and projects to apply this variable set to. This affects all current and future workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> and Stacks<!-- END: TFC:only name:stacks-tfe --> for any selected projects. After creation, users can also [add this variable set to their workspaces](#apply-or-remove-variable-sets-from-inside-a-workspace).
123+
- **Apply to specific projects<!-- BEGIN: TFC:only name:stacks-tfe -->, Stacks,<!-- END: TFC:only name:stacks-tfe --> or workspaces:** Use the text fields to search for and select workspaces<!-- BEGIN: TFC:only name:stacks-tfe -->, Stacks,<!-- END: TFC:only name:stacks-tfe --> and projects to apply this variable set to. This affects all current and future workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> and Stacks<!-- END: TFC:only name:stacks-tfe --> for any selected projects. After creation, users can also [add this variable set to their workspaces](#apply-or-remove-variable-sets-from-inside-a-workspace).
124124
- Project-owned
125125
- **Apply to the entire project:** HCP Terraform automatically applies this variable set to all existing and future workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> and Stacks<!-- END: TFC:only name:stacks-tfe --> in the project.
126126
- **Apply to specific workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> and Stacks<!-- END: TFC:only name:stacks-tfe --> in the project:** Use the text fields to search for and select workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> and Stacks<!-- END: TFC:only name:stacks-tfe --> to apply this variable set to. After creation, users can also [add this variable set to their workspaces](#apply-or-remove-variable-sets-from-inside-a-workspace).
@@ -145,7 +145,7 @@ To edit or remove a variable set:
145145

146146
### Delete variable sets
147147

148-
Deleting a variable set can be a disruptive action, especially if the variables are required to execute runs. We recommend informing organization, project, <!-- BEGIN: TFC:only name:stacks-tfe --> ,Stack,<!-- END: TFC:only name:stacks-tfe --> and workspace owners before removing a variable set.
148+
Deleting a variable set can be a disruptive action, especially if the variables are required to execute runs. We recommend informing organization, project<!-- BEGIN: TFC:only name:stacks-tfe --> ,Stack,<!-- END: TFC:only name:stacks-tfe --> and workspace owners before removing a variable set.
149149

150150
To delete a variable set:
151151

0 commit comments

Comments
 (0)