Skip to content

chore(docs): update documentation for coder_workspace_tags #15620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 25, 2024
Merged

chore(docs): update documentation for coder_workspace_tags #15620

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ad6f66
chore(docs): update documentation for `coder_workspace_tags`
johnstcn Nov 21, 2024
9f3812f
make fmt
johnstcn Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
make fmt
  • Loading branch information
@johnstcn
johnstcn committed Nov 21, 2024
commit 9f3812f99a02c079f67e9ddbbe0e830c9d1e5561
6 changes: 3 additions & 3 deletions examples/workspace-tags/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ By using `coder_workspace_tags` and `coder_parameter`s, template administrators

# Notes

* You will need to have an [external provisioner](https://coder.com/docs/admin/provisioners#external-provisioners) with the correct tagset running in order to import this template.
* When specifying values for the `coder_workspace_tags` data source, you are restricted to using a subset of Terraform's capabilities.
* You must specify default values for all data sources and variables referenced by the `coder_workspace_tags` data source.
- You will need to have an [external provisioner](https://coder.com/docs/admin/provisioners#external-provisioners) with the correct tagset running in order to import this template.
- When specifying values for the `coder_workspace_tags` data source, you are restricted to using a subset of Terraform's capabilities.
- You must specify default values for all data sources and variables referenced by the `coder_workspace_tags` data source.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we exposing an explicit error if this is not the case to inform the user on what they can do to fix it. Think about it in context of #15447 .

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below comment, but TL;DR yes.


See [Workspace Tags](https://coder.com/docs/templates/workspace-tags) for more information.

Expand Down
4 changes: 2 additions & 2 deletions examples/workspace-tags/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ data "coder_parameter" "project_name" {
name = "project_name"
display_name = "Project name"
description = "Specify the project name."
default = "SUPERSECRET"
mutable = false
default = "SUPERSECRET"
mutable = false
}

data "coder_parameter" "feature_cache_enabled" {
Expand Down
Loading