pulumi-aws-native icon indicating copy to clipboard operation
pulumi-aws-native copied to clipboard

APIs are missing some documentation

Open joeduffy opened this issue 1 year ago • 2 comments

I'm unsure if this is intentional, but a number of the resources have missing property documentation. For example, this type is missing it entirely (https://www.pulumi.com/registry/packages/awsx/api-docs/ecs/fargateservice/#taskdefinitionlogconfiguration) but if you scroll around the page, there are partly documented types too.

joeduffy avatar Feb 10 '24 18:02 joeduffy

These types are copied in from the aws-native resources (eg. here) which also lack descriptions for a lot of properties.

There are a couple ways we could go about improving this:

  1. Add our own property descriptions locally in awsx
  2. Add our own property descriptions to aws-native
  3. Just link out to the AWS docs, like the TF resource does.

Probably, the most payoff for our effort would be to add the docs to aws-native, but to follow the approach of the TF provider and just provider a link to aws docs for any parameters missing a doc string.

I'm going to move this ticket to aws-native and treat as an enhancement, since adding manual docs there is net new for us and we should spend the effort to do it in such a way that we can augment other resources with missing docs easily as well.

mjeffryes avatar Feb 12 '24 21:02 mjeffryes

@mjeffryes It looks like the aws-native provider descriptions are fixed in this particular place, see https://www.pulumi.com/registry/packages/aws-native/api-docs/ecs/taskdefinition/#taskdefinitionlogconfiguration

Is it a matter of releasing a new version of awsx now to fix the issue reported by Joe?

Also, let's either find a new example of missing descriptions and update this issue, or close it if the problem is truly fixed now.

mikhailshilkov avatar Mar 27 '24 08:03 mikhailshilkov