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.

Sign up for GitHub

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

Jump to bottom

[Feature]: Improve documentation for snowflake_grant_privileges_to_account_role #2994

Open
1 task
bdumford-OM1 opened this issue Aug 13, 2024 · 2 comments
Open
1 task

[Feature]: Improve documentation for snowflake_grant_privileges_to_account_role #2994

bdumford-OM1 opened this issue Aug 13, 2024 · 2 comments
Assignees
@sfc-gh-jmichalak
Labels
docs Used to mark issues with documentation remark/questions resource:grant_privileges_to_account_role Issue connected to the snowflake_grant_privileges_to_account_role resource

Comments

@bdumford-OM1
Copy link

Use Cases or Problem Statement

This is not a huge deal, but could the documentation for snowflake_grant_privileges_to_account_role be improved? Specifically, there needs to be better documentation for how to migrate from the deprecated snowflake_procedure_grant resource to snowflake_grant_privileges_to_account_role.

When migrating from the snowflake_procedure_grant resource, it was not at all obvious as to where to put the argument_data_types. After a lot of searching, I found the answer in issue #2375 and on the CREATING_ISSUES page. Since there is a solution available, it would make sense to document it in the appropriate places.

Category

category:other

Object type(s)

No response

Proposal

An example for migrating from the snowflake_procedure_grant should be added to the MIGRATION_GUIDE. Additionally, an example like the one here should be added to the Terraform registry page for snowflake_grant_privileges_to_account_role.

How much impact is this issue causing?

Low

Additional Information

No response

Would you like to implement a fix?

  • Yeah, I'll take it 😎
@bdumford-OM1 bdumford-OM1 added the feature-request Used to mark issues with provider's missing functionalities label Aug 13, 2024
@sfc-gh-jmichalak sfc-gh-jmichalak added resource:grant_privileges_to_account_role Issue connected to the snowflake_grant_privileges_to_account_role resource docs Used to mark issues with documentation remark/questions and removed feature-request Used to mark issues with provider's missing functionalities labels Aug 14, 2024
@sfc-gh-jmichalak
Copy link
Collaborator

Hi @bdumford-OM1 👋 Thanks for the feedback. These things can be added to our docs. Currently we're reworking essential objects on our road to v1. We welcome community contributions based on our contribution guide.

MIGRATION_GUIDE is updated manually, and snowflake_grant_privileges_to_account_role example is located in examples/resources/snowflake_grant_privileges_to_account_role/resource.tf.

@sfc-gh-jmichalak sfc-gh-jmichalak mentioned this issue Sep 16, 2024
Merged
2 tasks
sfc-gh-jmichalak added a commit that referenced this issue Sep 17, 2024
@sfc-gh-jmichalak
fix: Fix views permadiff (#3079)
c2d3e5c 
<!-- Feel free to delete comments as you fill this in -->
- fix permadiff when columns are not specified
- adjust row access policy signature in describe_output and move parsing
to sdk
- adjust the identifier doc - add procedure id 
<!-- summary of changes -->

## Test Plan
<!-- detail ways in which this PR has been tested or needs to be tested
-->
* [x] acceptance tests
<!-- add more below if you think they are relevant -->
* [ ] …

## References
<!-- issues documentation links, etc  -->

#3073
#2994
sfc-gh-fbudzynski pushed a commit that referenced this issue Sep 19, 2024
@sfc-gh-jmichalak @sfc-gh-fbudzynski
fix: Fix views permadiff (#3079)
8b1ece0 
<!-- Feel free to delete comments as you fill this in -->
- fix permadiff when columns are not specified
- adjust row access policy signature in describe_output and move parsing
to sdk
- adjust the identifier doc - add procedure id 
<!-- summary of changes -->

## Test Plan
<!-- detail ways in which this PR has been tested or needs to be tested
-->
* [x] acceptance tests
<!-- add more below if you think they are relevant -->
* [ ] …

## References
<!-- issues documentation links, etc  -->

#3073
#2994
@sfc-gh-jmichalak
Copy link
Collaborator

Hi, we've released v0.96.0, which adjusts the documentation.

We've added an example to https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/guides/identifiers. Also, we've decided not to include a separate example in snowflake_grant_privileges_to_account_role because now we highly recommend using <resource_name>.fully_qualified_name to reference other objects. All of the examples were adjusted to use this field and we added an entry to the migration guide about this change. But we left a note below that instead of using this new field, IDs can be constructed manually by hand, like before.

Let us know if this works for you!

@sfc-gh-jmichalak sfc-gh-jmichalak self-assigned this Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sfc-gh-jmichalak sfc-gh-jmichalak

Labels
docs Used to mark issues with documentation remark/questions resource:grant_privileges_to_account_role Issue connected to the snowflake_grant_privileges_to_account_role resource
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bdumford-OM1 @sfc-gh-jmichalak