Allow appending doc notes to Resources and DataSources #1237
Labels
area/docsgen
Issues with docs capture or example rendering, historically part of pkg/tfgen
kind/enhancement
Improvements or new features
Hello!
Issue details
Motivated by pulumi/pulumi-digitalocean#445
Sometimes we have helpful information or notes to include with a given resource or datasource. Bridged providers maintainers have access to ResourceInfo.Docs of type tfbridge.DocInfo to customize documentation, but is very crude for this purpose. For example currently it is possible to override Markdown TF docs entirely, but it is inconvenient when adding a note since it wipes all argument documentation strings and existing useful information.
The suggestion is to extend DocInfo to permit adding Pulumi-specific annotations to the documentation.
Affected area/feature
The text was updated successfully, but these errors were encountered: