Skip to content

Commit e6e4601

Browse files
committed
More examples and better documentation
1 parent 93a0a3b commit e6e4601

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

docs/data-sources/user.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ data "gitlab_user" "example" {
1111
```
1212

1313
### Example using `for_each`
14+
1415
```hcl
1516
data "gitlab_user" "example-two" {
1617
for_each = toset(["user1", "user2", "user3"])
@@ -29,7 +30,7 @@ The following arguments are supported:
2930

3031
* `user_id` - (Optional) The ID of the user.
3132

32-
-> **Note** Only one of email, user_id, or username must be provided.
33+
-> Only one of email, user_id, or username must be provided.
3334

3435
## Attributes Reference
3536

@@ -85,4 +86,4 @@ The following arguments are supported:
8586

8687
* `current_sign_in_at` - Current user's sign-in date.
8788

88-
-> **Note** Some attributes might not be returned depending on if you're an admin or not. Please refer to [Gitlab documentation](https://docs.gitlab.com/ce/api/users.html#single-user) for more details.
89+
-> Some attributes might not be returned depending on if you're an admin or not. Please refer to [Gitlab documentation](https://docs.gitlab.com/ce/api/users.html#single-user) for more details.

docs/resources/branch_protection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This resource allows you to protect a specific branch by an access level so that the user with less access level cannot Merge/Push to the branch.
44

5-
-> **NOTE**: The `allowed_to_push`, `allowed_to_merge` and `code_owner_approval_required` arguments require a GitLab Premium account or above. Please refer to [Gitlab API documentation](https://docs.gitlab.com/ee/api/protected_branches.html) for further information.
5+
-> The `allowed_to_push`, `allowed_to_merge` and `code_owner_approval_required` arguments require a GitLab Premium account or above. Please refer to [Gitlab API documentation](https://docs.gitlab.com/ee/api/protected_branches.html) for further information.
66

77
## Example Usage
88

docs/resources/project_approval_rule.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ resource "gitlab_project_approval_rule" "example-two" {
3737
```
3838

3939
### Example using `data.gitlab_user` and `for` loop
40+
4041
```hcl
4142
data "gitlab_user" "users" {
4243
for_each = toset(["user1", "user2", "user3"])

docs/resources/user.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This resource allows you to create and manage GitLab users.
44
Note your provider will need to be configured with admin-level access for this resource to work.
55

6-
-> **Note:** You must specify either `password` or `reset_password`.
6+
-> You must specify either `password` or `reset_password`.
77

88
## Example Usage
99

@@ -33,7 +33,7 @@ The following arguments are supported:
3333

3434
* `password` - (Optional) The password of the user.
3535

36-
* `is_admin` - (Optional) Boolean, defaults to false. Whether to enable administrative priviledges
36+
* `is_admin` - (Optional) Boolean, defaults to false. Whether to enable administrative privileges
3737
for the user.
3838

3939
* `projects_limit` - (Optional) Integer, defaults to 0. Number of projects user can create.

0 commit comments

Comments
 (0)