hashicorp / hashicorp/terraform-plugin-framework

Docs: Diagram when various methods get called and under what conditions

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

Description

👋 I'm currently working through my very first terraform provider, and one conceptual thing that I'm having a huge difficult with is knowing/understanding when various methods — ie. `resource.Create|Read|Update|Delete` — get called, and under what conditions — ie. _fresh_ `terraform apply`, `terraform plan` with state populated, etc... there are a good amount of permutations 😅.

The diagrams at https://developer.hashicorp.com/terraform/plugin/framework/internals/rpcs#read-rpcs ...

- https://github.com/hashicorp/terraform-plugin-framework/blob/d3400c5e52f7e5577bf4122dbceaa3084f91da55/website/docs/plugin/framework/internals/rpcs.mdx#L2

... are the closest thing that satisfies this learning need, but I think I still have to read between the lines. A "lifecycle" overview page of sorts would be a very nice addition to the docs. (Also acknowledging that the specific "lifecycle" terminology has some SEO clash implications with the core `lifecycle` block.

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.