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 docs, add markdown-spellcheck config, and refactor tests #6

Merged
merged 6 commits into from
Mar 25, 2022

Conversation

tlindsay42
Copy link
Member

No description provided.

* Reword & enhance summaries
* Add usage sections
* Use the official source for example with a set version for optimal
  presentation in the Terraform Registry
* List complete input variable config in comment
* Override defaults where necessary for each test
* Configure external dependencies via environment variable for better
  developer experience
@tlindsay42 tlindsay42 self-assigned this Mar 18, 2022
Copy link
Contributor

@andrew-glenn andrew-glenn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment

@@ -9,13 +9,15 @@ import (
"github.com/stretchr/testify/require"
)

// You must set these environment variables for this test
const (
user = "VSPHERE_USER"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same query as before - the provider only supports env var configuration?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope! Both environment variables and input variables are supported for configuring the vsphere provider- just like the aws & awscc providers. I had to pick one as a design decision for the examples and chose environment variables as I generally prefer to encourage not writing credentials to persistent storage- especially for those inexperienced with terraform, which are the primary audience of the examples. I included the documentation link in the comment to make it easy for customers that typically use input variables for configuring the vsphere provider credentials to learn how to use environment variables. They also have the option to edit the example locally if they prefer otherwise. :)

@tlindsay42 tlindsay42 merged commit dd2e727 into main Mar 25, 2022
@tlindsay42 tlindsay42 deleted the docs branch March 25, 2022 15:28
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