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

compose: improving suggestion messages around azd infra synth #4582

Open
JeffreyCA opened this issue Nov 22, 2024 · 2 comments
Open

compose: improving suggestion messages around azd infra synth #4582

JeffreyCA opened this issue Nov 22, 2024 · 2 comments
Labels
compose composability needs-triage For new issues
Milestone

Comments

@JeffreyCA
Copy link
Contributor

JeffreyCA commented Nov 22, 2024

This is kind of a sub-issue to #4578, and may be irrelevant depending on how we'll support "hybrid IaC", so feel free to close this if that's the case.

Currently, if you add a new resource using azd add to an azd project that already has an infra folder, the following message is shown to the user after accepting the changes to azure.yaml:

Run 'azd infra synth' to re-synthesize the infrastructure, then run 'azd provision' to provision these changes anytime later.

From my own experience encountering this message for the first time, I didn't really know what terms like "re-synthesize the infrastructure" or "overwrite with the synthesized versions" meant at first (I later learned these were common terminology used in IaC, Terraform, AWS CDK):

Image

I found the description used in the help text for azd infra synth to be more helpful:

Available Commands
  synth : Write IaC for your project to disk, allowing you to manage it by hand. (Beta)

Do you think instead of "re-synthesize the infrastructure" we could have similar wording to above? I think new users, especially those unfamiliar with IaC/Terraform lingo could benefit.

@JeffreyCA JeffreyCA added compose composability needs-triage For new issues labels Nov 22, 2024
@weikanglim
Copy link
Contributor

Just curious, @JeffreyCA, in your mind, does "generate" sound better here?

@JeffreyCA
Copy link
Contributor Author

Just curious, @JeffreyCA, in your mind, does "generate" sound better here?

Yes, "generate" sounds better to me, and maybe also that these are infrastructure files (on disk)

@rajeshkamal5050 rajeshkamal5050 added this to the Selenium milestone Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compose composability needs-triage For new issues
Projects
None yet
Development

No branches or pull requests

3 participants