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

Add docs #8

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Add docs #8

merged 1 commit into from
Aug 7, 2024

Conversation

mjeffryes
Copy link
Member

For some reason the index and install docs were not generated automatically. These are needed in order to publish to the registry, so I generated and added them separately for now. We'll still need to look into why they aren't getting generated so they don't get stale.

Workaround for: #6

@mjeffryes mjeffryes requested review from guineveresaenger and a team August 7, 2024 22:24
Copy link

github-actions bot commented Aug 7, 2024

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

Maintainer note: consult the runbook for dealing with any breaking changes.

@mjeffryes mjeffryes merged commit ffa2f68 into main Aug 7, 2024
24 checks passed
Comment on lines +40 to +53
```pulumi
pulumi {
required_providers {
mist = {
source = "registry.pulumi.io/juniper/mist"
}
}
}

provider "mist" {
host = "api.mist.com"
apitoken = "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mjeffryes This code isn't turned on for a reason. Of special significance, we are missing pulumi/pulumi-terraform-bridge#2214.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, that makes perfect sense, but the real question is: How did these docs/* pages get here for other providers and why didn't that happen for this one?

I checked other providers bridged recently (eg. dbtcloud) and these files we generated.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no idea. I thought that they were all hand authored. Until recently, the bridge didn't generate them.

Is it possible that you generated them the same way for dbtcloud as this provider, but the bridge just did something different. We are not maintaining stability guarantees on this feature yet.

Copy link
Member Author

@mjeffryes mjeffryes Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's weird. I made the initial commit for dbtcloud as well: Initial commit · pulumi/pulumi-dbtcloud@9e22c8b but definitely didn't hand author the files in docs/ for that provider. And I also didn't run tfgen manually for it either.

The only think I can think of is that I might have used the community cookiecutter template and maybe it generates them?

@mjeffryes mjeffryes mentioned this pull request Aug 9, 2024
@mjeffryes mjeffryes self-assigned this Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants