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

Clarify Usage of module.* in Advanced Example #7

Open
thomascjohnson opened this issue Mar 27, 2024 · 2 comments
Open

Clarify Usage of module.* in Advanced Example #7

thomascjohnson opened this issue Mar 27, 2024 · 2 comments

Comments

@thomascjohnson
Copy link

Thank you for these helpful examples! The advanced example uses the module values app and env in the service template but it isn't clear how these values are populated. A comment in the readme or the template would help to clarify that the values come from the file structure per the AppEnvCluster.

@holzensp
Copy link
Contributor

Whenever I'm unsure where a definition comes from, I use Go To Definition in my IDE to find it. It's also not documented where services comes from. Do you think the module style reference is so much harder to find / counter-intuitive that it warrants documenting, whereas a direct reference (to services) is not?

@thomascjohnson
Copy link
Author

I was thinking that a comment clarifying this could save someone else the 10 minutes I lost on this in the future. I don't even get anything like "Go To Definition" when I am looking at this in VS Code, so that wouldn't have helped me either:
image

However, I did just find this in the readme:

This template mandates a three-level application/environment/cluster directory structure whose leaf directories contain the manifest files for a particular combination of application, environment, and cluster.

I missed that last night.

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

No branches or pull requests

2 participants