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

Move Kubernetes overlays into the provider schema #6740

Closed
lblackstone opened this issue Nov 2, 2021 · 2 comments · Fixed by #6777
Closed

Move Kubernetes overlays into the provider schema #6740

lblackstone opened this issue Nov 2, 2021 · 2 comments · Fixed by #6777
Assignees
Labels
area/docs Improvements or additions to documentation kind/engineering Work that is not visible to an external user resolution/fixed This issue was fixed
Milestone

Comments

@lblackstone
Copy link
Member

Problem description

We currently generate API reference docs for several Kubernetes resources using an overlay folder.

It would be more maintainable to generate overlays in the provider schemas under the language section so that the documentation is automatically updated when things change in the provider.

This will involve two parts:

  1. Update the overlay handling code to check the schema instead.
  2. Update the Kubernetes provider (and possibly the Docker provider) to generate the overlay as part of the schema.
@viveklak
Copy link
Contributor

viveklak commented Nov 2, 2021

It would be more maintainable to generate overlays in the provider schemas under the language section so that the documentation is automatically updated when things change in the provider.

As stated elsewhere, the languages section is becoming increasingly messy as it is often where obscure settings land. Does this kind of thing belong in the framework performing the codegen (or document generation) instead? Perhaps if we had a simple visitor pattern with callbacks to perform some pre/post processing, we could achieve the same thing? Just wondering if it makes sense to burden the overall schema machinery with what seem to be very localized issues.

@pulumi-bot
Copy link
Collaborator

Cannot close issue without required labels: kind/

@lblackstone lblackstone added the kind/engineering Work that is not visible to an external user label Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/engineering Work that is not visible to an external user resolution/fixed This issue was fixed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants