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

Create terraform.io/plugin Section for terraform-plugin-go Documentation #129

Open
bflad opened this issue Dec 22, 2021 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@bflad
Copy link
Member

bflad commented Dec 22, 2021

terraform-plugin-go version

v0.5.0

Use cases

While the Go documentation for this project available at https://pkg.go.dev/github.com/hashicorp/terraform-plugin-go is fairly comprehensive for describing low level details, it can be challenging to tease out higher level concepts or functionality which having website documentation similar to SDKv2 and the framework would be very helpful for provider developers.

For example:

  • Terraform Plugin Protocol at a glance and how to inspect it (since this is important when working at this layer)
  • Creating gRPC servers
  • Environment variables used to control logging, contextual log key descriptions
  • Using tftypes.UnknownValue to indicate computed values will change, but also that it cannot be used during apply
  • (Needs more consideration, maybe its own section) Using terraform-plugin-mux to merge providers
  • When to use terraform-plugin-go, versus the other frameworks
  • Acceptance testing (beyond just the README)

Proposal

Create new section on the Terraform documentation website, e.g. https://www.terraform.io/plugin/go

  • Overview
  • Protocol
  • Provider Servers
  • Types and Values
  • Logging
  • Testing
    • Unit
    • Acceptance

Update https://www.terraform.io/plugin/which-sdk with appropriate details about when to use terraform-plugin-go.

References

@bflad bflad added the documentation Improvements or additions to documentation label Dec 22, 2021
@bflad bflad self-assigned this Apr 20, 2022
@bflad bflad removed their assignment Jul 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant