Skip to content

Commit

Permalink
docs: remove id flag from docs (#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
malnick authored Oct 13, 2020
1 parent 9e46f2a commit dd9a69e
Show file tree
Hide file tree
Showing 11 changed files with 5 additions and 12 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,6 @@ all:
GOOS=darwin go build -o $(BUILD_ALL_PATH)/terraform-provider-boundary_darwin-amd64 main.go
GOOS=windows go build -o $(BUILD_ALL_PATH)/terraform-provider-boundary_windows-amd64 main.go
GOOS=linux go build -o $(BUILD_ALL_PATH)/terraform-provider-boundary_linux-amd64 main.go

rm-id-flag-from-docs:
find docs/ -name "*.md" -type f | xargs sed -i -e '/- \*\*id\*\*/d'
1 change: 0 additions & 1 deletion docs/resources/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ resource "boundary_account" "jeff" {
### Optional

- **description** (String, Optional) The account description.
- **id** (String, Optional) The ID of this resource.
- **login_name** (String, Optional) The login name for this account.
- **name** (String, Optional) The account name. Defaults to the resource name.
- **password** (String, Optional) The account password.
Expand Down
1 change: 0 additions & 1 deletion docs/resources/auth_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ resource "boundary_auth_method" "password" {
### Optional

- **description** (String, Optional) The auth method description.
- **id** (String, Optional) The ID of this resource.
- **min_login_name_length** (Number, Optional) The minimum login name length.
- **min_password_length** (Number, Optional) The minimum password length.
- **name** (String, Optional) The auth method name. Defaults to the resource name.
Expand Down
1 change: 0 additions & 1 deletion docs/resources/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ resource "boundary_group" "example" {
### Optional

- **description** (String, Optional) The group description.
- **id** (String, Optional) The ID of this resource.
- **member_ids** (Set of String, Optional) Resource IDs for group members, these are most likely boundary users.
- **name** (String, Optional) The group name. Defaults to the resource name.

Expand Down
1 change: 0 additions & 1 deletion docs/resources/host.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ resource "boundary_host" "example" {

- **address** (String, Optional) The static address of the host resource as `<IP>` (note: port assignment occurs in the target resource definition, do not add :port here) or a domain name.
- **description** (String, Optional) The host description.
- **id** (String, Optional) The ID of this resource.
- **name** (String, Optional) The host name. Defaults to the resource name.

## Import
Expand Down
1 change: 0 additions & 1 deletion docs/resources/host_catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ resource "boundary_host_catalog" "example" {
### Optional

- **description** (String, Optional) The host catalog description.
- **id** (String, Optional) The ID of this resource.
- **name** (String, Optional) The host catalog name. Defaults to the resource name.

## Import
Expand Down
1 change: 0 additions & 1 deletion docs/resources/host_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ resource "boundary_host_set" "web" {

- **description** (String, Optional) The hostset description.
- **host_ids** (Set of String, Optional) The list of host IDs contained in this set.
- **id** (String, Optional) The ID of this resource.
- **name** (String, Optional) The hostset name. Defaults to the resource name.

## Import
Expand Down
3 changes: 1 addition & 2 deletions docs/resources/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ resource "boundary_role" "readonly" {
- **description** (String, Optional) The role description.
- **grant_scope_id** (String, Optional)
- **grant_strings** (Set of String, Optional) A list of stringified grants for the role.
- **id** (String, Optional) The ID of this resource.
- **name** (String, Optional) The role name. Defaults to the resource name.
- **principal_ids** (Set of String, Optional) A list of principal (user or group) IDs to add as principals on the role.

Expand All @@ -135,4 +134,4 @@ Import is supported using the following syntax:

```shell
terraform import boundary_role.foo <my-id>
```
```
3 changes: 1 addition & 2 deletions docs/resources/scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ resource "boundary_role" "org_admin" {
- **auto_create_default_role** (Boolean, Optional) If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. Marking this true makes for simpler HCL but results in role resources that are unmanaged by Terraform.
- **description** (String, Optional) The scope description.
- **global_scope** (Boolean, Optional) Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed.
- **id** (String, Optional) The ID of this resource.
- **name** (String, Optional) The scope name. Defaults to the resource name.

## Import
Expand All @@ -81,4 +80,4 @@ Import is supported using the following syntax:

```shell
terraform import boundary_scope.foo <my-id>
```
```
1 change: 0 additions & 1 deletion docs/resources/target.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ resource "boundary_target" "foo" {
- **default_port** (Number, Optional) The default port for this target.
- **description** (String, Optional) The target description.
- **host_set_ids** (Set of String, Optional) A list of host set ID's.
- **id** (String, Optional) The ID of this resource.
- **name** (String, Optional) The target name. Defaults to the resource name.
- **session_connection_limit** (Number, Optional)
- **session_max_seconds** (Number, Optional)
Expand Down
1 change: 0 additions & 1 deletion docs/resources/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ resource "boundary_user" "jeff" {

- **account_ids** (Set of String, Optional) Account ID's to associate with this user resource.
- **description** (String, Optional) The user description.
- **id** (String, Optional) The ID of this resource.
- **name** (String, Optional) The username. Defaults to the resource name.

## Import
Expand Down

0 comments on commit dd9a69e

Please sign in to comment.