lukehoban
commented
3 years ago Closing this out as we are now tracking this work in other places.
Closed isaac-pulumi closed 3 years ago
lukehoban
commented
3 years ago Closing this out as we are now tracking this work in other places.
pulumi-bot
commented
3 years ago Cannot close issue without required labels: kind/, resolution/
Problem description
Background
Pulumi has a lot of high-value, high-traffic pages that suffer from high bounce rates.
There are a number of issues that will need to be solved over time with some thematic changes for each documentation path (e.g. tutorials vs. get-started, vs. intro). For this sprint, the focus will be on high-traffic / high-bounce pages.
The team created a blended score of [page views] [bounce rate] [% negative ratings] to create a basis for prioritizing pages for this sprint. The general theme is that even pages with a high share of negative ratings, there were very few actionable comments.
General areas for improvement:
Better overall navigation / UX for the /docs page -- we never explain the difference between get-started, tutorials, examples, intro -- so a summary for each major area might help steer folks to the right information faster.
Some docs are way too long (programming-model) and/or group concepts that can easily be broken out into separate pages (e.g. configuration and secrets)
Sub-headings, Table of Contents (right-hand nav) is often inconsistent across similar pages (EKS Crosswalk and GKE tutorial are a good example) - or the headings themselves are unhelpful.
Most “downvotes” are not accompanied by any comments. We should consider requiring a comment because blind voting isn’t giving us a particularly helpful signal on what needs to be fixed.
Link to original planning doc
planning doc
Links to Issues for this Epic