hashicorp / hashicorp/terraform-plugin-framework

Consider Documentation and Tutorials for Common Use Cases

Open
#258 8 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
384
Forks
107
Avg merge
3m
Merged PRs (30d)
1

Description

### Use-cases

Provider developers across the ecosystem will have some common use cases they will want to research documentation on how to accomplish their goals. For example, how to implement provider configuration validation for attributes which should also source standard vendor SDK environment variables.

Currently provider developers are left to their own devices beyond piecing together the Go documentation and terraform.io documentation that typically describes in detail a single piece of the framework rather than implementations that require crossing those boundaries. This means that it can potentially take much longer to be successful as the next options may be researching other Terraform Provider implementations, asking on [HashiCorp Discuss](https://discuss.hashicorp.com), or reaching out on other community forums.

### Proposal

For a timeboxed period, use this issue to collect some "common" provider development use cases with a brief summary and potential solution, linking to other documentation or providing code examples as necessary. When the collection period is over, holistically evaluate which (if any or all) should potentially be surfaced in the terraform.io documentation website or learn.hashicorp.com tutorials and how best to accomplish that since they are very likely to be disparate in nature.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.