Skip to content

Commit 6f9db07

Browse files
committed
resource/gitlab_user: Improve documentation and reference upstream docs
1 parent e5d9b5d commit 6f9db07

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

docs/resources/user.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,21 @@
33
page_title: "gitlab_user Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
This resource allows you to create and manage GitLab users.
7-
Note your provider will need to be configured with admin-level access for this resource to work.
6+
The gitlab_user resource allows to manage the lifecycle of a user.
7+
-> the provider needs to be configured with admin-level access for this resource to work.
88
-> You must specify either password or reset_password.
9+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/users.html
910
---
1011

1112
# gitlab_user (Resource)
1213

13-
This resource allows you to create and manage GitLab users.
14-
Note your provider will need to be configured with admin-level access for this resource to work.
14+
The `gitlab_user` resource allows to manage the lifecycle of a user.
1515

16-
-> You must specify either `password` or `reset_password`.
16+
-> the provider needs to be configured with admin-level access for this resource to work.
17+
18+
-> You must specify either password or reset_password.
19+
20+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/users.html)
1721

1822
## Example Usage
1923

internal/provider/resource_gitlab_user.go

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,13 @@ var validUserStateValues = []string{
2222

2323
var _ = registerResource("gitlab_user", func() *schema.Resource {
2424
return &schema.Resource{
25-
Description: "This resource allows you to create and manage GitLab users.\n" +
26-
"Note your provider will need to be configured with admin-level access for this resource to work.\n\n" +
27-
"-> You must specify either `password` or `reset_password`.",
25+
Description: `The ` + "`gitlab_user`" + ` resource allows to manage the lifecycle of a user.
26+
27+
-> the provider needs to be configured with admin-level access for this resource to work.
28+
29+
-> You must specify either password or reset_password.
30+
31+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/users.html)`,
2832

2933
CreateContext: resourceGitlabUserCreate,
3034
ReadContext: resourceGitlabUserRead,

0 commit comments

Comments
 (0)