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.

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

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

Open
MitchellGerdisch opened this issue May 9, 2024 · 3 comments
Open
Labels
area/docs kind/bug Some behavior is incorrect or out of spec

Comments

@MitchellGerdisch
Copy link

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

@MitchellGerdisch MitchellGerdisch added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team labels May 9, 2024
@guineveresaenger
Copy link
Contributor

guineveresaenger commented May 9, 2024

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.

@VenelinMartinov VenelinMartinov added area/docs and removed needs-triage Needs attention from the triage team labels May 10, 2024
@mikhailshilkov
Copy link
Member

@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
Copy link
Member

Frassle commented May 23, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs kind/bug Some behavior is incorrect or out of spec
Projects
None yet
Development

No branches or pull requests

5 participants