docs icon indicating copy to clipboard operation
docs copied to clipboard

Docs Enhancement: more explicit guidance on Component resource options

Open jdavredbeard opened this issue 8 months ago • 0 comments

Problem description

The way that resource options are handled by components should be made more explicit, perhaps in https://www.pulumi.com/docs/iac/concepts/resources/components/ . For example, components can automatically pass providers to child resources, but child resources are not automatically passed the parent resource option. Since it is possible for the component author to pass resource options from component to child resources in the component definition, the docs should contain guidance on whether this ever makes sense, or how to make it make sense.

The guidance on which resource options function for the component level could also be made more top level with an explanation of why some resource options work, and some don't.

Thread here https://pulumi.slack.com/archives/C07U860415K/p1743614649568389?thread_ts=1743092770.603079&cid=C07U860415K

Affected product version(s)

Suggestions for a fix

jdavredbeard avatar Apr 09 '25 13:04 jdavredbeard