Skip to content

Commit 87ad4f7

Browse files
committed
review suggestions
1 parent 1efcd77 commit 87ad4f7

File tree

4 files changed

+12
-14
lines changed

4 files changed

+12
-14
lines changed

docs/guides/version-2-upgrade.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ page_title: "Terraform Coder Provider Version 2 Upgrade Guide"
44

55
# Terraform Coder Provider Version 2 Upgrade Guide
66

7-
Version 2.0.0 of the Coder provider for Terraform is a major release that removes and introduces some changes that you will need to consider when upgrading.
8-
This guide is intended to help with the process and focus only on the changes from version 1.X to version 2.0.0.
7+
Version 2.0.0 of the Coder provider for Terraform is a major release that introduces some changes that you will need to consider when upgrading.
8+
This guide is intended to help with the process, and focuses only on the changes from version 1.X to version 2.0.0.
99

10-
11-
!> Using Version 2.0.0 of the Coder provider requires Coder Server version [`2.13.0`](https://github.com/coder/coder/releases/tag/v2.13.0) or later.
10+
!> Using Version 2.0.0 of the Coder provider requires Coder Server version [`2.18.0`](https://github.com/coder/coder/releases/tag/v2.18.0) or later.
1211

1312
Upgrade topics:
1413

@@ -19,9 +18,9 @@ Upgrade topics:
1918

2019
## Provider Version Configuration
2120

22-
-> Before upgrading to version 2.0.0, it is recommended to upgrade to the most recent 1.X version and ensure that your environment successfully runs [`terraform plan`](https://developer.hashicorp.com/terraform/cli/commands/plan) without unexpected changes or deprecation notices.
21+
-> Before upgrading to version 2.0.0, please first upgrade to the most recent 1.X version and ensure that your environment successfully runs [`terraform plan`](https://developer.hashicorp.com/terraform/cli/commands/plan) without unexpected changes or deprecation notices.
2322

24-
We recommended using [version constraints](https://developer.hashicorp.com/terraform/language/providers/requirements#version-constraints) when configuring Terraform providers.
23+
We highly recommend using [version constraints](https://developer.hashicorp.com/terraform/language/providers/requirements#version-constraints) when configuring Terraform providers.
2524

2625

2726
For example, given the previous configuration:

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010

1111
Terraform provider for managing Coder [templates](https://coder.com/docs/admin/templates), which are the underlying infrastructure for Coder [workspaces](https://coder.com/docs/user-guides/workspace-management).
1212

13-
-> Requires Coder v2.13.0 or later.
13+
-> Requires Coder [v2.18.0](https://github.com/coder/coder/releases/tag/v2.18.0) or later.
1414

1515
!> [`coder_git_auth`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/git_auth) and owner related fields of [`coder_workspace`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/workspace) data source have been removed. Follow the [Version 2 Upgrade Guide](https://registry.terraform.io/providers/codercom/coder/latest/docs/guides/version-2-upgrade) to update your code.
1616

templates/guides/version-2-upgrade.md.tmpl

+5-6
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ page_title: "Terraform Coder Provider Version 2 Upgrade Guide"
44

55
# Terraform Coder Provider Version 2 Upgrade Guide
66

7-
Version 2.0.0 of the Coder provider for Terraform is a major release that removes and introduces some changes that you will need to consider when upgrading.
8-
This guide is intended to help with the process and focus only on the changes from version 1.X to version 2.0.0.
7+
Version 2.0.0 of the Coder provider for Terraform is a major release that introduces some changes that you will need to consider when upgrading.
8+
This guide is intended to help with the process, and focuses only on the changes from version 1.X to version 2.0.0.
99

10-
11-
!> Using Version 2.0.0 of the Coder provider requires Coder Server version [`2.13.0`](https://github.com/coder/coder/releases/tag/v2.13.0) or later.
10+
!> Using Version 2.0.0 of the Coder provider requires Coder Server version [`2.18.0`](https://github.com/coder/coder/releases/tag/v2.18.0) or later.
1211

1312
Upgrade topics:
1413

@@ -19,9 +18,9 @@ Upgrade topics:
1918

2019
## Provider Version Configuration
2120

22-
-> Before upgrading to version 2.0.0, it is recommended to upgrade to the most recent 1.X version and ensure that your environment successfully runs [`terraform plan`](https://developer.hashicorp.com/terraform/cli/commands/plan) without unexpected changes or deprecation notices.
21+
-> Before upgrading to version 2.0.0, please first upgrade to the most recent 1.X version and ensure that your environment successfully runs [`terraform plan`](https://developer.hashicorp.com/terraform/cli/commands/plan) without unexpected changes or deprecation notices.
2322

24-
We recommended using [version constraints](https://developer.hashicorp.com/terraform/language/providers/requirements#version-constraints) when configuring Terraform providers.
23+
We highly recommend using [version constraints](https://developer.hashicorp.com/terraform/language/providers/requirements#version-constraints) when configuring Terraform providers.
2524

2625

2726
For example, given the previous configuration:

templates/index.md.tmpl

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010

1111
Terraform provider for managing Coder [templates](https://coder.com/docs/admin/templates), which are the underlying infrastructure for Coder [workspaces](https://coder.com/docs/user-guides/workspace-management).
1212

13-
-> Requires Coder v2.13.0 or later.
13+
-> Requires Coder [v2.18.0](https://github.com/coder/coder/releases/tag/v2.18.0) or later.
1414

1515
!> [`coder_git_auth`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/git_auth) and owner related fields of [`coder_workspace`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/workspace) data source have been removed. Follow the [Version 2 Upgrade Guide](https://registry.terraform.io/providers/codercom/coder/latest/docs/guides/version-2-upgrade) to update your code.
1616

0 commit comments

Comments
 (0)