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

Update index.md to include authenticator config value #2509

Closed
wants to merge 1 commit into from

Conversation

Zesky665
Copy link

Added authenticator value to the documentation.

Test Plan

  • acceptance tests

References

@sfc-gh-asawicki
Copy link
Collaborator

Hey @Zesky665. Thanks for the suggestion.

This change cannot be merged, though. The reason is, that the docs (markdown files) are generated. You have to change the input (examples/provider/provider.tf) and then regenerate the docs. Without such a change it will be lost with the next docs generation. To generate them, you would have to:

  1. update the example
  2. setup dev env (make dev-setup)
  3. generate the docs (make pre-push).

I am just writing this as an explanation for the future. I will introduce such change today with one of my other PRs.

We do not have proper contribution guidelines yet, but this is something we will introduce in the next couple of weeks. Docs generation will be one of the topics described there.

@Zesky665
Copy link
Author

@sfc-gh-asawicki Thank you for the heads up.

Please let me know when the contribution guidelines are introduced, I would very much like to work on improving the documentation.

sfc-gh-asawicki added a commit that referenced this pull request Feb 16, 2024
@sfc-gh-asawicki
Copy link
Collaborator

Superseded by #2515

sfc-gh-asawicki added a commit that referenced this pull request Feb 16, 2024
- Introduce the requested change inside the docs #2509 
- Attempt to fix `TestAcc_ResourceMonitor` flaky test
- Set random name in test from #2511
- Add error log to task suspension (in the place it fails on CI mostly)
@sfc-gh-asawicki
Copy link
Collaborator

Hey @Zesky665 . We have refreshed the contribution guidelines: https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/CONTRIBUTING.md. Please let me know if you think anything is missing.

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