-
Notifications
You must be signed in to change notification settings - Fork 120
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
"Import" section unexpectedly at top of page, and often presents incorrect information #5973
Comments
Also on https://www.pulumi.com/docs/reference/pkg/aws/ec2/tag/. This feels pretty important to fix. |
Another wonky Docker page at https://www.pulumi.com/docs/reference/pkg/docker/container/, though this one looks like there's some Markdown getting spliced somehow. |
Another case like this is https://www.pulumi.com/registry/packages/vsphere/api-docs/hostportgroup/#importing, which has this section at the top of the page, but also somehow shows a multi-lang example section with no content instead of an import statement. |
There are also cases where the import section goes missing entirely - like https://www.pulumi.com/registry/packages/vsphere/api-docs/computecluster/. |
Seeing the same thing for Checking out the description in the schema:
I noticed a couple of possibly interesting conditions:
|
Given this comment:
Does this ticket need to be transferred to a different repo? Is a separate ticket needed to investigate in docsgen or tfbridge? cc @mikhailshilkov @justinvp Most of the occurrences here are still an issue. |
@mnlumi I think this is the right place for now. If it turns out the issue is something outside the scope of docs rendering, we'll transfer to another repo. |
I have a feeling this issue likely resides in the bridge since the content that is rendered on these pages is embedded directly in the description property of that resource in the provider's schema file (and I do see the description beginning with the "Import" section first in these cases). Should this get transferred to the terraform bridge repo perhaps? |
Related: pulumi/pulumi-docker#1278 |
The "Import" section is intended to be at the bottom of resource docs pages, and for most resources it is. However, on https://www.pulumi.com/docs/reference/pkg/docker/service/, the "Import" section is at the top of the page - which looks very out of place. This is true for 2 of the 10 resources in this package.
The text was updated successfully, but these errors were encountered: