Skip to content

Commit 2c1529e

Browse files
authored
Merge pull request #982 from StingRayZA/docs-fix
Update group resource inline docs
2 parents e1fff6c + 319f2ba commit 2c1529e

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

docs/resources/group.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,21 +43,21 @@ resource "gitlab_project" "example" {
4343

4444
### Optional
4545

46-
- `auto_devops_enabled` (Boolean) Boolean, defaults to false. Default to Auto
47-
- `default_branch_protection` (Number) Int, defaults to 2.
46+
- `auto_devops_enabled` (Boolean) Defaults to false. Default to Auto DevOps pipeline for all projects within this group.
47+
- `default_branch_protection` (Number) Defaults to 2. See https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection
4848
- `description` (String) The description of the group.
49-
- `emails_disabled` (Boolean) Boolean, defaults to false. Disable email notifications
49+
- `emails_disabled` (Boolean) Defaults to false. Disable email notifications.
5050
- `id` (String) The ID of this resource.
51-
- `lfs_enabled` (Boolean) Boolean, defaults to true. Whether to enable LFS
52-
- `mentions_disabled` (Boolean) Boolean, defaults to false. Disable the capability
53-
- `parent_id` (Number) Integer, id of the parent group (creates a nested group).
54-
- `prevent_forking_outside_group` (Boolean) When enabled, users can not fork projects from this group to external namespaces.
55-
- `project_creation_level` (String) , defaults to Maintainer.
56-
- `request_access_enabled` (Boolean) Boolean, defaults to false. Whether to
57-
- `require_two_factor_authentication` (Boolean) Boolean, defaults to false.
58-
- `share_with_group_lock` (Boolean) Boolean, defaults to false. Prevent sharing
59-
- `subgroup_creation_level` (String) , defaults to Owner.
60-
- `two_factor_grace_period` (Number) Int, defaults to 48.
51+
- `lfs_enabled` (Boolean) Defaults to true. Enable/disable Large File Storage (LFS) for the projects in this group.
52+
- `mentions_disabled` (Boolean) Defaults to false. Disable the capability of a group from getting mentioned.
53+
- `parent_id` (Number) Id of the parent group (creates a nested group).
54+
- `prevent_forking_outside_group` (Boolean) Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
55+
- `project_creation_level` (String) Defaults to maintainer. Determine if developers can create projects in the group.
56+
- `request_access_enabled` (Boolean) Defaults to false. Allow users to request member access.
57+
- `require_two_factor_authentication` (Boolean) Defaults to false. Require all users in this group to setup Two-factor authentication.
58+
- `share_with_group_lock` (Boolean) Defaults to false. Prevent sharing a project with another group within this group.
59+
- `subgroup_creation_level` (String) Defaults to owner. Allowed to create subgroups.
60+
- `two_factor_grace_period` (Number) Defaults to 48. Time before Two-factor authentication is enforced (in hours).
6161
- `visibility_level` (String) The group's visibility. Can be `private`, `internal`, or `public`.
6262

6363
### Read-Only

internal/provider/resource_gitlab_group.go

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -63,20 +63,20 @@ var _ = registerResource("gitlab_group", func() *schema.Resource {
6363
Optional: true,
6464
},
6565
"lfs_enabled": {
66-
Description: "Boolean, defaults to true. Whether to enable LFS",
66+
Description: "Defaults to true. Enable/disable Large File Storage (LFS) for the projects in this group.",
6767
Type: schema.TypeBool,
6868
Optional: true,
6969
Default: true,
7070
},
7171
"default_branch_protection": {
72-
Description: "Int, defaults to 2.",
72+
Description: "Defaults to 2. See https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection",
7373
Type: schema.TypeInt,
7474
Optional: true,
7575
Default: 2,
7676
ValidateFunc: validation.IntInSlice([]int{0, 1, 2}),
7777
},
7878
"request_access_enabled": {
79-
Description: "Boolean, defaults to false. Whether to",
79+
Description: "Defaults to false. Allow users to request member access.",
8080
Type: schema.TypeBool,
8181
Optional: true,
8282
Default: false,
@@ -89,57 +89,57 @@ var _ = registerResource("gitlab_group", func() *schema.Resource {
8989
ValidateFunc: validation.StringInSlice([]string{"private", "internal", "public"}, true),
9090
},
9191
"share_with_group_lock": {
92-
Description: "Boolean, defaults to false. Prevent sharing",
92+
Description: "Defaults to false. Prevent sharing a project with another group within this group.",
9393
Type: schema.TypeBool,
9494
Optional: true,
9595
Default: false,
9696
},
9797
"project_creation_level": {
98-
Description: ", defaults to Maintainer.",
98+
Description: "Defaults to maintainer. Determine if developers can create projects in the group.",
9999
Type: schema.TypeString,
100100
Optional: true,
101101
Default: "maintainer",
102102
ValidateFunc: validation.StringInSlice([]string{"noone", "maintainer", "developer"}, true),
103103
},
104104
"auto_devops_enabled": {
105-
Description: "Boolean, defaults to false. Default to Auto",
105+
Description: "Defaults to false. Default to Auto DevOps pipeline for all projects within this group.",
106106
Type: schema.TypeBool,
107107
Optional: true,
108108
Default: false,
109109
},
110110
"emails_disabled": {
111-
Description: "Boolean, defaults to false. Disable email notifications",
111+
Description: "Defaults to false. Disable email notifications.",
112112
Type: schema.TypeBool,
113113
Optional: true,
114114
Default: false,
115115
},
116116
"mentions_disabled": {
117-
Description: "Boolean, defaults to false. Disable the capability",
117+
Description: "Defaults to false. Disable the capability of a group from getting mentioned.",
118118
Type: schema.TypeBool,
119119
Optional: true,
120120
Default: false,
121121
},
122122
"subgroup_creation_level": {
123-
Description: ", defaults to Owner.",
123+
Description: "Defaults to owner. Allowed to create subgroups.",
124124
Type: schema.TypeString,
125125
Optional: true,
126126
Default: "owner",
127127
ValidateFunc: validation.StringInSlice([]string{"owner", "maintainer"}, true),
128128
},
129129
"require_two_factor_authentication": {
130-
Description: "Boolean, defaults to false.",
130+
Description: "Defaults to false. Require all users in this group to setup Two-factor authentication.",
131131
Type: schema.TypeBool,
132132
Optional: true,
133133
Default: false,
134134
},
135135
"two_factor_grace_period": {
136-
Description: "Int, defaults to 48.",
136+
Description: "Defaults to 48. Time before Two-factor authentication is enforced (in hours).",
137137
Type: schema.TypeInt,
138138
Optional: true,
139139
Default: 48,
140140
},
141141
"parent_id": {
142-
Description: "Integer, id of the parent group (creates a nested group).",
142+
Description: "Id of the parent group (creates a nested group).",
143143
Type: schema.TypeInt,
144144
Optional: true,
145145
ForceNew: true,
@@ -152,7 +152,7 @@ var _ = registerResource("gitlab_group", func() *schema.Resource {
152152
Sensitive: true,
153153
},
154154
"prevent_forking_outside_group": {
155-
Description: "When enabled, users can not fork projects from this group to external namespaces.",
155+
Description: "Defaults to false. When enabled, users can not fork projects from this group to external namespaces.",
156156
Type: schema.TypeBool,
157157
Optional: true,
158158
Default: false,

0 commit comments

Comments
 (0)