search

pulumi / pulumi-terraform-bridge

A library allowing Terraform providers to be bridged into Pulumi.
Apache License 2.0
194 stars 43 forks source link

Asset links leave broken link titles in docs #2097

Open guineveresaenger opened 3 months ago

guineveresaenger commented 3 months ago

What happened?

A community member attempted to fix a nonsensical string in a resource doc: https://www.pulumi.com/registry/packages/databricks/api-docs/mwsworkspaces/#creating-a-databricks-on-aws-workspace

Upstream has a diagram here. The link itself was stripped, but the link title remained and was rendered.

I don't currently know of any similar instances of this bug, but I imagine an investigation would reveal more.

Example

Our docs: https://www.pulumi.com/registry/packages/databricks/api-docs/mwsworkspaces/#creating-a-databricks-on-aws-workspace

Upstream: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/mws_workspaces#creating-a-databricks-on-aws-workspace

Output of pulumi about

n/a

Additional context

https://github.com/pulumi/pulumi-databricks/pull/507 was where an attempted fix basically discovered this bug.

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).

iwahbe commented 3 months ago

If the link is to a GH repo, we should try to keep it. If this becomes problematic we can always remove image links.