Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display a "guided tour" upon install or upgrade of the AWS Toolkit #508

Closed
ghost opened this issue Apr 26, 2019 · 3 comments
Closed

Display a "guided tour" upon install or upgrade of the AWS Toolkit #508

ghost opened this issue Apr 26, 2019 · 3 comments
Labels
documentation feature-request New feature or enhancement. May require GitHub community feedback. needs-discussion

Comments

@ghost
Copy link

ghost commented Apr 26, 2019

Is your feature request related to a problem? Please describe.

After installing the AWS Toolkit, it's unclear to know what I should (or even can) do next. I guess I could go see the related documentation over on the AWS website, but I might not know how to get there or even how to navigate the docs once I get there. So, there's an opportunity to provide me with some kind of "Guided Tour" experience right in the middle of the Visual Studio Code IDE to make sure that I've got the AWS Toolkit connected to my AWS account and otherwise configured correctly, as well as teach me how to use the AWS Toolkit to its fullest potential.

Also, whenever I upgrade the AWS Toolkit on my dev box and there are new features introduced, the Guided Tour should pop up and show me how to use them.

Describe the solution you'd like

After installing the AWS Toolkit for the first time or after upgrading it, a single dialog box should display. This dialog box could include multiple pages that I can flip through, showing things like:

  1. What's new in the current release.
  2. Post-install steps, such as connecting the AWS Toolkit to an AWS account and optionally opting in to giving AWS usage and crash information to help improve the product for everyone moving forward.
  3. Embedded how-to videos that briefly walk through key usage scenarios--but not for AWS serverless development quite yet.
  4. Introducing me to AWS serverless, AWS Lambda, and AWS CloudFormation, and explaining the benefits of and interrelationships between them.
  5. For AWS serverless app development and running/debugging AWS Lambda functions locally, how to install the AWS CLI and Docker, start Docker, and install the AWS SAM CLI.
  6. Embedded how-to videos that briefly walk through key usage scenarios for AWS serverless development.
  7. Suggested next steps for learning and doing, which link out to related documentation on the AWS website.

I could quit this Guided Tour at any time. I could also check a box to hide the Guided Tour until the next time I upgrade, in which case it would be shown again, so I could at the very least see what's new in that release. I could also show this dialog again at any time on my own, if desired.

Describe alternatives you've considered

The current experience of showing some information on the page with the plugin Install button is a good start, but it's not as visible and inviting as a Guided Tour could be.

@awschristou
Copy link
Contributor

For AWS serverless app development and running/debugging AWS Lambda functions locally, how to install the AWS CLI and Docker, start Docker, and install the AWS SAM CLI.

Each possible dependency that is listed could potentially indicate if it has been detected or not, and explain what feature(s) would be enabled if that dependency was installed, in addition to providing guidance on how to install it.

Additional considerations:

  • This might be a good place to enable/disable anonymous usage data settings
  • providing access to the changelog details

@awschristou awschristou added feature-request New feature or enhancement. May require GitHub community feedback. needs-design needs-discussion labels Apr 26, 2019
@justinmk3
Copy link
Contributor

justinmk3 commented May 7, 2021

VSCode extensions can use the "Getting Started" / walkthroughs contribution points:

@justinmk3
Copy link
Contributor

closed by #1897

leigaol pushed a commit to leigaol/aws-toolkit-vscode that referenced this issue Jun 28, 2022
[consolas] Bug fix: Toolkit log in on C9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation feature-request New feature or enhancement. May require GitHub community feedback. needs-discussion
Projects
None yet
Development

No branches or pull requests

2 participants