docs icon indicating copy to clipboard operation
docs copied to clipboard

Remaining Coverage Gaps in Resource Docs

Open lukehoban opened this issue 5 years ago • 0 comments

The new resource docs provide a high quality cross-language experience for the majority of Pulumi APIs. However, they have some coverage gaps that mean they do not present the full API, which can be misleading, leads to inconsistency, and increases the dependence on language-specific API docs.

Known coverage gaps:

  • [ ] Top-level config module in ~all current providers (https://github.com/pulumi/docs/issues/3641)
  • [ ] Enums - Node.js specific (but should probably be addressed by making these non-Node.js specific) (aws.InstanceTypes and many more) https://github.com/pulumi/pulumi/issues/4003
  • [ ] JSON types - Node.js specific (but should probably be addressed by making these non-Node.js specific) (aws.iam.PolicyDocument) https://github.com/pulumi/pulumi-terraform-bridge/issues/132
  • [ ] Resources that take callback, and methods that accept callbacks - Node.js specific (aws.lambda.CallbackFunction, aws.cloudwatch.onSchedule, etc.) https://github.com/pulumi/pulumi/issues/4785
  • [ ] Component Packages - Node.js specific (awsx, eks, cloud, kubernetesx) https://github.com/pulumi/pulumi/issues/4784
  • [ ] Component Resource in existing packages - all languages (docker.Image) https://github.com/pulumi/pulumi-docker/issues/111
  • [ ] Hand-rolled native provider - all languages (terraform) https://github.com/pulumi/docs/issues/3529

We might be able to address some of these with docs "overlays" as in https://github.com/pulumi/docs/blob/master/tools/resourcedocsgen/overlays/kubernetes/overlays.json. But where possible, we should aim to generalize our schema to support expressing these concepts so they can be authored and maintained as part of the package itself.

lukehoban avatar Jun 09 '20 15:06 lukehoban