Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update docs #1297

Merged
merged 2 commits into from
Oct 28, 2022
Merged

Conversation

mnagaa
Copy link
Contributor

@mnagaa mnagaa commented Oct 21, 2022

Summary

In this PR, I want to fix the styles of the terraform snowflake provider documentation to be the same format. There are some expression of the variables in the example (like below) and it is not suitable for the official documentation.

This PR only includes updates for modules that grant privileges:

  • use UPPERCASE for granting privilege (privilege = "select" => privilege = "SELECT")
  • do not use abbr like database_name = "db" => database_name = "database" and warehouse_name = "wh" => warehouse_name = "warehouse" because some other examples already use "database" for their definitions.

Furthermore, changing the definitions with double quotations seems better as follows.
before

resource snowflake_warehouse_grant grant {
  warehouse_name = "wh"
  privilege      = "MODIFY"

  roles = [
    "role1",
  ]

  with_grant_option = false
}

after

resource "snowflake_warehouse_grant" "grant" {
  warehouse_name = "warehouse"
  privilege      = "MODIFY"

  roles = ["role1", "role2"]

  with_grant_option = false
}

@mnagaa mnagaa changed the title Chore/docs update chore: update docs Oct 21, 2022
@mnagaa
Copy link
Contributor Author

mnagaa commented Oct 21, 2022

@sfc-gh-swinkler Could you please review this change?

@sfc-gh-swinkler sfc-gh-swinkler merged commit 495558c into Snowflake-Labs:main Oct 28, 2022
@sfc-gh-swinkler
Copy link
Collaborator

@mnagaa this looks good, thank you for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants