Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shu Kutsuzawa committed Aug 12, 2020
1 parent 9844cc2 commit 597aec4
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 8 deletions.
16 changes: 8 additions & 8 deletions concourse/data_source_team.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,42 +21,42 @@ func dataSourceTeam() *schema.Resource {
},
"owner_groups": {
Type: schema.TypeList,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
"owner_users": {
Type: schema.TypeList,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
"member_groups": {
Type: schema.TypeList,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
"member_users": {
Type: schema.TypeList,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
"viewer_groups": {
Type: schema.TypeList,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
"viewer_users": {
Type: schema.TypeList,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
"pipeline_operator_groups": {
Type: schema.TypeList,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
"pipeline_operator_users": {
Type: schema.TypeList,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
},
Expand Down
28 changes: 28 additions & 0 deletions docs/data-sources/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# concourse_team

## Example Usage

```hcl
data "concourse_team" "main" {
name = "main"
}
```

## Argument References

The following arguments are supported:

* `name` - (Required) The name of the team.

## Attributes References

* `id` - The ID of the team
* `name` - The name of the team.
* `owner_groups` - The owner group list.
* `owner_users` - The owner user list.
* `member_groups` - The member group list.
* `member_users` - The member user list.
* `viewer_groups` - The viewer group list.
* `viewer_users` - The viewer user list.
* `pipeline_operator_groups` - The pipeline operator group list.
* `pipeline_operator_users` - The pipeline operator user list.
27 changes: 27 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,28 @@
# Concourse Provider

This provider enables to operate concourse.

## Example Usage

```hcl
provider "concourse" {
url = "https://example.concourse.com"
username = "foo"
password = "bar"
}
resource "concourse_team" "main" {
name = "main"
owner_groups = [
"oidc:123456789"
]
}
```

## Argument References

The following arguments are supported:

* `url` - (Required) The url of your concourse.
* `username` - (Required) The username of a local user.
* `password` - (Required) The password of a local user.
39 changes: 39 additions & 0 deletions docs/resources/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# concourse_team

This resource can operates concourse teams.

## Example Usage

```hcl
resource "concourse_team" "main" {
name = "main"
owner_groups = [
"oidc:123456789"
]
}
```

## Argument References

* `name` - (Required) The name of the team.
* `owner_groups` - (Optional) The owner group list.
* `owner_users` - (Optional) The owner user list.
* `member_groups` - (Optional) The member group list.
* `member_users` - (Optional) The member user list.
* `viewer_groups` - (Optional) The viewer group list.
* `viewer_users` - (Optional) The viewer user list.
* `pipeline_operator_groups` - (Optional) The pipeline operator group list.
* `pipeline_operator_users` - (Optional) The pipeline operator user list.

## Attributes References

* `id` - The ID of the team
* `name` - The name of the team.
* `owner_groups` - The owner group list.
* `owner_users` - The owner user list.
* `member_groups` - The member group list.
* `member_users` - The member user list.
* `viewer_groups` - The viewer group list.
* `viewer_users` - The viewer user list.
* `pipeline_operator_groups` - The pipeline operator group list.
* `pipeline_operator_users` - The pipeline operator user list.

0 comments on commit 597aec4

Please sign in to comment.