Add quickstart notes on how to install AWS plugin #673
Conversation
Customers sometimes run into issues with the AWS quickstart when their AWS plugin did not automatically install as part of their package installation. In the event that NPM did not correctly install their plugin, this commit adds notes to the relevant areas that instruct users on how to install the plugin manually.
![pulumi[bot]](https://avatars.githubusercontent.com/in/15540?s=60&v=4){kind=small}
There was a problem hiding this comment.
🍹 The Update (preview) for stack pulumi/pulumi.io-staging was successful.
Resources:
49 changes
+ 1 to create
~ 48 to update
495 unchanged
Visit the Pulumi Cloud Console for more information.
|
Hmm - I don't think this is how we should "fix" pulumi/pulumi#2097. I'd prefer to make sure this doesn't happen, and in the very rare case that it does due to things entirely out of our control, find a way to provide richer information in the context of the failure. I don't want us to have to warn users about every way things might go wrong inline in every tutorial we write! I assumed we would fix pulumi/pulumi#2097 by addressing whatever caused the user to fail to get the plugin installed (presumably something related to the Python acquisition experience?). |
We already do this now, to be clear: pulumi/pulumi#2040. If we think this is sufficient, then sure, we can close this PR 😄 . However, there is evidence that users do occasionally run into this issue. I'm fine either way. |
Nice! I didn't realize we had already done that. Personally I think that's a sufficient alternative to this docs change - gives an actionable fix immediately at the point of the error - which is frankly even better than in the docs. I'm still unclear on why we expect this to be common for users to hit - and whether that is because we are doing something wrong somewhere else or just because we believe the Internet is unreliable. |
|
What about a middle ground? Add a section about plugins to our reference, but don't add the note to every tutorial. That way we will at least get helpful content indexed so people find it in search. |
|
Per notes in pulumi/pulumi#2097 we can close this out. |
Customers sometimes run into issues with the AWS quickstart when their
AWS plugin did not automatically install as part of their package
installation. In the event that NPM did not correctly install their
plugin, this commit adds notes to the relevant areas that instruct users
on how to install the plugin manually.
Fixes pulumi/pulumi#2097