Provider API docs show resources that aren't present in the SDK #2181
Assignees
Labels
area/docs
Improvements or additions to documentation
kind/bug
Some behavior is incorrect or out of spec
language/java
mro2
Monica's list of 2st tier overlay related issues
resolution/fixed
This issue was fixed
Comments
lblackstone
added
area/docs
|
Would be super cool if they were in though! (specifically helm.Chart, yaml.ConfigFile, yaml.ConfigGroup) |
|
A note about the ability (or lack thereof) to customize which languages are shown in an chooser block. Thanks to pulumi/pulumi#4426 there's some support in the templates within the docs repository, but any actual usage was removed in pulumi/pulumi#4646. |
github-merge-queue bot
pushed a commit
to pulumi/pulumi
that referenced
this issue
Jul 9, 2024
… overlays (#16579) The existing overlays (e.g. Chart v3 in Kubernetes, or CallbackFunction in AWS) are not available in every language Pulumi supports. This often confuses users because the generated docs include all languages Pulumi supports (e.g. see pulumi/pulumi-kubernetes#2181). To solve that problem, this change adds a new optional parameter to the schema that allows configuring the languages an overlay (resource or function) supports. To support this in docsgen the existing Language Chooser (`LangChooserLanguages`) of resources is made configurable and extended to functions. Note: This doesn't support resource methods right now. They'll need extra handling because and overlay resource method might not support all of the languages its resource supports. I'll tackle this in a follow up PR. Here's a screenshot of how this will look like for the Helm v3 chart for example: <img width="1046" alt="Screenshot 2024-07-01 at 16 11 23" src="https://github.com/pulumi/pulumi/assets/2453580/b1a1365a-6dee-4099-829a-2859639a4c8c"> The PR contains the following commits. I'd recommend to look at the first three ones and then check the regenerated golden files in the last one: - **Add schema parameter to constrain supported languages for overlays** - **Update developer docs and changelog** - **Refactor LanguageChooser and always pass supported languages** - **Regenerate testdata** relates to #13231
github-merge-queue bot
pushed a commit
to pulumi/pulumi
that referenced
this issue
Jul 9, 2024
… overlays (#16579) The existing overlays (e.g. Chart v3 in Kubernetes, or CallbackFunction in AWS) are not available in every language Pulumi supports. This often confuses users because the generated docs include all languages Pulumi supports (e.g. see pulumi/pulumi-kubernetes#2181). To solve that problem, this change adds a new optional parameter to the schema that allows configuring the languages an overlay (resource or function) supports. To support this in docsgen the existing Language Chooser (`LangChooserLanguages`) of resources is made configurable and extended to functions. Note: This doesn't support resource methods right now. They'll need extra handling because and overlay resource method might not support all of the languages its resource supports. I'll tackle this in a follow up PR. Here's a screenshot of how this will look like for the Helm v3 chart for example: <img width="1046" alt="Screenshot 2024-07-01 at 16 11 23" src="https://github.com/pulumi/pulumi/assets/2453580/b1a1365a-6dee-4099-829a-2859639a4c8c"> The PR contains the following commits. I'd recommend to look at the first three ones and then check the regenerated golden files in the last one: - **Add schema parameter to constrain supported languages for overlays** - **Update developer docs and changelog** - **Refactor LanguageChooser and always pass supported languages** - **Regenerate testdata** relates to #13231
glena
pushed a commit
to pulumi/pulumi
that referenced
this issue
Jul 11, 2024
… overlays (#16579) The existing overlays (e.g. Chart v3 in Kubernetes, or CallbackFunction in AWS) are not available in every language Pulumi supports. This often confuses users because the generated docs include all languages Pulumi supports (e.g. see pulumi/pulumi-kubernetes#2181). To solve that problem, this change adds a new optional parameter to the schema that allows configuring the languages an overlay (resource or function) supports. To support this in docsgen the existing Language Chooser (`LangChooserLanguages`) of resources is made configurable and extended to functions. Note: This doesn't support resource methods right now. They'll need extra handling because and overlay resource method might not support all of the languages its resource supports. I'll tackle this in a follow up PR. Here's a screenshot of how this will look like for the Helm v3 chart for example: <img width="1046" alt="Screenshot 2024-07-01 at 16 11 23" src="https://github.com/pulumi/pulumi/assets/2453580/b1a1365a-6dee-4099-829a-2859639a4c8c"> The PR contains the following commits. I'd recommend to look at the first three ones and then check the regenerated golden files in the last one: - **Add schema parameter to constrain supported languages for overlays** - **Update developer docs and changelog** - **Refactor LanguageChooser and always pass supported languages** - **Regenerate testdata** relates to #13231
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem description
Some resources (helm.Chart, yaml.ConfigFile, yaml.ConfigGroup, kustomize.Directory) are currently implemented as overlays rather than using the typical code generation process. These resources are not yet available in Java, but the resource documentation in the registry includes Java. These resources should include an unimplemented note to avoid confusion.
Related: #2179
Related: #2071
The text was updated successfully, but these errors were encountered: