I find it really difficult to get to the reference...
# docs
I find it really difficult to get to the reference documentation from the homepage. I have provided feedback to any of the surveys about improving the documentation, and I believe it's gotten worse to navigate (but the search is definitely better). 1. https://www.pulumi.com/ -> 2. https://www.pulumi.com/docs/ -> a. Click AWS get to https://www.pulumi.com/docs/get-started/aws/ -> which dumps me in a tutorial I don't need. As a user coming back to reference documentation, almost everything in the sidebar above the fold is useless to me b. forget this dead-end, look for "Reference" 3. Scroll all the way to the bottom of the side bar (which is basically the middle of the webpage), click "API Reference" -> https://www.pulumi.com/docs/reference/pkg/ 4. Click AWS get to https://www.pulumi.com/registry/packages/aws/ -> click a tab in the middle of the page "API docs" 5. Arrive at what I was hoping for https://www.pulumi.com/registry/packages/aws/api-docs/ Finding the Pulumi SDK seems even more difficult than AWS. It's in the bottom of the page here without any logos to catch your attention https://www.pulumi.com/docs/reference/pkg/#package-documentation The easiest way to enter the Pulumi reference documentation seems to be through https://www.pulumi.com/docs/reference/ -- but then the presentation of these docs is different than the other reference documentations. There is a jump-page to the SDK of choice, rather than the unified language views of the other reference documentation.
this is all really good feedback. thank you for taking the time to write it all down!! we do have a project going around improving the docs navigation and we will use your feedback within that.
👍 1
I agree with all this; mostly I use bookmarks now. If the Docs menu at the top of the page had menu items like Cloud Engineering and Learn does, I'd use them. I'd suggest (based on how often I use them): • Getting started -> pulumi.com/docs • Digging deeper -> pulumi.com/docs/intro/concepts • Pulumi APIs -> pulumi.com/docs/reference/pkg/#package-documentation (or better, a link to a page that includes just this section) • Provider APIs -> pulumi.com/registry/ (not pulumi.com/docs/reference/pkg/ as I'll always click through to the registry) • CLI -> pulumi.com/docs/reference/cli/
hi folks, lil update. we have made the cards on the docs reference page go directly to the API reference page in registry which should address 5. from @millions-furniture-75402's list. we have some larger improvements that we will hopefully be able to address after the holidays. i also want to note, that all the API ref content has been moved out of docs and into registry so adjusting to start from registry may help here. you can find the link to registry in the very top-right area of our website. thank you again for the feedback!!
🎉 1