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

Consider making docs discovery schema aware #1972

Open
guineveresaenger opened this issue May 14, 2024 · 0 comments
Open

Consider making docs discovery schema aware #1972

guineveresaenger opened this issue May 14, 2024 · 0 comments
Labels
area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen kind/enhancement Improvements or new features

Comments

@guineveresaenger
Copy link
Contributor

Our current strategy for discovering docs involves parsing upstream docs, detecting potential schema properties via patterns and headers/subheaders, gathering them in entityDocs and then at the end matching up the resource schema path to the docs path.

If we were to thread the resource schema through the docs generation process, we can be a lot more reliable in our docs discovery.

Issues such as pulumi/pulumi-libvirt#335 can be avoided because we could verify whether a found backticked item is a schema property vs a value.

#1960 - similarly, we'd not translate these into pulumiNames, because we'd know they're values.

Also, we could implement language-specific translation of properties inside field descriptions.

There's likely more. This is a fairly large refactor and should be planned carefully.

@guineveresaenger guineveresaenger added kind/enhancement Improvements or new features area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen labels May 14, 2024
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