Hello! How do I generate documentation for my provider?

brave-cartoon-40872

06/07/2024, 3:49 PM

Hello! How do I generate documentation for my provider?

ancient-policeman-24615

06/08/2024, 12:47 AM

The only supported documentation target for the provider itself is the Pulumi registry. https://github.com/pulumi/registry has documentation on how to publish there.

limited-rainbow-51650

06/10/2024, 10:32 AM

@brave-cartoon-40872 here are some pointers: • https://www.pulumi.com/docs/using-pulumi/pulumi-packages/how-to-author/ (especially section

Publish the documentation

) • the following items will be checked before being accepted in the Registry, mainly to have consistency amongst all the listed packages: https://github.com/pulumi/registry/blob/master/.github/pull_request_template.md

brash-gigabyte-81569

06/14/2024, 5:19 PM

I hit this issue where it is a private provider and didn’t want to create docs for the registry. So what I did was created a new set of codegen templates within a fork of the pulumi repo, then built a new version of the resourcegen using my fork, and then used that to create markdown docs for use within backstage techdocs

brash-gigabyte-81569

06/14/2024, 5:24 PM

Would be cool if the resourcegen tool out of the box could build mkdocs 😉

7 Views

Open in Slack

Previous Next

Pulumi Community

No matter how you like to participate in developer communities, Pulumi wants to meet you there. If you want to meet other Pulumi users to share use-cases and best practices, contribute code or documentation, see us at an event, or just tell a story about something cool you did with Pulumi, you are part of our community.