We know that resource documentation is one of the most important areas of the Pulumi docs site for most Pulumi users, and we've heard the feedback that there is room to improve on these resource docs!
Yesterday, we took a major step on rolling out a brand new approach to resource docs for Pulumi. š
These new docs are resource-oriented instead of API-oriented, and are presented as a single page per resource for easier reading, discovery, and navigation. They also support switching on different Pulumi languages inline. API docs for each language are still available, and are deep-linked into from these resource docs. But in general we expect to lead with these resource-oriented docs throughout our content as canonical, language-agnostic reference for each Pulumi resource.
We've rolled out these new docs so far for AWS, Azure and GCP, with the rest of the providers on their way soon. We're also continuing to work on many more improvements on top of these new docs, so expect to continue to see improvements over the coming days and weeks. (Before you ask - Kubernetes docs are coming next!)
We'd love your feedback on the new docs either in
#docs, in GitHub, or via the š/š buttons on the site.
Here are a few pointers:
⢠An example resource:
https://www.pulumi.com/docs/reference/pkg/aws/sqs/queue/
⢠AWS package:
https://www.pulumi.com/docs/reference/pkg/aws/
⢠Azure package:
https://www.pulumi.com/docs/reference/pkg/azure/
⢠GCP package:
https://www.pulumi.com/docs/reference/pkg/gcp/
⢠Root API reference with links to all of these:
https://www.pulumi.com/docs/reference/pkg/