pulumi / pulumi-databricks

Apache License 2.0
15 stars 8 forks source link

[Docs] External Location examples missing Azure and GCP examples #459

Open MitchellGerdisch opened 6 months ago

MitchellGerdisch commented 6 months ago

What happened?

Go to https://www.pulumi.com/registry/packages/databricks/api-docs/externallocation/#example-usage There is an example for AWS, and a hint that there should be one for Azure but there is nothing. Looking at the analogous TF module (https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/external_location) , one sees example for AWS, Azure and GCP.

Example

https://www.pulumi.com/registry/packages/databricks/api-docs/externallocation/#example-usage

See there is a header for an Azure example, but no example is given. And there is no GCP example

Output of pulumi about

N/A

Additional context

No response

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

guineveresaenger commented 6 months ago

Hi Mitch - thank you for filing this issue.

The issue seems to be one of conversion:

warning: unable to convert HCL example for Pulumi entity '#/resources/databricks:index/externalLocation:ExternalLocation'. The example will be dropped from any generated docs or SDKs: 1 error occurred:
    * [csharp, go, java, python, typescript, yaml] :16,9-18,44: Function not yet implemented; Function format not yet implemented

When we cannot convert an example, we drop it, and we attempt to drop the entire section. My guess is that the reason the "For Azure" is still shown is that it's not a proper Markdown header.

mikhailshilkov commented 5 months ago

@Frassle @Zaid-Ajaj It looks like std implements the format function already: https://github.com/pulumi/pulumi-std/blob/master/std/format.go

Is it expected to work in the converter?

Frassle commented 5 months ago

Is it expected to work in the converter?

It's not wired in at the moment, probably an easy fix if what's in std matches the terraform function.