Make it possible to fix or suppress generated examples #3336
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)
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:
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).
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.
The text was updated successfully, but these errors were encountered: