Skip to content

Commit 9a97161

Browse files
authored
fix(docs): fix formatting issues in upgrade guide for version 2 (#317)
1 parent d15e8d1 commit 9a97161

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

docs/guides/version-2-upgrade.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Upgrade topics:
1313

1414
- [Provider Version Configuration](#provider-version-configuration)
1515
- [Provider Arguments](#provider-arguments)
16-
- [Data Source: [`coder_git_auth`](#data-source-coder_git_auth)
17-
- [Data Source: [`coder_workspace`](#data-source-coder_workspace)
16+
- [Data Source: `coder_git_auth`](#data-source-coder_git_auth)
17+
- [Data Source: `coder_workspace`](#data-source-coder_workspace)
1818

1919
## Provider Version Configuration
2020

@@ -60,9 +60,9 @@ provider "coder" {}
6060
Version 2.0.0 removes the [`feature_use_managed_variables`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs#feature_use_managed_variables-1) argument from the `provider` block.
6161

6262

63-
## Data Source: [`coder_git_auth`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/git_auth)
63+
## Data Source: `coder_git_auth`
6464

65-
If you are using this data source, you must replace it with the [`coder_external_auth`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/external_auth) data source. The `coder_external_auth` data source is a more generic data source that can be used to create any external authentication provider which supports OAuth2.
65+
If you are using the [`coder_git_auth`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/git_auth) data source, you must replace it with the [`coder_external_auth`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/external_auth) data source. The `coder_external_auth` data source is a more generic data source that can be used to create any external authentication provider which supports OAuth2.
6666

6767
For example, given the previous configuration:
6868

@@ -80,14 +80,16 @@ data "coder_external_auth" "example" {
8080
}
8181
```
8282

83-
## Data Source: [`coder_workspace`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/workspace)
83+
## Data Source: `coder_workspace`
8484

85-
If you are using the `owner` properties of the `coder_workspace` data source, you must remove them and use the [`coder_workspace_owner`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner) data source instead. The `coder_workspace_owner` data source provides additional properties of the workspace owner.
85+
If you are using the `owner` properties of the [`coder_workspace`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/workspace) data source, you must remove them and use the [`coder_workspace_owner`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner) data source instead. The `coder_workspace_owner` data source provides additional properties of the workspace owner.
8686

8787
Update your Terraform configuration to use the `coder_workspace_owner` data source instead and update the following attributes:
8888

8989
```terraform
90+
9091
data "coder_workspace_owner" "me" {}
92+
9193
```
9294

9395
- Remove `owner_id` attribute. Use [`data.coder_workspace_owner.me.id`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner#id) instead.

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Upgrade topics:
1313

1414
- [Provider Version Configuration](#provider-version-configuration)
1515
- [Provider Arguments](#provider-arguments)
16-
- [Data Source: [`coder_git_auth`](#data-source-coder_git_auth)
17-
- [Data Source: [`coder_workspace`](#data-source-coder_workspace)
16+
- [Data Source: `coder_git_auth`](#data-source-coder_git_auth)
17+
- [Data Source: `coder_workspace`](#data-source-coder_workspace)
1818

1919
## Provider Version Configuration
2020

@@ -60,9 +60,9 @@ provider "coder" {}
6060
Version 2.0.0 removes the [`feature_use_managed_variables`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs#feature_use_managed_variables-1) argument from the `provider` block.
6161

6262

63-
## Data Source: [`coder_git_auth`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/git_auth)
63+
## Data Source: `coder_git_auth`
6464

65-
If you are using this data source, you must replace it with the [`coder_external_auth`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/external_auth) data source. The `coder_external_auth` data source is a more generic data source that can be used to create any external authentication provider which supports OAuth2.
65+
If you are using the [`coder_git_auth`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/git_auth) data source, you must replace it with the [`coder_external_auth`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/external_auth) data source. The `coder_external_auth` data source is a more generic data source that can be used to create any external authentication provider which supports OAuth2.
6666

6767
For example, given the previous configuration:
6868

@@ -80,14 +80,16 @@ data "coder_external_auth" "example" {
8080
}
8181
```
8282

83-
## Data Source: [`coder_workspace`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/workspace)
83+
## Data Source: `coder_workspace`
8484

85-
If you are using the `owner` properties of the `coder_workspace` data source, you must remove them and use the [`coder_workspace_owner`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner) data source instead. The `coder_workspace_owner` data source provides additional properties of the workspace owner.
85+
If you are using the `owner` properties of the [`coder_workspace`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/workspace) data source, you must remove them and use the [`coder_workspace_owner`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner) data source instead. The `coder_workspace_owner` data source provides additional properties of the workspace owner.
8686

8787
Update your Terraform configuration to use the `coder_workspace_owner` data source instead and update the following attributes:
8888

8989
```terraform
90+
9091
data "coder_workspace_owner" "me" {}
92+
9193
```
9294

9395
- Remove `owner_id` attribute. Use [`data.coder_workspace_owner.me.id`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner#id) instead.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy