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

Generate Any TF Provider schemas with full examples #2607

Closed
iwahbe opened this issue Nov 11, 2024 · 1 comment · Fixed by #2664
Closed

Generate Any TF Provider schemas with full examples #2607

iwahbe opened this issue Nov 11, 2024 · 1 comment · Fixed by #2664
Assignees
Labels
area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen kind/enhancement Improvements or new features resolution/fixed This issue was fixed
Milestone

Comments

@iwahbe
Copy link
Member

iwahbe commented Nov 11, 2024

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

Currently, schemas generated from pulumi-terraform-provider are not aware of their upstream git repo, and use only in-memory docs. When generating docs for the registry, we should run the full documentation pipeline used when generating docs for our other providers. We can do this by setting a flag on our get-schema call:

$ pulumi package get-schema terraform-provider $PROVIDER_NAME --docs=full --upstream-repo=$UPSTREAM_REPO

The provider would need to download $UPSTREAM_REPO's docs or website folder and then point docs generation at it.

Affected area/feature

@iwahbe iwahbe added area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen kind/enhancement Improvements or new features labels Nov 11, 2024
@mjeffryes mjeffryes added this to the 0.113 milestone Nov 13, 2024
@iwahbe iwahbe modified the milestones: 0.113, 0.114 Dec 3, 2024
@pulumi-bot pulumi-bot added the resolution/fixed This issue was fixed label Dec 10, 2024
@pulumi-bot
Copy link
Contributor

This issue has been addressed in PR #2664 and shipped in release v3.98.0.

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 resolution/fixed This issue was fixed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants