Skip to content
This repository has been archived by the owner on Mar 29, 2023. It is now read-only.

Add root example to README #31

Merged
merged 2 commits into from
May 7, 2019
Merged

Add root example to README #31

merged 2 commits into from
May 7, 2019

Conversation

rileykarson
Copy link
Contributor

No description provided.

@yorinasub17
Copy link
Contributor

I know we've been doing this for all our repos, but should we remove the tf code in the example folder so that there is only one copy of the example that ends up in the root?

@rileykarson
Copy link
Contributor Author

I slightly prefer to keep tf code in the examples folder too, but keeping a single copy would be nice. No strong feelings from me.

@yorinasub17
Copy link
Contributor

I forget: Does terraform work with symlinks? Could we symlink the example folder tf files to the root ones?

@rileykarson
Copy link
Contributor Author

That way the relative references to modules won't work in both locations.

@yorinasub17
Copy link
Contributor

Ah that makes sense. Bummer!

@autero1
Copy link
Contributor

autero1 commented May 7, 2019

I like the idea of keeping only a single copy of the examples. This is how it was done for the Influx -modules: https://github.com/gruntwork-io/terraform-aws-influx/tree/master/examples/influxdb-cluster-simple. Documentation and "extras" in the example folder but the tf files only in the root.

@rileykarson
Copy link
Contributor Author

Amended to follow what the influx module does.

@autero1
Copy link
Contributor

autero1 commented May 7, 2019

The tests will most likely break now that the examples folder doesn't contain the tf -files.
EDIT: Looks like it's the gke-basic-tiller, so tests are unaffected.

@rileykarson
Copy link
Contributor Author

Yeah, I didn't add a test on that folder past testing locally because tests don't run in parallel so we'd be adding another 20+ minutes onto tests that are already quite long.

Copy link
Contributor

@autero1 autero1 left a comment

Choose a reason for hiding this comment

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

LGTM!

@rileykarson rileykarson merged commit 05d0077 into master May 7, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants