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

Documentation about provisioners forgets to mention allowed values of the "when" attribute #32762

Open
khaliddermoumi opened this issue Mar 1, 2023 · 2 comments
Labels
documentation new new issue not yet triaged

Comments

@khaliddermoumi
Copy link

Terraform Version

tf version is not relevant here, as this is about the "latest" docs, labelled "v1.3.x (latest)".

Affected Pages

https://github.com/hashicorp/terraform/blob/main/website/docs/language/resources/provisioners/syntax.mdx

What is the docs issue?

It does not say which values are allowed for the "when" meta-argument. There is a section for meta-argument "on_failure", explaining which values are allowed. But it never says which values the "when" argument can take.

Proposal

  • explain, which values are allowed for the "when" argument ("destroy", ...)

References

No response

@khaliddermoumi khaliddermoumi added documentation new new issue not yet triaged labels Mar 1, 2023
@khaliddermoumi
Copy link
Author

A general wish: please be more formal about describing APIs (like the provisioner API), the docs sometimes tend to be very wordy and prosaic, and lacking the spec one is actually searching.

@crw
Copy link
Collaborator

crw commented Mar 1, 2023

Thanks for this docs report, I've added it to the documentation team's triage queue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation new new issue not yet triaged
Projects
None yet
Development

No branches or pull requests

2 participants