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

Make it possible to fix or suppress generated examples #3336

Open
cnunciato opened this issue Oct 16, 2023 · 2 comments
Open

Make it possible to fix or suppress generated examples #3336

cnunciato opened this issue Oct 16, 2023 · 2 comments
Labels
area/docs Hand-written documentation. For api docs, see area/api-docs. kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s)

Comments

@cnunciato
Copy link
Contributor

cnunciato commented Oct 16, 2023

Examples like these that appear in the API docs of bridged Terraform providers are generated with our conversion tools. These tools ingest the Markdown documentation files bundled with Terraform providers and parse them for handwritten HCL examples, converting each example into multiple Pulumi programs.

This often works, but in many cases, such as when HCL sources are partial or incorrect, the generated programs end up invalid for various reasons -- missing or badly named input properties, references to undefined variables, etc. -- prompting users to file issues or even submit PRs to fix them. But because these examples can't be "fixed" directly, as they're generated on every release as part of the provider build, the maintainers of this repository (the docs team) aren't really able to do anything about them. We don't want to close them, as they're legitimate issues that we want to make sure get fixed, but we also can't fix them ourselves, as they're produced by a process outside of our control.

This issue serves two purposes:

  1. To track an actual solution to this problem that gives the docs team a way to either fix or suppress broken examples such that they aren't overwritten on every provider release. This will allow us to correct the issues that our users need us to be able to correct (or even correct themselves, if they like).

  2. To allow us to tag/label or otherwise associate the issues that fall into this category so we can report on them. This will allow the provider teams to address any underlying issues with the conversion process.

@desteves
Copy link
Contributor

related #3059
related pulumi/pulumi-gcp#2618

@toriancrane toriancrane added area/registry area/docs Hand-written documentation. For api docs, see area/api-docs. kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) and removed needs-triage Needs attention from the triage team labels Oct 25, 2023
@toriancrane toriancrane moved this from 🤔 Triage to 🧳 Backlog in Docs 📚 Oct 25, 2023
@cnunciato
Copy link
Contributor Author

pulumi/pulumi#14869

@sean1588 sean1588 added this to the 0.101 milestone Feb 21, 2024
@sean1588 sean1588 modified the milestones: 0.101, 0.102 Mar 8, 2024
@sean1588 sean1588 modified the milestones: 0.102, 0.103 Apr 8, 2024
@sean1588 sean1588 removed their assignment Apr 8, 2024
@mikhailshilkov mikhailshilkov removed this from the 0.103 milestone Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Hand-written documentation. For api docs, see area/api-docs. kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s)
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

6 participants