1.9 KiB
title, date, meta_desc, meta_image, authors, tags
| title | date | meta_desc | meta_image | authors | tags | ||
|---|---|---|---|---|---|---|---|
| Resource Oriented Documentation | 2020-04-02T11:34:07-05:00 | Pulumi documentation features a resource-oriented format presented as a single page per resource for easier reading, discovery, and navigation. | docs.png |
|
|
Documentation in any product is super important, and an area where folks have shared a lot of feedback! We've heard you, and this week we took a major step in rolling out a brand new approach to resource documentation. We hope you like it as much as we do.
A New Format
In short, our docs are now resource-oriented. Each resource is presented on a single page for better viewing, discovery, and navigation. All content now supports switching between different languages, so that Pythonistas, Gophers, and .NET aficionados can now easily find code examples in their favorite language.
{{< figure src="https://www.pulumi.com/uploads/content/blog/resource-oriented-documentation-blog/newdocs.gif" caption="Pick your favorite language!" >}}
API docs for each language are still available and are deep-linked. In general, we will lead with this resource-oriented format throughout our content as a canonical, language-agnostic reference for all Pulumi resources.
We've rolled this out these for AWS, Azure, and GCP, and other providers, including Kubernetes, will appear soon.
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, SQS
- AWS package
- Azure package
- GCP package
- Root API reference