Hello! How do I generate documentation for my prov...
# package-authoring
b
Hello! How do I generate documentation for my provider?
a
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.
l
@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
b
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
Would be cool if the resourcegen tool out of the box could build mkdocs 😉