Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit6933887

Browse files
authored
Improve markdown for attribute descriptions (#86)
1 parent913c3ed commit6933887

File tree

10 files changed

+20
-20
lines changed

10 files changed

+20
-20
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
<aid="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 thatspecifes an icon to be displayed in the dashboard.
51+
-`icon` (String) Relative path or external URL thatspecifies an icon to be displayed in the dashboard.
5252
-`name` (String) Name of the workspace proxy.
5353

5454
###Optional

‎internal/provider/group_data_source.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ func (d *GroupDataSource) Schema(ctx context.Context, req datasource.SchemaReque
9393
Computed:true,
9494
},
9595
"source": schema.StringAttribute{
96-
MarkdownDescription:"The source of the group. Either'oidc' or'user'.",
96+
MarkdownDescription:"The source of the group. Either`oidc` or`user`.",
9797
Computed:true,
9898
},
9999
"members": schema.SetNestedAttribute{
@@ -120,11 +120,11 @@ func (d *GroupDataSource) Schema(ctx context.Context, req datasource.SchemaReque
120120
Computed:true,
121121
},
122122
"status": schema.StringAttribute{
123-
MarkdownDescription:"The status of the member. Can be'active', 'dormant' or'suspended'.",
123+
MarkdownDescription:"The status of the member. Can be`active`, `dormant` or`suspended`.",
124124
Computed:true,
125125
},
126126
"login_type": schema.StringAttribute{
127-
MarkdownDescription:"The login type of the member. Can be'oidc', 'token', 'password', 'github' or'none'.",
127+
MarkdownDescription:"The login type of the member. Can be`oidc`, `token`, `password`, `github` or`none`.",
128128
Computed:true,
129129
},
130130
"theme_preference": schema.StringAttribute{

‎internal/provider/group_resource.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ func (r *GroupResource) Schema(ctx context.Context, req resource.SchemaRequest,
115115
},
116116
},
117117
"members": schema.SetAttribute{
118-
MarkdownDescription:"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`",
118+
MarkdownDescription:"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`",
119119
ElementType:UUIDType,
120120
Optional:true,
121121
},

‎internal/provider/user_data_source.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ func (d *UserDataSource) Schema(ctx context.Context, req datasource.SchemaReques
7272
Computed:true,
7373
},
7474
"roles": schema.SetAttribute{
75-
MarkdownDescription:"Roles assigned to the user. Valid roles are'owner', 'template-admin', 'user-admin', and'auditor'.",
75+
MarkdownDescription:"Roles assigned to the user. Valid roles are`owner`, `template-admin`, `user-admin`, and`auditor`.",
7676
Computed:true,
7777
ElementType:types.StringType,
7878
},
7979
"login_type": schema.StringAttribute{
80-
MarkdownDescription:"Type of login for the user. Valid types are'none', 'password','github', and'oidc'.",
80+
MarkdownDescription:"Type of login for the user. Valid types are`none`, `password',`github`, and`oidc`.",
8181
Computed:true,
8282
},
8383
"suspended": schema.BoolAttribute{

‎internal/provider/user_resource.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ func (r *UserResource) Schema(ctx context.Context, req resource.SchemaRequest, r
8989
Required:true,
9090
},
9191
"roles": schema.SetAttribute{
92-
MarkdownDescription:"Roles assigned to the user. Valid roles are'owner', 'template-admin', 'user-admin', and'auditor'.",
92+
MarkdownDescription:"Roles assigned to the user. Valid roles are`owner`, `template-admin`, `user-admin`, and`auditor`.",
9393
Computed:true,
9494
Optional:true,
9595
ElementType:types.StringType,
@@ -101,7 +101,7 @@ func (r *UserResource) Schema(ctx context.Context, req resource.SchemaRequest, r
101101
Default:setdefault.StaticValue(types.SetValueMust(types.StringType, []attr.Value{})),
102102
},
103103
"login_type": schema.StringAttribute{
104-
MarkdownDescription:"Type of login for the user. Valid types are'none', 'password', 'github', and'oidc'.",
104+
MarkdownDescription:"Type of login for the user. Valid types are`none`, `password`, `github`, and`oidc`.",
105105
Computed:true,
106106
Optional:true,
107107
Validators: []validator.String{
@@ -113,7 +113,7 @@ func (r *UserResource) Schema(ctx context.Context, req resource.SchemaRequest, r
113113
},
114114
},
115115
"password": schema.StringAttribute{
116-
MarkdownDescription:"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.",
116+
MarkdownDescription:"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.",
117117
Optional:true,
118118
Sensitive:true,
119119
},

‎internal/provider/workspace_proxy_resource.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ func (r *WorkspaceProxyResource) Schema(ctx context.Context, req resource.Schema
6060
Computed:true,
6161
},
6262
"icon": schema.StringAttribute{
63-
MarkdownDescription:"Relative path or external URL thatspecifes an icon to be displayed in the dashboard.",
63+
MarkdownDescription:"Relative path or external URL thatspecifies an icon to be displayed in the dashboard.",
6464
Required:true,
6565
},
6666
"session_token": schema.StringAttribute{

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp