Skip to content

Commit

Permalink
Merge pull request #159 from terraform-providers/lafentres/workspace_…
Browse files Browse the repository at this point in the history
…ids_docs

Update docs to reflect changes to workspace IDs + fix broken code block
  • Loading branch information
lafentres committed Apr 9, 2020
2 parents bab4a0e + 06b5208 commit 0692d84
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
8 changes: 7 additions & 1 deletion website/docs/d/workspace_ids.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ The following arguments are supported:

In addition to all arguments above, the following attributes are exported:

* `ids` - A map of workspace names and their IDs.
~> **NOTE** In versions < 0.15.1, workspace IDs were in the format
`<ORGANIZATION NAME>/<WORKSPACE NAME>` for some resources. This format
has been deprecated in favor of the immutable workspace ID in the format `ws-<RANDOM STRING>`.
The `ids` attribute for this resource return workspace IDs in the deprecated
format so you should use `external_ids` instead.

* `ids` - A map of workspace names and their human-readable IDs, which look like `<ORGANIZATION>/<WORKSPACE>`.
* `external_ids` - A map of workspace names and their opaque external IDs, which
look like `ws-<RANDOM STRING>`.
6 changes: 4 additions & 2 deletions website/docs/index.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ the acceptable provider versions on the minor version.

If you are using Terraform CLI version 0.12.x, you can constrain this provider to 0.15.x versions
by adding a `required_providers` block inside a `terraform` block.
```

```hcl
terraform {
required_providers {
tfe = "~> 0.15.0"
Expand All @@ -65,7 +66,8 @@ terraform {

If you are using Terraform CLI version 0.11.x, you can constrain this provider to 0.15.x versions
by adding the version constraint to the tfe provider block.
```

```hcl
provider "tfe" {
version = "~> 0.15.0"
...
Expand Down
3 changes: 3 additions & 0 deletions website/docs/r/workspace.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ In addition to all arguments above, the following attributes are exported:

## Import

~> **NOTE** In versions < 0.15.1, the import ID was in the format `<ORGANIZATION NAME>/<WORKSPACE NAME>`.
This format has been deprecated in favor of the immutable workspace ID in the format `ws-<RANDOM STRING>`.

Workspaces can be imported; use `<WORKSPACE ID>` as the
import ID. For example:

Expand Down

0 comments on commit 0692d84

Please sign in to comment.