Skip to content

Commit 2adee6c

Browse files
authored
Create a walkthrough experience for PowerShell (#4147)
1 parent 0b6030c commit 2adee6c

File tree

2 files changed

+75
-3
lines changed

2 files changed

+75
-3
lines changed

Diff for: media/walkthrough.md

Whitespace-only changes.

Diff for: package.json

+75-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@
4343
"onCommand:PowerShell.EnableISEMode",
4444
"onCommand:PowerShell.DisableISEMode",
4545
"onCommand:PowerShell.ToggleISEMode",
46-
"onView:PowerShellCommands"
46+
"onView:PowerShellCommands",
47+
"onWalkthrough:PowerShell"
4748
],
4849
"dependencies": {
4950
"@vscode/extension-telemetry": "^0.6.2",
@@ -870,12 +871,12 @@
870871
"powershell.buttons.showRunButtons": {
871872
"type": "boolean",
872873
"default": true,
873-
"description": "Show the Run and Run Selection buttons in the editor titlebar."
874+
"description": "Show the Run and Run Selection buttons in the editor title-bar."
874875
},
875876
"powershell.buttons.showPanelMovementButtons": {
876877
"type": "boolean",
877878
"default": false,
878-
"description": "Show buttons in the editor titlebar for moving the panel around."
879+
"description": "Show buttons in the editor title-bar for moving the panel around."
879880
}
880881
}
881882
},
@@ -897,6 +898,77 @@
897898
"uiTheme": "vs",
898899
"path": "./themes/theme-psise/theme.json"
899900
}
901+
],
902+
"walkthroughs": [
903+
{
904+
"id": "PowerShell",
905+
"title": "Get Started with PowerShell",
906+
"description": "Set up your environment and see what the PowerShell Extension in Visual Studio Code can help you achieve!",
907+
"steps": [
908+
{
909+
"id": "version",
910+
"title": "Choose a version of PowerShell",
911+
"media": {
912+
"markdown": "media/walkthrough.md"
913+
},
914+
"description": "There are multiple versions of PowerShell that you can use with the extension! Choose the version that best fits your needs here.\nFor the newest version of PowerShell, install PowerShell 7 or run ``iex \"& { $(irm https://aka.ms/install-powershell.ps1) } -UseMSI\"``\n[Install PowerShell 7](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2)\n⭐️ Latest version ― if you want the latest and greatest capabilities.\n💻 Can be used to manage multiple operating systems.\n👥 [Open Source](https://github.com/powershell/powershell) and community-focused!"
915+
},
916+
{
917+
"id": "file",
918+
"title": "Create a PowerShell file",
919+
"media": {
920+
"markdown": "media/walkthrough.md"
921+
},
922+
"description": "[Create](command:toSide:workbench.action.files.newUntitledFile?%7B%22languageId%22%3A%22powershell%22%7D) or [open](command:toSide:workbench.action.files.openFolder) a PowerShell file, make sure to save it as ``.ps1``\n[Create a File](command:toSide:workbench.action.files.newUntitledFile?%7B%22languageId%22%3A%22powershell%22%7D)\n**Tip:** Use keyboard shortcut ``Ctrl+N`` to open a new script file or ``Ctrl+O`` to open a file."
923+
},
924+
{
925+
"id": "sessions",
926+
"title": "Switch sessions",
927+
"media": {
928+
"markdown": "media/walkthrough.md"
929+
},
930+
"description": "To switch between PowerShell 7 and Windows PowerShell 5.1, use the menu:\n[Open PowerShell Sessions Menu](command:PowerShell.ShowSessionMenu)\nYou can pin the [PowerShell Language Status Icon](https://github.com/PowerShell/vscode-powershell/blob/main/docs/troubleshooting.md#how-do-i-change-the-powershell-version) to the status bar in the bottom right-hand corner to easily switch sessions.",
931+
"completionEvents": [
932+
"onCommand:PowerShell.ShowSessionConsole"
933+
]
934+
},
935+
{
936+
"id": "ise",
937+
"title": "Try ISE mode",
938+
"media": {
939+
"markdown": "media/walkthrough.md"
940+
},
941+
"description": "If you are familiar with the Windows PowerShell ISE and would like to configure your settings to simulate the ISE Experience, try the ISE Mode.\n[Toggle ISE Mode](command:PowerShell.ToggleISEMode)",
942+
"completionEvents": [
943+
"onCommand:PowerShell.ToggleISEMode"
944+
]
945+
},
946+
{
947+
"id": "terminal",
948+
"title": "Open the PowerShell Extension Terminal",
949+
"media": {
950+
"markdown": "media/walkthrough.md"
951+
},
952+
"description": "The PowerShell Extension Terminal will run whenever the extension starts in order to enable the its features.\n[Show Panel](command:PowerShell.ShowSessionConsole)\nIf you don't want the terminal panel to open on startup, you can keep the panel closed by configuring ``powershell.integratedConsole.showOnStartup`` in your settings.\n[Close Panel](command:PowerShell.ClosePanel)\n**Tip:** Use keyboard shortcut ``Ctrl+``` to open and close terminal."
953+
},
954+
{
955+
"id": "explore",
956+
"title": "Explore more resources",
957+
"media": {
958+
"markdown": "media/walkthrough.md"
959+
},
960+
"description": "Now you are ready to start using the PowerShell Extension on your own and explore more resources!\n📚 See the PowerShell Extension's [documentation](https://docs.microsoft.com/en-us/powershell/scripting/dev-cross-plat/vscode/using-vscode?view=powershell-7.2)\nℹ️ View Visual Studio Code's [documentation](https://code.visualstudio.com/docs/languages/powershell)\n🔌 Plug into the [PowerShell Community](https://docs.microsoft.com/en-us/powershell/scripting/community/community-support?view=powershell-7.2)\n📄 Take a look at our [Release Notes](https://docs.microsoft.com/en-us/powershell/scripting/whats-new/what-s-new-in-powershell-73?view=powershell-7.2)"
961+
},
962+
{
963+
"id": "feedback",
964+
"title": "Share your feedback",
965+
"media": {
966+
"markdown": "media/walkthrough.md"
967+
},
968+
"description": "How has this walkthrough affected your confidence level when using the PowerShell Extension?\n[I feel less confident](command:PowerShell.WalkthroughTelemetry?%7B%22satisfaction%22%3A3%7D)\n[My confidence has not been affected](command:PowerShell.WalkthroughTelemetry?%7B%22satisfaction%22%3A2%7D)\n[I feel more confident](command:PowerShell.WalkthroughTelemetry?%7B%22satisfaction%22%3A1%7D)"
969+
}
970+
]
971+
}
900972
]
901973
},
902974
"private": true

0 commit comments

Comments
 (0)