Skip to content

Getting Started Walkthrough #4080

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

Closed
2 tasks done
S-Hakim opened this issue Jul 14, 2022 · 6 comments · Fixed by #4147
Closed
2 tasks done

Getting Started Walkthrough #4080

S-Hakim opened this issue Jul 14, 2022 · 6 comments · Fixed by #4147
Assignees
Labels
Area-Documentation Issue-Enhancement A feature request (enhancement).

Comments

@S-Hakim
Copy link
Contributor

S-Hakim commented Jul 14, 2022

Prerequisites

  • I have written a descriptive issue title.
  • I have searched all issues to ensure it has not already been reported.

#3647

Summary

Currently, The PowerShell Extension in VS Code does not have an introductory experience.

To make the getting started experience more convenient, users will be offered a Visual Studio Code Walkthrough that:

  1. gives step-by-step explanations on how to set up the PowerShell environment
  2. sets up their PowerShell environment automatically rather than manually.
  3. introduces them to settings and features of the VS Code PowerShell extension that they might not be aware of.
  4. Provides clarity regarding setting, features, and versions of the PowerShell extension

Feel free to leave feedback, suggestions, or topics you would like to see covered in upcoming Walkthroughs!

Proposed Design

PowerShell Extension Walkthrough Wire Frame (1)-1
PowerShell Extension Walkthrough Wire Frame (1)-2
PowerShell Extension Walkthrough Wire Frame (1)-3
PowerShell Extension Walkthrough Wire Frame (1)-4
PowerShell Extension Walkthrough Wire Frame (1)-5
PowerShell Extension Walkthrough Wire Frame (1)-6
PowerShell Extension Walkthrough Wire Frame (1)-7
PowerShell Extension Walkthrough Wire Frame (1)-8
PowerShell Extension Walkthrough Wire Frame (1)-9

@S-Hakim S-Hakim added the Issue-Enhancement A feature request (enhancement). label Jul 14, 2022
@ghost ghost added the Needs: Triage Maintainer attention needed! label Jul 14, 2022
@TylerLeonhardt
Copy link
Member

This is looking really nice. Couple of comments:

  • this walkthrough is contributed by the PowerShell extension so you have to already have the extension installed so the first step isn't needed
  • I ❤️ the Install PowerShell 7 step
  • I think the ISE mode step should be a toggle instead of an Enable so that the user can click it once, see what it looks like, and decide if they want it and if not click toggle again
  • Does the Set PowerShell as your default shell set it as the default in VS Code or the default for the OS? I think the language needs to be clearer here
  • Does the "Open PowerShell Terminal" toggle the setting or does it open a terminal?

I think this is a great set of steps. I'm excited to see PowerShell contribute a walkthrough!

@StevenBucher98
Copy link
Contributor

StevenBucher98 commented Jul 28, 2022

Would setting PS7 as default be blocked if they only have Windows PowerShell, or would the button lead them to install PS7?

@StevenBucher98
Copy link
Contributor

Also is the Mark Done button needed to navigate to the next option? Maybe a more progressional button would be better like Next>

@fflaten
Copy link
Contributor

fflaten commented Aug 2, 2022

I think the ISE mode step should be a toggle instead of an Enable so that the user can click it once, see what it looks like, and decide if they want it and if not click toggle again

+1 for the toggle. Or even a preview image on the right side with picture that you could switch between.

Should there be a step to introduce with images some of the basic controls like the play-buttons above the editor + common keybindings like F5/F8 (could that be read from user settings?)? This could be their first PowerShell editor experience.

@S-Hakim
Copy link
Contributor Author

S-Hakim commented Aug 3, 2022

Would setting PS7 as default be blocked if they only have Windows PowerShell, or would the button lead them to install PS7?

The button would lead to a link where they can get the most updated version of PowerShell! They would then return to the Walkthrough to complete the other steps.

@andyleejordan andyleejordan added Area-Documentation and removed Needs: Triage Maintainer attention needed! labels Aug 3, 2022
@S-Hakim
Copy link
Contributor Author

S-Hakim commented Aug 3, 2022

Also is the Mark Done button needed to navigate to the next option? Maybe a more progressional button would be better like Next>

The Mark Done button isn't necessary to navigate to the next step, but is an option to complete the checklist with one click rather than clicking each checkpoint manually. The user can go through the steps by clicking the block, so the Next> button won't be needed.

@andyleejordan andyleejordan moved this from Todo to In Progress in American Pharoah Aug 3, 2022
Repository owner moved this from In Progress to Done in American Pharoah Aug 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Documentation Issue-Enhancement A feature request (enhancement).
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants