docs icon indicating copy to clipboard operation
docs copied to clipboard

Explain differences between "regular" and component resources

Open scottslowe opened this issue 1 year ago • 0 comments

Problem description

In communicating with a user on social media, the user expressed some frustration in understanding the difference between "regular" resources (such as aws.ec2.vpc or aws.eks.Cluster) and corresponding component resources provided by Pulumi via AWSX (such as awsx.ec2.Vpc or eks.Cluster). Although these resources share a common name, they are actually quite different, don't take the same arguments, and don't produce the same results. As a result, the user was confused when trying to use arguments for aws.eks.Cluster with eks.Cluster (for example).

This seems to indicate to me that we need to explain the differences between these resources, and help users understand when to use each (including a list of the advantages and disadvantages of each approach).

Affected product version(s)

All versions (not version specific)

Suggestions for a fix

The /docs/clouds/aws/guides pages (which, AFAICT, are all Crosswalk-specific) don't provide any indication (other than the "Crosswalk for AWS" logo) that this is somehow different/distinct than just using the regular AWS resources. Providing some sort of note on each of these pages that these are specific to Crosswalk might help readers. (The breadcrumbs for the page simply say Docs > Clouds > AWS > Guides > VPC, how is a user to know that this is Crosswalk and not a "regular" VPC?)

scottslowe avatar Feb 08 '24 16:02 scottslowe