Skip to content

Commit

Permalink
chore(docs): update documentation adding double quotes (#1346)
Browse files Browse the repository at this point in the history
* feat: update document

* chore: apply make docs
  • Loading branch information
mnagaa authored Nov 7, 2022
1 parent 62bf8b7 commit c4af174
Show file tree
Hide file tree
Showing 38 changed files with 102 additions and 102 deletions.
2 changes: 1 addition & 1 deletion docs/resources/account_grant.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_account_grant grant {
resource "snowflake_account_grant" "grant" {
roles = ["role1", "role2"]
privilege = "CREATE ROLE"
with_grant_option = false
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/external_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_external_table external_table {
resource "snowflake_external_table" "external_table" {
database = "db"
schema = "schema"
name = "external_table"
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/integration_grant.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_integration_grant grant {
resource "snowflake_integration_grant" "grant" {
integration_name = "integration"
privilege = "USAGE"
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/managed_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_managed_account account {
resource "snowflake_managed_account" "account" {
name = "managed account"
admin_name = "admin"
admin_password = "secret"
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/network_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_network_policy policy {
resource "snowflake_network_policy" "policy" {
name = "policy"
comment = "A policy."
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/network_policy_attachment.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ description: |-
## Example Usage

```terraform
resource snowflake_network_policy_attachment attach {
resource "snowflake_network_policy_attachment" "attach" {
network_policy_name = "policy"
set_for_account = false
users = ["user1", "user2"]
users = ["user1", "user2"]
}
```

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/notification_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ description: |-
## Example Usage

```terraform
resource snowflake_notification_integration integration {
resource "snowflake_notification_integration" "integration" {
name = "notification"
comment = "A notification integration."
enabled = true
type = "QUEUE"
direction = "OUTBOUND"
Expand All @@ -28,12 +28,12 @@ resource snowflake_notification_integration integration {
# AWS_SQS
#notification_provider = "AWS_SQS"
#aws_sqs_arn = "..."
#aws_sqs_arn = "..."
#aws_sqs_role_arn = "..."
# AWS_SNS
#notification_provider = "AWS_SNS"
#aws_sns_topic_arn = "..."
#aws_sns_topic_arn = "..."
#aws_sns_role_arn = "..."
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/resource_monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_resource_monitor monitor {
resource "snowflake_resource_monitor" "monitor" {
name = "monitor"
credit_quota = 100
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_role role {
resource "snowflake_role" "role" {
name = "role1"
comment = "A role."
}
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ description: |-
## Example Usage

```terraform
resource snowflake_schema schema {
database = "db"
resource "snowflake_schema" "schema" {
database = "database"
name = "schema"
comment = "A schema."
Expand Down
8 changes: 4 additions & 4 deletions docs/resources/share.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ description: |-
## Example Usage

```terraform
resource snowflake_share test {
name = "share_name"
comment = "cool comment"
accounts = ["organizationName.accountName"]
resource "snowflake_share" "test" {
name = "share_name"
comment = "cool comment"
accounts = ["organizationName.accountName"]
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/storage_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_storage_integration integration {
resource "snowflake_storage_integration" "integration" {
name = "storage"
comment = "A storage integration."
type = "EXTERNAL_STAGE"
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ description: |-
resource "snowflake_stream" "stream" {
comment = "A stream."
database = "db"
database = "database"
schema = "schema"
name = "stream"
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ description: |-

```terraform
resource "snowflake_database" "database" {
name = "db1"
name = "database"
}
resource "snowflake_schema" "schema" {
name = "schema1"
name = "schema"
database = snowflake_database.database.name
}
Expand Down
40 changes: 20 additions & 20 deletions docs/resources/tag_association.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ description: |-

```terraform
resource "snowflake_database" "database" {
name = "db1"
name = "database"
}
resource "snowflake_schema" "schema" {
name = "schema1"
name = "schema"
database = snowflake_database.database.name
}
Expand All @@ -33,24 +33,24 @@ resource "snowflake_tag_association" "db_association" {
object_identifier {
name = snowflake_database.database.name
}
object_type = "DATABASE"
tag_id = snowflake_tag.tag.id
tag_value = "finance"
object_type = "DATABASE"
tag_id = snowflake_tag.tag.id
tag_value = "finance"
}
resource "snowflake_table" "test" {
database = snowflake_database.test.name
schema = snowflake_schema.test.name
name = "TABLE_NAME"
comment = "Terraform example table"
column {
name = "column1"
type = "VARIANT"
}
column {
name = "column2"
type = "VARCHAR(16)"
}
database = snowflake_database.test.name
schema = snowflake_schema.test.name
name = "TABLE_NAME"
comment = "Terraform example table"
column {
name = "column1"
type = "VARIANT"
}
column {
name = "column2"
type = "VARCHAR(16)"
}
}
resource "snowflake_tag_association" "table_association" {
Expand All @@ -59,9 +59,9 @@ resource "snowflake_tag_association" "table_association" {
database = snowflake_database.test.name
schema = snowflake_schema.test.name
}
object_type = "TABLE"
tag_id = snowflake_tag.test.id
tag_value = "engineering"
object_type = "TABLE"
tag_id = snowflake_tag.test.id
tag_value = "engineering"
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ description: |-
resource "snowflake_task" "task" {
comment = "my task"
database = "db"
database = "database"
schema = "schema"
warehouse = "warehouse"
Expand Down Expand Up @@ -58,7 +58,7 @@ resource "snowflake_task" "serverless_task" {
resource "snowflake_task" "test_task" {
comment = "task with allow_overlapping_execution"
database = "db"
database = "database"
schema = "schema"
name = "test_task"
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_user user {
resource "snowflake_user" "user" {
name = "Snowflake User"
login_name = "snowflake_user"
comment = "A user of snowflake."
Expand All @@ -24,9 +24,9 @@ resource snowflake_user user {
first_name = "Snowflake"
last_name = "User"
default_warehouse = "warehouse"
default_warehouse = "warehouse"
default_secondary_roles = ["ALL"]
default_role = "role1"
default_role = "role1"
rsa_public_key = "..."
rsa_public_key_2 = "..."
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ description: |-
## Example Usage

```terraform
resource snowflake_view view {
database = "db"
resource "snowflake_view" "view" {
database = "database"
schema = "schema"
name = "view"
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/warehouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```terraform
resource snowflake_warehouse w {
resource "snowflake_warehouse" "warehouse" {
name = "test"
comment = "foo"
warehouse_size = "small"
Expand Down
2 changes: 1 addition & 1 deletion examples/resources/snowflake_account_grant/resource.tf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
resource snowflake_account_grant grant {
resource "snowflake_account_grant" "grant" {
roles = ["role1", "role2"]
privilege = "CREATE ROLE"
with_grant_option = false
Expand Down
2 changes: 1 addition & 1 deletion examples/resources/snowflake_external_table/resource.tf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
resource snowflake_external_table external_table {
resource "snowflake_external_table" "external_table" {
database = "db"
schema = "schema"
name = "external_table"
Expand Down
2 changes: 1 addition & 1 deletion examples/resources/snowflake_integration_grant/resource.tf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
resource snowflake_integration_grant grant {
resource "snowflake_integration_grant" "grant" {
integration_name = "integration"

privilege = "USAGE"
Expand Down
2 changes: 1 addition & 1 deletion examples/resources/snowflake_managed_account/resource.tf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
resource snowflake_managed_account account {
resource "snowflake_managed_account" "account" {
name = "managed account"
admin_name = "admin"
admin_password = "secret"
Expand Down
2 changes: 1 addition & 1 deletion examples/resources/snowflake_network_policy/resource.tf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
resource snowflake_network_policy policy {
resource "snowflake_network_policy" "policy" {
name = "policy"
comment = "A policy."

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
resource snowflake_network_policy_attachment attach {
resource "snowflake_network_policy_attachment" "attach" {
network_policy_name = "policy"
set_for_account = false
users = ["user1", "user2"]
users = ["user1", "user2"]
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
resource snowflake_notification_integration integration {
resource "snowflake_notification_integration" "integration" {
name = "notification"
comment = "A notification integration."

enabled = true
type = "QUEUE"
direction = "OUTBOUND"
Expand All @@ -13,11 +13,11 @@ resource snowflake_notification_integration integration {

# AWS_SQS
#notification_provider = "AWS_SQS"
#aws_sqs_arn = "..."
#aws_sqs_arn = "..."
#aws_sqs_role_arn = "..."

# AWS_SNS
#notification_provider = "AWS_SNS"
#aws_sns_topic_arn = "..."
#aws_sns_topic_arn = "..."
#aws_sns_role_arn = "..."
}
2 changes: 1 addition & 1 deletion examples/resources/snowflake_resource_monitor/resource.tf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
resource snowflake_resource_monitor monitor {
resource "snowflake_resource_monitor" "monitor" {
name = "monitor"
credit_quota = 100

Expand Down
2 changes: 1 addition & 1 deletion examples/resources/snowflake_role/resource.tf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
resource snowflake_role role {
resource "snowflake_role" "role" {
name = "role1"
comment = "A role."
}
4 changes: 2 additions & 2 deletions examples/resources/snowflake_schema/resource.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
resource snowflake_schema schema {
database = "db"
resource "snowflake_schema" "schema" {
database = "database"
name = "schema"
comment = "A schema."

Expand Down
8 changes: 4 additions & 4 deletions examples/resources/snowflake_share/resource.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
resource snowflake_share test {
name = "share_name"
comment = "cool comment"
accounts = ["organizationName.accountName"]
resource "snowflake_share" "test" {
name = "share_name"
comment = "cool comment"
accounts = ["organizationName.accountName"]
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
resource snowflake_storage_integration integration {
resource "snowflake_storage_integration" "integration" {
name = "storage"
comment = "A storage integration."
type = "EXTERNAL_STAGE"
Expand Down
2 changes: 1 addition & 1 deletion examples/resources/snowflake_stream/resource.tf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
resource "snowflake_stream" "stream" {
comment = "A stream."

database = "db"
database = "database"
schema = "schema"
name = "stream"

Expand Down
Loading

0 comments on commit c4af174

Please sign in to comment.