Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d66f502

Browse files
committedSep 5, 2024·
Improve markdown for attribute descriptions
- Ensure consistent usage of backticks for inline code. - Fix a typo in the `icon` attribute description.
1 parent 3478900 commit d66f502

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed
 

‎docs/data-sources/group.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ resource "coderd_template" "example" {
5858
- `display_name` (String)
5959
- `members` (Attributes Set) Members of the group. (see [below for nested schema](#nestedatt--members))
6060
- `quota_allowance` (Number) The number of quota credits to allocate to each user in the group.
61-
- `source` (String) The source of the group. Either 'oidc' or 'user'.
61+
- `source` (String) The source of the group. Either `oidc` or `user`.
6262

6363
<a id="nestedatt--members"></a>
6464
### Nested Schema for `members`
@@ -69,7 +69,7 @@ Read-Only:
6969
- `email` (String)
7070
- `id` (String)
7171
- `last_seen_at` (Number) Unix timestamp of when the member was last seen.
72-
- `login_type` (String) The login type of the member. Can be 'oidc', 'token', 'password', 'github' or 'none'.
73-
- `status` (String) The status of the member. Can be 'active', 'dormant' or 'suspended'.
72+
- `login_type` (String) The login type of the member. Can be `oidc`, `token`, `password`, `github` or `none`.
73+
- `status` (String) The status of the member. Can be `active`, `dormant` or `suspended`.
7474
- `theme_preference` (String)
7575
- `username` (String)

‎docs/data-sources/user.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ resource "coderd_group" "bosses" {
4848
- `created_at` (Number) Unix timestamp of when the user was created.
4949
- `email` (String) Email of the user.
5050
- `last_seen_at` (Number) Unix timestamp of when the user was last seen.
51-
- `login_type` (String) Type of login for the user. Valid types are 'none', 'password', 'github', and 'oidc'.
51+
- `login_type` (String) Type of login for the user. Valid types are `none`, `password', `github`, and `oidc`.
5252
- `name` (String) Display name of the user.
5353
- `organization_ids` (Set of String) IDs of organizations the user is associated with.
54-
- `roles` (Set of String) Roles assigned to the user. Valid roles are 'owner', 'template-admin', 'user-admin', and 'auditor'.
54+
- `roles` (Set of String) Roles assigned to the user. Valid roles are `owner`, `template-admin`, `user-admin`, and `auditor`.
5555
- `suspended` (Boolean) Whether the user is suspended.
5656
- `theme_preference` (String) The user's preferred theme.

‎docs/resources/group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ resource "coderd_group" "group1" {
5555

5656
- `avatar_url` (String) The URL of the group's avatar.
5757
- `display_name` (String) The display name of the group. Defaults to the group name.
58-
- `members` (Set of String) Members of the group, by ID. If null, members will not be added or removed by Terraform. To have a group resource with unmanaged members, but be able to read the members in Terraform, use `data.coderd_group`
58+
- `members` (Set of String) Members of the group, by ID. If `null`, members will not be added or removed by Terraform. To have a group resource with unmanaged members, but be able to read the members in Terraform, use `data.coderd_group`
5959
- `organization_id` (String) The organization ID that the group belongs to. Defaults to the provider default organization ID.
6060
- `quota_allowance` (Number) The number of quota credits to allocate to each user in the group.
6161

‎docs/resources/user.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ resource "coderd_user" "admin" {
5656

5757
### Optional
5858

59-
- `login_type` (String) Type of login for the user. Valid types are 'none', 'password', 'github', and 'oidc'.
59+
- `login_type` (String) Type of login for the user. Valid types are `none`, `password`, `github`, and `oidc`.
6060
- `name` (String) Display name of the user. Defaults to username.
61-
- `password` (String, Sensitive) Password for the user. Required when login_type is 'password'. Passwords are saved into the state as plain text and should only be used for testing purposes.
62-
- `roles` (Set of String) Roles assigned to the user. Valid roles are 'owner', 'template-admin', 'user-admin', and 'auditor'.
61+
- `password` (String, Sensitive) Password for the user. Required when `login_type` is `password`. Passwords are saved into the state as plain text and should only be used for testing purposes.
62+
- `roles` (Set of String) Roles assigned to the user. Valid roles are `owner`, `template-admin`, `user-admin`, and `auditor`.
6363
- `suspended` (Boolean) Whether the user is suspended.
6464

6565
### Read-Only

‎docs/resources/workspace_proxy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ resource "kubernetes_deployment" "syd_wsproxy" {
4848

4949
### Required
5050

51-
- `icon` (String) Relative path or external URL that specifes an icon to be displayed in the dashboard.
51+
- `icon` (String) Relative path or external URL that specifies an icon to be displayed in the dashboard.
5252
- `name` (String) Name of the workspace proxy.
5353

5454
### Optional

0 commit comments

Comments
 (0)
Please sign in to comment.