search

confluentinc / ccloud-tools

Running Tools from Confluent Platform along with your Confluent Cloud™ Cluster
Apache License 2.0
65 stars 31 forks source link

Refactoring the README for better clarity #1

Closed riferrei closed 6 years ago

tlberglund commented 6 years ago

This may be a bit of a PR hijack, but as I was reading the PR, I realized it might be better to alter the procedure a bit:

As it stands, people will fork this and commit cloud credentials. :)

You cool with this? I can modify the README accordingly if so.

riferrei commented 6 years ago

This may be a bit of a PR hijack, but as I was reading the PR, I realized it might be better to alter the procedure a bit:

  • Rename the .tfvars files to .tfvars.example
  • Add instructions in the README to remove the .example extension
  • Add *.tfvars to terraform/.gitignore

As it stands, people will fork this and commit cloud credentials. :)

You cool with this? I can modify the README accordingly if so.

Totally. In fact, that will play very well because due to Terraform's behavior -- if there are no tfvars during the compiling phase then it will just ask (literally) for the values during the apply phase. Tfvars are just a convenient way to specify the values of declared variables.