docs icon indicating copy to clipboard operation
docs copied to clipboard

Docs tend not to describe as much as the provider(AWS classic) for dynamo

Open tusharshahrs opened this issue 3 years ago • 2 comments

Problem description

  • Some areas of the docs tend to not describe as much as the provider(AWS), so I jump to that area of documentation that might help me get more info. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html for example for this. I like cloud formation, it has nearly everything for their services, properties, valid inputs, required, etc. perhaps this is intentional and Pulumi can't cover every single detail. and in the Pulumi code, I do a Go To Definition/Type Definition to get more details on the structure of Inputs sometimes.

Using AWS Classic Provider:

import * as aws from '@pulumi/aws';

Suggestions for a fix

tusharshahrs avatar Oct 11 '22 19:10 tusharshahrs

@tusharshahrs Could we break this issue up?

For the first issue you mentioned, correct me if I am wrong, but is this in the context of aws-native? Our api docs are definitely very subpar here because of https://github.com/pulumi/pulumi-aws-native/issues/63. The cloudformation schema is often missing a lot of the detailed descriptions, e.g. https://github.com/pulumi/pulumi-aws-native/blob/master/aws-cloudformation-schema/aws-dynamodb-table.json - resulting in almost all of the type properties missing documentation https://www.pulumi.com/registry/packages/aws-native/api-docs/dynamodb/table/#tableattributedefinition. As you mentioned the user guide is a very rich source of description information but we currently only pull examples from there. OK if we use the above issue to track that?

I think opening issues in the relevant provider repos for the other two issues with concrete examples would be helpful for us to prioritize.

viveklak avatar Oct 12 '22 05:10 viveklak

Hi @viveklak, I've updated the title and split this one out to the aws classic provider for dynamo.

Thanks.

tusharshahrs avatar Oct 13 '22 12:10 tusharshahrs