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

Incorrect docs source: ./docs instead of ./website/docs #497

Closed
iwahbe opened this issue Jan 2, 2024 · 0 comments
Closed

Incorrect docs source: ./docs instead of ./website/docs #497

iwahbe opened this issue Jan 2, 2024 · 0 comments
Assignees
Labels
kind/bug Some behavior is incorrect or out of spec resolution/fixed This issue was fixed

Comments

@iwahbe
Copy link
Member

iwahbe commented Jan 2, 2024

What happened?

Upstream maintains two different sources of docs: ./website/docs and ./docs. We currently draw our docs from ./docs, while the TF registry draws docs from ./website/docs. Patch 2 (introduced in #496) removes ./docs and restores a large amount of documentation to the provider.

The bridge should draw docs from the same source as the TF registry.

Example

NA

Output of pulumi about

NA

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

@iwahbe iwahbe added the kind/bug Some behavior is incorrect or out of spec label Jan 2, 2024
iwahbe added a commit that referenced this issue Apr 18, 2024
The docs patch existed because of
#497. pulumi/pulumi-terraform-bridge#1609
was the root cause, and it is now fixed. We can remove the docs patch.

We cannot transition back to a normal go dependency, since upstream hasn't marked the
major version in their go.mod. Ironically, since we have the dependency downloaded we
don't actually have to change anything. I have added a empty patch to resolve this catch
22 scenario.
iwahbe added a commit that referenced this issue Apr 18, 2024
The docs patch existed because of
#497.
pulumi/pulumi-terraform-bridge#1609 was the
root cause, and it is now fixed. We can remove the docs patch.

We cannot transition back to a normal go dependency, since upstream
hasn't marked the major version in their go.mod. Ironically, since we
have the dependency downloaded we don't actually have to change
anything. I have added a empty patch to resolve this catch 22 scenario.
@mjeffryes mjeffryes self-assigned this Sep 26, 2024
@mjeffryes mjeffryes added the resolution/fixed This issue was fixed label Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Some behavior is incorrect or out of spec resolution/fixed This issue was fixed
Projects
None yet
Development

No branches or pull requests

2 participants