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

Please add examples of each of the operator types to the feature_flag_environment resource type doc #207

Closed
EmilHorne opened this issue Apr 29, 2024 · 3 comments

Comments

@lucywyman
Copy link
Contributor

Hi @EmilHorne ! You can see we have a lot of operator types, my feeling is this would make our documentation very verbose with relatively little benefit. Is there a particular operator you were confused by?

@EmilHorne
Copy link
Author

There's no direct link from the Terraform documentation (or from the regular API documentation) to the operator list that I referenced.

The example in the Terraform documentation is a template for copy/pasting snippets into real Terraform files. Having to look up operators and then guess at the syntax for the rest of the structure is a lot of extra effort, trial and error.

Providing specific examples will make it easier for teams to scale their use of the Terraform provider. Not having them in the documentation at all leaves a lot of uncertainty for each end user to overcome.

If verbosity is a concern, specific examples can be split into multiple sections. I view this as unnecessary complication. A long example isn't a problem as long as the structure is easy to follow. That is the purpose of an example.

@ldhenry
Copy link
Collaborator

ldhenry commented May 17, 2024

Hey @EmilHorne, thanks for the feedback. We've updated the launchdarkly_feature_flag_environment and launchdarkly_segment examples based on your feedback.

@ldhenry ldhenry closed this as completed May 17, 2024
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

3 participants