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.

Sign up for GitHub

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

Jump to bottom

Field-level documentation not showing correctly. #5555

Open
mawallace opened this issue Sep 28, 2024 · 1 comment
Open

Field-level documentation not showing correctly. #5555

mawallace opened this issue Sep 28, 2024 · 1 comment
Labels
impact/usability Something that impacts users' ability to use the product easily and intuitively kind/bug Some behavior is incorrect or out of spec kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) resolution/duplicate This issue is a duplicate of another issue

Comments

@mawallace
Copy link

What happened?

The documentation for some fields appears as bullet points under other fields. I have noticed this happening consistently across the documentation.

See included the example.

Example

Image

Notice that accountRecoverySettings and adminCreateUserConfigs are shown as bullet points under the arn documentation.

Output of pulumi about

I don't think this would be relevant here, but can provide upon request if it is.

Additional context

Browser: Safari, Version 17.2.1.

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).
@mawallace mawallace added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team labels Sep 28, 2024
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Sep 28, 2024
@thoward thoward mentioned this issue Oct 17, 2024
Open
@thoward
Copy link
Contributor

thoward commented Oct 17, 2024

Thanks for reporting this! We really appreciate it.

This seems related to a known issue with our markdown rendering pipeline, tracked here: pulumi/pulumi-terraform-bridge#1693

@thoward thoward added area/registry impact/usability Something that impacts users' ability to use the product easily and intuitively kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) kind/documentation Improvements or additions to documentation and removed needs-triage Needs attention from the triage team labels Oct 17, 2024
@thoward thoward moved this from 🤔 Triage to 🧳 Backlog in Docs 📚 Oct 17, 2024
@thoward thoward added the resolution/duplicate This issue is a duplicate of another issue label Oct 17, 2024
@iwahbe iwahbe removed area/registry kind/documentation Improvements or additions to documentation labels Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
impact/usability Something that impacts users' ability to use the product easily and intuitively kind/bug Some behavior is incorrect or out of spec kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) resolution/duplicate This issue is a duplicate of another issue
Projects
Docs 📚
Status: 🧳 Backlog
Milestone
No milestone
Development

No branches or pull requests
3 participants
@thoward @mawallace @iwahbe