Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow appending doc notes to Resources and DataSources #1237

Open
t0yv0 opened this issue Jun 22, 2023 · 0 comments
Open

Allow appending doc notes to Resources and DataSources #1237

t0yv0 opened this issue Jun 22, 2023 · 0 comments
Labels
area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen kind/enhancement Improvements or new features

Comments

@t0yv0
Copy link
Member

t0yv0 commented Jun 22, 2023

Hello!

  • Vote on this issue by adding a 👍 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

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

@t0yv0 t0yv0 added needs-triage Needs attention from the triage team kind/enhancement Improvements or new features labels Jun 22, 2023
@t0yv0 t0yv0 added area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen and removed needs-triage Needs attention from the triage team labels Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen kind/enhancement Improvements or new features
Projects
None yet
Development

No branches or pull requests

1 participant